VTK
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 =========================================================================*/
75 #ifndef vtkPlaneWidget_h
76 #define vtkPlaneWidget_h
77 
78 #include "vtkInteractionWidgetsModule.h" // For export macro
80 
81 class vtkActor;
82 class vtkCellPicker;
83 class vtkConeSource;
84 class vtkLineSource;
85 class vtkPlaneSource;
86 class vtkPoints;
87 class vtkPolyData;
88 class vtkPolyDataMapper;
89 class vtkProp;
90 class vtkProperty;
91 class vtkSphereSource;
92 class vtkTransform;
93 class vtkPlane;
94 
95 #define VTK_PLANE_OFF 0
96 #define VTK_PLANE_OUTLINE 1
97 #define VTK_PLANE_WIREFRAME 2
98 #define VTK_PLANE_SURFACE 3
99 
100 class VTKINTERACTIONWIDGETS_EXPORT vtkPlaneWidget : public vtkPolyDataSourceWidget
101 {
102 public:
106  static vtkPlaneWidget *New();
107 
109  void PrintSelf(ostream& os, vtkIndent indent) override;
110 
112 
115  void SetEnabled(int) override;
116  void PlaceWidget(double bounds[6]) override;
117  void PlaceWidget() override
118  {this->Superclass::PlaceWidget();}
119  void PlaceWidget(double xmin, double xmax, double ymin, double ymax,
120  double zmin, double zmax) override
121  {this->Superclass::PlaceWidget(xmin,xmax,ymin,ymax,zmin,zmax);}
123 
125 
128  void SetResolution(int r);
129  int GetResolution();
131 
133 
136  void SetOrigin(double x, double y, double z);
137  void SetOrigin(double x[3]);
138  double* GetOrigin() VTK_SIZEHINT(3);
139  void GetOrigin(double xyz[3]);
141 
143 
146  void SetPoint1(double x, double y, double z);
147  void SetPoint1(double x[3]);
148  double* GetPoint1() VTK_SIZEHINT(3);
149  void GetPoint1(double xyz[3]);
151 
153 
156  void SetPoint2(double x, double y, double z);
157  void SetPoint2(double x[3]);
158  double* GetPoint2() VTK_SIZEHINT(3);
159  void GetPoint2(double xyz[3]);
161 
163 
166  void SetCenter(double x, double y, double z);
167  void SetCenter(double x[3]);
168  double* GetCenter() VTK_SIZEHINT(3);
169  void GetCenter(double xyz[3]);
171 
173 
176  void SetNormal(double x, double y, double z);
177  void SetNormal(double x[3]);
178  double* GetNormal() VTK_SIZEHINT(3);
179  void GetNormal(double xyz[3]);
181 
183 
191  vtkSetClampMacro(Representation,int,VTK_PLANE_OFF,VTK_PLANE_SURFACE);
192  vtkGetMacro(Representation,int);
193  void SetRepresentationToOff()
194  {this->SetRepresentation(VTK_PLANE_OFF);}
196  {this->SetRepresentation(VTK_PLANE_OUTLINE);}
198  {this->SetRepresentation(VTK_PLANE_WIREFRAME);}
200  {this->SetRepresentation(VTK_PLANE_SURFACE);}
202 
204 
210  vtkSetMacro(NormalToXAxis,vtkTypeBool);
211  vtkGetMacro(NormalToXAxis,vtkTypeBool);
212  vtkBooleanMacro(NormalToXAxis,vtkTypeBool);
213  vtkSetMacro(NormalToYAxis,vtkTypeBool);
214  vtkGetMacro(NormalToYAxis,vtkTypeBool);
215  vtkBooleanMacro(NormalToYAxis,vtkTypeBool);
216  vtkSetMacro(NormalToZAxis,vtkTypeBool);
217  vtkGetMacro(NormalToZAxis,vtkTypeBool);
218  vtkBooleanMacro(NormalToZAxis,vtkTypeBool);
220 
229  void GetPolyData(vtkPolyData *pd);
230 
238  void GetPlane(vtkPlane *plane);
239 
247 
252  void UpdatePlacement(void) override;
253 
255 
260  vtkGetObjectMacro(HandleProperty,vtkProperty);
261  vtkGetObjectMacro(SelectedHandleProperty,vtkProperty);
263 
265 
269  virtual void SetPlaneProperty(vtkProperty*);
270  vtkGetObjectMacro(PlaneProperty,vtkProperty);
271  vtkGetObjectMacro(SelectedPlaneProperty,vtkProperty);
273 
274 protected:
275  vtkPlaneWidget();
276  ~vtkPlaneWidget() override;
277 
278  // Manage the state of the widget
279  int State;
281  {
282  Start=0,
289  Pinching
290  };
291 
292  //handles the events
293  static void ProcessEvents(vtkObject* object,
294  unsigned long event,
295  void* clientdata,
296  void* calldata);
297 
298  // ProcessEvents() dispatches to these methods.
299  void OnLeftButtonDown();
300  void OnLeftButtonUp();
301  void OnMiddleButtonDown();
302  void OnMiddleButtonUp();
303  void OnRightButtonDown();
304  void OnRightButtonUp();
305  void OnMouseMove();
306  void OnStartPinch();
307  void OnPinch();
308  void OnEndPinch();
309 
310  // controlling ivars
315  void SelectRepresentation();
316 
317  // the plane
322  void HighlightPlane(int highlight);
323 
324  // glyphs representing hot spots (e.g., handles)
328  void PositionHandles();
329  void HandlesOn(double length);
330  void HandlesOff();
331  int HighlightHandle(vtkProp *prop); //returns cell id
332  void SizeHandles() override;
333 
334  // the normal cone
338  void HighlightNormal(int highlight);
339 
340  // the normal line
344 
345  // the normal cone
349 
350  // the normal line
354 
355  // Do the picking
359 
360  // Register internal Pickers within PickingManager
361  void RegisterPickers() override;
362 
363  // Methods to manipulate the hexahedron.
364  void MoveOrigin(double *p1, double *p2);
365  void MovePoint1(double *p1, double *p2);
366  void MovePoint2(double *p1, double *p2);
367  void MovePoint3(double *p1, double *p2);
368  void Rotate(int X, int Y, double *p1, double *p2, double *vpn);
369  void Spin(double *p1, double *p2);
370  void Scale(double *p1, double *p2, int X, int Y);
371  void Translate(double *p1, double *p2);
372  void Push(double *p1, double *p2);
373 
374  // Plane normal, normalized
375  double Normal[3];
376 
377  // Transform the hexahedral points (used for rotations)
379 
380  // Properties used to control the appearance of selected objects and
381  // the manipulator in general.
386  void CreateDefaultProperties();
387 
388  void GeneratePlane();
389 
392 
393 private:
394  vtkPlaneWidget(const vtkPlaneWidget&) = delete;
395  void operator=(const vtkPlaneWidget&) = delete;
396 };
397 
398 #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
Definition: vtkPlaneWidget.h:284
vtkPlaneWidget::SetRepresentationToSurface
void SetRepresentationToSurface()
Definition: vtkPlaneWidget.h:199
vtkPlaneWidget::LineSource2
vtkLineSource * LineSource2
Definition: vtkPlaneWidget.h:353
vtkPlaneWidget::CurrentHandle
vtkActor * CurrentHandle
Definition: vtkPlaneWidget.h:358
vtkPlaneWidget::ConeActor
vtkActor * ConeActor
Definition: vtkPlaneWidget.h:335
vtkPlaneWidget::Handle
vtkActor ** Handle
Definition: vtkPlaneWidget.h:325
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:280
vtkPlaneSource
create an array of quadrilaterals located in a plane
Definition: vtkPlaneSource.h:54
vtkX3D::Normal
Definition: vtkX3D.h:45
vtkPlaneWidget::LineActor
vtkActor * LineActor
Definition: vtkPlaneWidget.h:341
vtkPlaneWidget::State
int State
Definition: vtkPlaneWidget.h:279
vtkConeSource
generate polygonal cone
Definition: vtkConeSource.h:38
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:53
vtkPlaneWidget::SelectedHandleProperty
vtkProperty * SelectedHandleProperty
Definition: vtkPlaneWidget.h:383
vtkX3D::length
Definition: vtkX3D.h:393
vtkPlaneWidget::ConeSource2
vtkConeSource * ConeSource2
Definition: vtkPlaneWidget.h:348
vtkPlaneWidget::Pushing
Definition: vtkPlaneWidget.h:285
vtkPlaneWidget::ConeSource
vtkConeSource * ConeSource
Definition: vtkPlaneWidget.h:337
vtkPlaneWidget::PlanePicker
vtkCellPicker * PlanePicker
Definition: vtkPlaneWidget.h:357
vtkPlaneWidget::NormalToXAxis
vtkTypeBool NormalToXAxis
Definition: vtkPlaneWidget.h:311
vtkPlaneWidget::PlaneActor
vtkActor * PlaneActor
Definition: vtkPlaneWidget.h:318
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:54
vtkPlaneWidget
3D widget for manipulating a finite plane
Definition: vtkPlaneWidget.h:100
vtkPlaneWidget::NormalToZAxis
vtkTypeBool NormalToZAxis
Definition: vtkPlaneWidget.h:313
vtkPlaneWidget::LineMapper2
vtkPolyDataMapper * LineMapper2
Definition: vtkPlaneWidget.h:352
vtkPlaneWidget::Spinning
Definition: vtkPlaneWidget.h:287
vtkPlaneWidget::HandleProperty
vtkProperty * HandleProperty
Definition: vtkPlaneWidget.h:382
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkPlaneWidget::PlaneProperty
vtkProperty * PlaneProperty
Definition: vtkPlaneWidget.h:384
vtkPlaneWidget::SetRepresentationToOutline
void SetRepresentationToOutline()
Definition: vtkPlaneWidget.h:195
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:342
vtkPlaneWidget::PlaceWidget
void PlaceWidget() override
Definition: vtkPlaneWidget.h:117
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:73
vtkPlaneWidget::ConeActor2
vtkActor * ConeActor2
Definition: vtkPlaneWidget.h:346
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
VTK_PLANE_WIREFRAME
#define VTK_PLANE_WIREFRAME
Definition: vtkPlaneWidget.h:97
vtkPlaneWidget::PlaneOutline
vtkPolyData * PlaneOutline
Definition: vtkPlaneWidget.h:321
vtkPlaneWidget::LineActor2
vtkActor * LineActor2
Definition: vtkPlaneWidget.h:351
vtkPlaneWidget::LineSource
vtkLineSource * LineSource
Definition: vtkPlaneWidget.h:343
vtkPlaneWidget::LastPickValid
int LastPickValid
Definition: vtkPlaneWidget.h:390
vtkLineSource
create a line defined by two end points
Definition: vtkLineSource.h:36
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:385
vtkInteractorObserver::RegisterPickers
virtual void RegisterPickers()
Register internal Pickers in the Picking Manager.
vtkPlaneWidget::Representation
int Representation
Definition: vtkPlaneWidget.h:314
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:46
VTK_PLANE_SURFACE
#define VTK_PLANE_SURFACE
Definition: vtkPlaneWidget.h:98
vtk3DWidget::SizeHandles
virtual void SizeHandles()
Definition: vtk3DWidget.h:152
vtkPlaneWidget::PlaceWidget
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
Definition: vtkPlaneWidget.h:119
vtk3DWidget::PlaceWidget
virtual void PlaceWidget()
VTK_PLANE_OFF
#define VTK_PLANE_OFF
Definition: vtkPlaneWidget.h:95
vtkPlaneWidget::ConeMapper
vtkPolyDataMapper * ConeMapper
Definition: vtkPlaneWidget.h:336
vtkPolyDataSourceWidget
abstract PolyDataSource-based 3D widget
Definition: vtkPolyDataSourceWidget.h:45
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:79
vtkPlaneWidget::HandleGeometry
vtkSphereSource ** HandleGeometry
Definition: vtkPlaneWidget.h:327
vtkPlaneWidget::ConeMapper2
vtkPolyDataMapper * ConeMapper2
Definition: vtkPlaneWidget.h:347
vtkPlaneWidget::HandlePicker
vtkCellPicker * HandlePicker
Definition: vtkPlaneWidget.h:356
vtkPlaneWidget::PlaneMapper
vtkPolyDataMapper * PlaneMapper
Definition: vtkPlaneWidget.h:319
vtkPlaneWidget::SetRepresentationToWireframe
void SetRepresentationToWireframe()
Definition: vtkPlaneWidget.h:197
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:60
vtkPlaneWidget::Moving
Definition: vtkPlaneWidget.h:283
vtkCellPicker
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:63
vtkPlaneWidget::HandleMapper
vtkPolyDataMapper ** HandleMapper
Definition: vtkPlaneWidget.h:326
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkPlaneWidget::Transform
vtkTransform * Transform
Definition: vtkPlaneWidget.h:378
vtkPlaneWidget::PlaneSource
vtkPlaneSource * PlaneSource
Definition: vtkPlaneWidget.h:320
vtkPlaneWidget::Outside
Definition: vtkPlaneWidget.h:288
vtkPlaneWidget::Rotating
Definition: vtkPlaneWidget.h:286
vtkPlaneWidget::HandleSizeFactor
double HandleSizeFactor
Definition: vtkPlaneWidget.h:391
vtkPolyDataSourceWidget.h
VTK_PLANE_OUTLINE
#define VTK_PLANE_OUTLINE
Definition: vtkPlaneWidget.h:96
vtkPlaneWidget::NormalToYAxis
vtkTypeBool NormalToYAxis
Definition: vtkPlaneWidget.h:312
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:41