VTK
vtkSplineWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSplineWidget.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 =========================================================================*/
81 #ifndef vtkSplineWidget_h
82 #define vtkSplineWidget_h
83 
84 #include "vtkInteractionWidgetsModule.h" // For export macro
85 #include "vtk3DWidget.h"
86 
87 class vtkActor;
88 class vtkCellPicker;
91 class vtkPlaneSource;
92 class vtkPoints;
93 class vtkPolyData;
94 class vtkProp;
95 class vtkProperty;
96 class vtkSphereSource;
97 class vtkTransform;
98 
99 #define VTK_PROJECTION_YZ 0
100 #define VTK_PROJECTION_XZ 1
101 #define VTK_PROJECTION_XY 2
102 #define VTK_PROJECTION_OBLIQUE 3
103 
104 class VTKINTERACTIONWIDGETS_EXPORT vtkSplineWidget : public vtk3DWidget
105 {
106 public:
110  static vtkSplineWidget *New();
111 
113  void PrintSelf(ostream& os, vtkIndent indent) override;
114 
116 
119  void SetEnabled(int) override;
120  void PlaceWidget(double bounds[6]) override;
121  void PlaceWidget() override
122  {this->Superclass::PlaceWidget();}
123  void PlaceWidget(double xmin, double xmax, double ymin, double ymax,
124  double zmin, double zmax) override
125  {this->Superclass::PlaceWidget(xmin,xmax,ymin,ymax,zmin,zmax);}
127 
129 
137  vtkSetMacro(ProjectToPlane,vtkTypeBool);
138  vtkGetMacro(ProjectToPlane,vtkTypeBool);
139  vtkBooleanMacro(ProjectToPlane,vtkTypeBool);
141 
146  void SetPlaneSource(vtkPlaneSource* plane);
147 
148  vtkSetClampMacro(ProjectionNormal,int,VTK_PROJECTION_YZ,VTK_PROJECTION_OBLIQUE);
149  vtkGetMacro(ProjectionNormal,int);
151  { this->SetProjectionNormal(0); }
153  { this->SetProjectionNormal(1); }
155  { this->SetProjectionNormal(2); }
157  { this->SetProjectionNormal(3); }
158 
160 
167  void SetProjectionPosition(double position);
168  vtkGetMacro(ProjectionPosition, double);
170 
178  void GetPolyData(vtkPolyData *pd);
179 
181 
185  virtual void SetHandleProperty(vtkProperty*);
186  vtkGetObjectMacro(HandleProperty, vtkProperty);
187  virtual void SetSelectedHandleProperty(vtkProperty*);
188  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
190 
192 
196  virtual void SetLineProperty(vtkProperty*);
197  vtkGetObjectMacro(LineProperty, vtkProperty);
198  virtual void SetSelectedLineProperty(vtkProperty*);
199  vtkGetObjectMacro(SelectedLineProperty, vtkProperty);
201 
203 
206  virtual void SetNumberOfHandles(int npts);
207  vtkGetMacro(NumberOfHandles, int);
209 
211 
215  void SetResolution(int resolution);
216  vtkGetMacro(Resolution,int);
218 
220 
228  virtual void SetParametricSpline(vtkParametricSpline*);
229  vtkGetObjectMacro(ParametricSpline,vtkParametricSpline);
231 
233 
237  void SetHandlePosition(int handle, double x, double y, double z);
238  void SetHandlePosition(int handle, double xyz[3]);
239  void GetHandlePosition(int handle, double xyz[3]);
240  double* GetHandlePosition(int handle) VTK_SIZEHINT(3);
242 
244 
251  void SetClosed(vtkTypeBool closed);
252  vtkGetMacro(Closed,vtkTypeBool);
253  vtkBooleanMacro(Closed,vtkTypeBool);
255 
261  int IsClosed();
262 
268  double GetSummedLength();
269 
276  void InitializeHandles(vtkPoints* points);
277 
279 
283  vtkSetClampMacro(ProcessEvents, vtkTypeBool, 0, 1);
284  vtkGetMacro(ProcessEvents, vtkTypeBool);
285  vtkBooleanMacro( ProcessEvents, vtkTypeBool );
287 
288 protected:
289  vtkSplineWidget();
290  ~vtkSplineWidget() override;
291 
292  // Manage the state of the widget
293  int State;
295  {
296  Start=0,
302  Outside
303  };
304 
305  //handles the events
306  static void ProcessEventsHandler(vtkObject* object,
307  unsigned long event,
308  void* clientdata,
309  void* calldata);
310 
311  // ProcessEventsHandler() dispatches to these methods.
312  void OnLeftButtonDown();
313  void OnLeftButtonUp();
314  void OnMiddleButtonDown();
315  void OnMiddleButtonUp();
316  void OnRightButtonDown();
317  void OnRightButtonUp();
318  void OnMouseMove();
319 
320  // Controlling vars
325 
326  // Projection capabilities
327  void ProjectPointsToPlane();
328  void ProjectPointsToOrthoPlane();
329  void ProjectPointsToObliquePlane();
330 
331  // The spline
336  void BuildRepresentation();
337 
338  // The line segments
340  void HighlightLine(int highlight);
342 
343  // Glyphs representing hot spots (e.g., handles)
346  void Initialize();
347  int HighlightHandle(vtkProp *prop); //returns handle index or -1 on fail
348  void SizeHandles() override;
349  void InsertHandleOnLine(double* pos);
350  void EraseHandle(const int&);
351 
352  // Do the picking
357 
358  // Register internal Pickers within PickingManager
359  void RegisterPickers() override;
360 
361  // Methods to manipulate the spline.
362  void MovePoint(double *p1, double *p2);
363  void Scale(double *p1, double *p2, int X, int Y);
364  void Translate(double *p1, double *p2);
365  void Spin(double *p1, double *p2, double *vpn);
366 
367  // Transform the control points (used for spinning)
369 
370  // Properties used to control the appearance of selected objects and
371  // the manipulator in general.
376  void CreateDefaultProperties();
377 
378  // For efficient spinning
379  double Centroid[3];
380  void CalculateCentroid();
382 
383 private:
384  vtkSplineWidget(const vtkSplineWidget&) = delete;
385  void operator=(const vtkSplineWidget&) = delete;
386 };
387 
388 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkSplineWidget::Scaling
Definition: vtkSplineWidget.h:298
vtkSplineWidget::CurrentHandleIndex
int CurrentHandleIndex
Definition: vtkSplineWidget.h:356
vtkSplineWidget::PlaneSource
vtkPlaneSource * PlaneSource
Definition: vtkSplineWidget.h:324
vtkSplineWidget::Inserting
Definition: vtkSplineWidget.h:300
vtkParametricFunctionSource
tessellate parametric functions
Definition: vtkParametricFunctionSource.h:56
vtkSplineWidget::PlaceWidget
void PlaceWidget() override
Definition: vtkSplineWidget.h:121
vtkX3D::resolution
Definition: vtkX3D.h:466
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkSplineWidget::LinePicker
vtkCellPicker * LinePicker
Definition: vtkSplineWidget.h:354
vtkPlaneSource
create an array of quadrilaterals located in a plane
Definition: vtkPlaneSource.h:54
vtkSplineWidget::SetProjectionNormalToYAxes
void SetProjectionNormalToYAxes()
Definition: vtkSplineWidget.h:152
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:53
vtkSplineWidget::ParametricFunctionSource
vtkParametricFunctionSource * ParametricFunctionSource
Definition: vtkSplineWidget.h:333
vtk3DWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSplineWidget::Spinning
Definition: vtkSplineWidget.h:299
vtkSplineWidget::WidgetState
WidgetState
Definition: vtkSplineWidget.h:294
vtkSplineWidget::NumberOfHandles
int NumberOfHandles
Definition: vtkSplineWidget.h:334
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:54
vtkSplineWidget::Closed
vtkTypeBool Closed
Definition: vtkSplineWidget.h:335
vtkParametricSpline
parametric function for 1D interpolating splines
Definition: vtkParametricSpline.h:47
vtkSplineWidget::SelectedHandleProperty
vtkProperty * SelectedHandleProperty
Definition: vtkSplineWidget.h:373
vtkX3D::position
Definition: vtkX3D.h:261
vtkX3D::points
Definition: vtkX3D.h:446
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkSplineWidget::Handle
vtkActor ** Handle
Definition: vtkSplineWidget.h:344
vtkSplineWidget::Moving
Definition: vtkSplineWidget.h:297
vtkSplineWidget::LineActor
vtkActor * LineActor
Definition: vtkSplineWidget.h:339
vtkSphereSource
create a polygonal sphere centered at the origin
Definition: vtkSphereSource.h:40
vtkSplineWidget::SelectedLineProperty
vtkProperty * SelectedLineProperty
Definition: vtkSplineWidget.h:375
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
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkSplineWidget::Erasing
Definition: vtkSplineWidget.h:301
vtkSplineWidget::ProcessEvents
vtkTypeBool ProcessEvents
Definition: vtkSplineWidget.h:381
vtkSplineWidget::HandleGeometry
vtkSphereSource ** HandleGeometry
Definition: vtkSplineWidget.h:345
vtkSplineWidget::SetProjectionNormalToXAxes
void SetProjectionNormalToXAxes()
Definition: vtkSplineWidget.h:150
vtkSplineWidget::CurrentHandle
vtkActor * CurrentHandle
Definition: vtkSplineWidget.h:355
vtkSplineWidget::HandleProperty
vtkProperty * HandleProperty
Definition: vtkSplineWidget.h:372
vtkSplineWidget::LineProperty
vtkProperty * LineProperty
Definition: vtkSplineWidget.h:374
vtk3DWidget
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:67
VTK_PROJECTION_OBLIQUE
#define VTK_PROJECTION_OBLIQUE
Definition: vtkSplineWidget.h:102
vtkSplineWidget::HandlePicker
vtkCellPicker * HandlePicker
Definition: vtkSplineWidget.h:353
vtkSplineWidget::ParametricSpline
vtkParametricSpline * ParametricSpline
Definition: vtkSplineWidget.h:332
vtkSplineWidget::State
int State
Definition: vtkSplineWidget.h:293
vtkSplineWidget::SetProjectionNormalToZAxes
void SetProjectionNormalToZAxes()
Definition: vtkSplineWidget.h:154
vtkInteractorObserver::RegisterPickers
virtual void RegisterPickers()
Register internal Pickers in the Picking Manager.
vtkSplineWidget::ProjectToPlane
vtkTypeBool ProjectToPlane
Definition: vtkSplineWidget.h:323
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:46
vtkSplineWidget
3D widget for manipulating a spline
Definition: vtkSplineWidget.h:104
vtkSplineWidget::Resolution
int Resolution
Definition: vtkSplineWidget.h:341
vtk3DWidget::SizeHandles
virtual void SizeHandles()
Definition: vtk3DWidget.h:152
vtk3DWidget::PlaceWidget
virtual void PlaceWidget()
vtkSplineWidget::Transform
vtkTransform * Transform
Definition: vtkSplineWidget.h:368
VTK_PROJECTION_YZ
#define VTK_PROJECTION_YZ
Definition: vtkSplineWidget.h:99
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:79
vtkSplineWidget::SetProjectionNormalToOblique
void SetProjectionNormalToOblique()
Definition: vtkSplineWidget.h:156
vtkSplineWidget::ProjectionPosition
double ProjectionPosition
Definition: vtkSplineWidget.h:322
vtkSplineWidget::PlaceWidget
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
Definition: vtkSplineWidget.h:123
vtk3DWidget.h
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:60
vtkSplineWidget::ProjectionNormal
int ProjectionNormal
Definition: vtkSplineWidget.h:321
vtkCellPicker
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:63
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69