VTK  9.0.1
vtkPlaneWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPlaneWidget.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
84 #ifndef vtkPlaneWidget_h
85 #define vtkPlaneWidget_h
86 
87 #include "vtkInteractionWidgetsModule.h" // For export macro
89 
90 class vtkActor;
91 class vtkCellPicker;
92 class vtkConeSource;
93 class vtkLineSource;
94 class vtkPlaneSource;
95 class vtkPoints;
96 class vtkPolyData;
97 class vtkPolyDataMapper;
98 class vtkProp;
99 class vtkProperty;
100 class vtkSphereSource;
101 class vtkTransform;
102 class vtkPlane;
103 
104 #define VTK_PLANE_OFF 0
105 #define VTK_PLANE_OUTLINE 1
106 #define VTK_PLANE_WIREFRAME 2
107 #define VTK_PLANE_SURFACE 3
108 
109 class VTKINTERACTIONWIDGETS_EXPORT vtkPlaneWidget : public vtkPolyDataSourceWidget
110 {
111 public:
115  static vtkPlaneWidget* New();
116 
118  void PrintSelf(ostream& os, vtkIndent indent) override;
119 
121 
124  void SetEnabled(int) override;
125  void PlaceWidget(double bounds[6]) override;
126  void PlaceWidget() override { this->Superclass::PlaceWidget(); }
128  double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
129  {
130  this->Superclass::PlaceWidget(xmin, xmax, ymin, ymax, zmin, zmax);
131  }
133 
135 
138  void SetResolution(int r);
139  int GetResolution();
141 
143 
146  void SetOrigin(double x, double y, double z);
147  void SetOrigin(double x[3]);
148  double* GetOrigin() VTK_SIZEHINT(3);
149  void GetOrigin(double xyz[3]);
151 
153 
156  void SetPoint1(double x, double y, double z);
157  void SetPoint1(double x[3]);
158  double* GetPoint1() VTK_SIZEHINT(3);
159  void GetPoint1(double xyz[3]);
161 
163 
166  void SetPoint2(double x, double y, double z);
167  void SetPoint2(double x[3]);
168  double* GetPoint2() VTK_SIZEHINT(3);
169  void GetPoint2(double xyz[3]);
171 
173 
176  void SetCenter(double x, double y, double z);
177  void SetCenter(double x[3]);
178  double* GetCenter() VTK_SIZEHINT(3);
179  void GetCenter(double xyz[3]);
181 
183 
186  void SetNormal(double x, double y, double z);
187  void SetNormal(double x[3]);
188  double* GetNormal() VTK_SIZEHINT(3);
189  void GetNormal(double xyz[3]);
191 
193 
201  vtkSetClampMacro(Representation, int, VTK_PLANE_OFF, VTK_PLANE_SURFACE);
202  vtkGetMacro(Representation, int);
203  void SetRepresentationToOff() { this->SetRepresentation(VTK_PLANE_OFF); }
204  void SetRepresentationToOutline() { this->SetRepresentation(VTK_PLANE_OUTLINE); }
205  void SetRepresentationToWireframe() { this->SetRepresentation(VTK_PLANE_WIREFRAME); }
206  void SetRepresentationToSurface() { this->SetRepresentation(VTK_PLANE_SURFACE); }
208 
210 
216  vtkSetMacro(NormalToXAxis, vtkTypeBool);
217  vtkGetMacro(NormalToXAxis, vtkTypeBool);
218  vtkBooleanMacro(NormalToXAxis, vtkTypeBool);
219  vtkSetMacro(NormalToYAxis, vtkTypeBool);
220  vtkGetMacro(NormalToYAxis, vtkTypeBool);
221  vtkBooleanMacro(NormalToYAxis, vtkTypeBool);
222  vtkSetMacro(NormalToZAxis, vtkTypeBool);
223  vtkGetMacro(NormalToZAxis, vtkTypeBool);
224  vtkBooleanMacro(NormalToZAxis, vtkTypeBool);
226 
235  void GetPolyData(vtkPolyData* pd);
236 
244  void GetPlane(vtkPlane* plane);
245 
253 
258  void UpdatePlacement(void) override;
259 
261 
266  vtkGetObjectMacro(HandleProperty, vtkProperty);
267  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
269 
271 
275  virtual void SetPlaneProperty(vtkProperty*);
276  vtkGetObjectMacro(PlaneProperty, vtkProperty);
277  vtkGetObjectMacro(SelectedPlaneProperty, vtkProperty);
279 
280 protected:
281  vtkPlaneWidget();
282  ~vtkPlaneWidget() override;
283 
284  // Manage the state of the widget
285  int State;
287  {
288  Start = 0,
295  Pinching
296  };
297 
298  // handles the events
299  static void ProcessEvents(
300  vtkObject* object, unsigned long event, void* clientdata, void* calldata);
301 
302  // ProcessEvents() dispatches to these methods.
303  void OnLeftButtonDown();
304  void OnLeftButtonUp();
305  void OnMiddleButtonDown();
306  void OnMiddleButtonUp();
307  void OnRightButtonDown();
308  void OnRightButtonUp();
309  void OnMouseMove();
310  void OnStartPinch();
311  void OnPinch();
312  void OnEndPinch();
313 
314  // controlling ivars
319  void SelectRepresentation();
320 
321  // the plane
326  void HighlightPlane(int highlight);
327 
328  // glyphs representing hot spots (e.g., handles)
332  void PositionHandles();
333  void HandlesOn(double length);
334  void HandlesOff();
335  int HighlightHandle(vtkProp* prop); // returns cell id
336  void SizeHandles() override;
337 
338  // the normal cone
342  void HighlightNormal(int highlight);
343 
344  // the normal line
348 
349  // the normal cone
353 
354  // the normal line
358 
359  // Do the picking
363 
364  // Register internal Pickers within PickingManager
365  void RegisterPickers() override;
366 
367  // Methods to manipulate the hexahedron.
368  void MoveOrigin(double* p1, double* p2);
369  void MovePoint1(double* p1, double* p2);
370  void MovePoint2(double* p1, double* p2);
371  void MovePoint3(double* p1, double* p2);
372  void Rotate(int X, int Y, double* p1, double* p2, double* vpn);
373  void Spin(double* p1, double* p2);
374  void Scale(double* p1, double* p2, int X, int Y);
375  void Translate(double* p1, double* p2);
376  void Push(double* p1, double* p2);
377 
378  // Plane normal, normalized
379  double Normal[3];
380 
381  // Transform the hexahedral points (used for rotations)
383 
384  // Properties used to control the appearance of selected objects and
385  // the manipulator in general.
390  void CreateDefaultProperties();
391 
392  void GeneratePlane();
393 
396 
397 private:
398  vtkPlaneWidget(const vtkPlaneWidget&) = delete;
399  void operator=(const vtkPlaneWidget&) = delete;
400 };
401 
402 #endif
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:36
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkPlane
perform various plane computations
Definition: vtkPlane.h:31
vtkPlaneWidget::Scaling
@ Scaling
Definition: vtkPlaneWidget.h:290
vtkPlaneWidget::SetRepresentationToSurface
void SetRepresentationToSurface()
Definition: vtkPlaneWidget.h:206
vtkPlaneWidget::LineSource2
vtkLineSource * LineSource2
Definition: vtkPlaneWidget.h:357
vtkPlaneWidget::CurrentHandle
vtkActor * CurrentHandle
Definition: vtkPlaneWidget.h:362
vtkPlaneWidget::ConeActor
vtkActor * ConeActor
Definition: vtkPlaneWidget.h:339
vtkPlaneWidget::Handle
vtkActor ** Handle
Definition: vtkPlaneWidget.h:329
vtkPolyDataSourceWidget::PlaceWidget
void PlaceWidget() override
Overrides vtk3DWidget PlaceWidget() so that it doesn't complain if there's no Input and no Prop3D.
vtkPolyDataSourceWidget::GetPolyDataAlgorithm
virtual vtkPolyDataAlgorithm * GetPolyDataAlgorithm()=0
Returns underlying vtkPolyDataAlgorithm that determines geometry.
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkPlaneWidget::WidgetState
WidgetState
Definition: vtkPlaneWidget.h:286
vtkPlaneSource
create an array of quadrilaterals located in a plane
Definition: vtkPlaneSource.h:54
vtkX3D::Normal
@ Normal
Definition: vtkX3D.h:51
vtkPlaneWidget::LineActor
vtkActor * LineActor
Definition: vtkPlaneWidget.h:345
vtkPlaneWidget::State
int State
Definition: vtkPlaneWidget.h:285
vtkConeSource
generate polygonal cone
Definition: vtkConeSource.h:38
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkPlaneWidget::SelectedHandleProperty
vtkProperty * SelectedHandleProperty
Definition: vtkPlaneWidget.h:387
vtkX3D::length
@ length
Definition: vtkX3D.h:399
vtkPlaneWidget::ConeSource2
vtkConeSource * ConeSource2
Definition: vtkPlaneWidget.h:352
vtkPlaneWidget::Pushing
@ Pushing
Definition: vtkPlaneWidget.h:291
vtkPlaneWidget::ConeSource
vtkConeSource * ConeSource
Definition: vtkPlaneWidget.h:341
vtkPlaneWidget::PlanePicker
vtkCellPicker * PlanePicker
Definition: vtkPlaneWidget.h:361
vtkPlaneWidget::NormalToXAxis
vtkTypeBool NormalToXAxis
Definition: vtkPlaneWidget.h:315
vtkPlaneWidget::PlaneActor
vtkActor * PlaneActor
Definition: vtkPlaneWidget.h:322
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:54
vtkPlaneWidget
3D widget for manipulating a finite plane
Definition: vtkPlaneWidget.h:109
vtkPlaneWidget::NormalToZAxis
vtkTypeBool NormalToZAxis
Definition: vtkPlaneWidget.h:317
vtkPlaneWidget::LineMapper2
vtkPolyDataMapper * LineMapper2
Definition: vtkPlaneWidget.h:356
vtkPlaneWidget::Spinning
@ Spinning
Definition: vtkPlaneWidget.h:293
vtkPlaneWidget::HandleProperty
vtkProperty * HandleProperty
Definition: vtkPlaneWidget.h:386
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:45
vtkPlaneWidget::PlaneProperty
vtkProperty * PlaneProperty
Definition: vtkPlaneWidget.h:388
vtkPlaneWidget::SetRepresentationToOutline
void SetRepresentationToOutline()
Definition: vtkPlaneWidget.h:204
vtkPolyDataSourceWidget::UpdatePlacement
virtual void UpdatePlacement()=0
If you've made changes to the underlying vtkPolyDataSource AFTER your initial call to PlaceWidget(),...
vtkSphereSource
create a polygonal sphere centered at the origin
Definition: vtkSphereSource.h:40
vtkInteractorObserver::ProcessEvents
static void ProcessEvents(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Handles the char widget activation event.
vtkPlaneWidget::LineMapper
vtkPolyDataMapper * LineMapper
Definition: vtkPlaneWidget.h:346
vtkPlaneWidget::PlaceWidget
void PlaceWidget() override
Definition: vtkPlaneWidget.h:126
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:45
vtkInteractorObserver::SetEnabled
virtual void SetEnabled(int)
Methods for turning the interactor observer on and off, and determining its state.
Definition: vtkInteractorObserver.h:79
vtkPlaneWidget::ConeActor2
vtkActor * ConeActor2
Definition: vtkPlaneWidget.h:350
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
VTK_PLANE_WIREFRAME
#define VTK_PLANE_WIREFRAME
Definition: vtkPlaneWidget.h:106
vtkPlaneWidget::PlaneOutline
vtkPolyData * PlaneOutline
Definition: vtkPlaneWidget.h:325
vtkPlaneWidget::LineActor2
vtkActor * LineActor2
Definition: vtkPlaneWidget.h:355
vtkPlaneWidget::LineSource
vtkLineSource * LineSource
Definition: vtkPlaneWidget.h:347
vtkPlaneWidget::LastPickValid
int LastPickValid
Definition: vtkPlaneWidget.h:394
vtkLineSource
create a line defined by two end points
Definition: vtkLineSource.h:60
vtkPolyDataSourceWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPlaneWidget::SelectedPlaneProperty
vtkProperty * SelectedPlaneProperty
Definition: vtkPlaneWidget.h:389
vtkInteractorObserver::RegisterPickers
virtual void RegisterPickers()
Register internal Pickers in the Picking Manager.
vtkPlaneWidget::Representation
int Representation
Definition: vtkPlaneWidget.h:318
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
VTK_PLANE_SURFACE
#define VTK_PLANE_SURFACE
Definition: vtkPlaneWidget.h:107
vtk3DWidget::SizeHandles
virtual void SizeHandles()
Definition: vtk3DWidget.h:155
vtkPlaneWidget::PlaceWidget
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
Definition: vtkPlaneWidget.h:127
vtk3DWidget::PlaceWidget
virtual void PlaceWidget()
VTK_PLANE_OFF
#define VTK_PLANE_OFF
Definition: vtkPlaneWidget.h:104
vtkPlaneWidget::ConeMapper
vtkPolyDataMapper * ConeMapper
Definition: vtkPlaneWidget.h:340
vtkPolyDataSourceWidget
abstract PolyDataSource-based 3D widget
Definition: vtkPolyDataSourceWidget.h:45
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
vtkPlaneWidget::HandleGeometry
vtkSphereSource ** HandleGeometry
Definition: vtkPlaneWidget.h:331
vtkPlaneWidget::ConeMapper2
vtkPolyDataMapper * ConeMapper2
Definition: vtkPlaneWidget.h:351
vtkPlaneWidget::HandlePicker
vtkCellPicker * HandlePicker
Definition: vtkPlaneWidget.h:360
vtkPlaneWidget::PlaneMapper
vtkPolyDataMapper * PlaneMapper
Definition: vtkPlaneWidget.h:323
vtkPlaneWidget::SetRepresentationToWireframe
void SetRepresentationToWireframe()
Definition: vtkPlaneWidget.h:205
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:61
vtkPlaneWidget::Moving
@ Moving
Definition: vtkPlaneWidget.h:289
vtkCellPicker
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:66
vtkPlaneWidget::HandleMapper
vtkPolyDataMapper ** HandleMapper
Definition: vtkPlaneWidget.h:330
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkPlaneWidget::Transform
vtkTransform * Transform
Definition: vtkPlaneWidget.h:382
vtkPlaneWidget::PlaneSource
vtkPlaneSource * PlaneSource
Definition: vtkPlaneWidget.h:324
vtkPlaneWidget::Outside
@ Outside
Definition: vtkPlaneWidget.h:294
vtkPlaneWidget::Rotating
@ Rotating
Definition: vtkPlaneWidget.h:292
vtkPlaneWidget::HandleSizeFactor
double HandleSizeFactor
Definition: vtkPlaneWidget.h:395
vtkPolyDataSourceWidget.h
VTK_PLANE_OUTLINE
#define VTK_PLANE_OUTLINE
Definition: vtkPlaneWidget.h:105
vtkPlaneWidget::NormalToYAxis
vtkTypeBool NormalToYAxis
Definition: vtkPlaneWidget.h:316
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:41