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 =========================================================================*/
87 #ifndef vtkSplineWidget_h
88 #define vtkSplineWidget_h
89 
90 #include "vtkInteractionWidgetsModule.h" // For export macro
91 #include "vtk3DWidget.h"
92 
93 class vtkActor;
94 class vtkCellPicker;
97 class vtkPlaneSource;
98 class vtkPoints;
99 class vtkPolyData;
100 class vtkProp;
101 class vtkProperty;
102 class vtkSphereSource;
103 class vtkTransform;
104 
105 #define VTK_PROJECTION_YZ 0
106 #define VTK_PROJECTION_XZ 1
107 #define VTK_PROJECTION_XY 2
108 #define VTK_PROJECTION_OBLIQUE 3
109 
110 class VTKINTERACTIONWIDGETS_EXPORT vtkSplineWidget : public vtk3DWidget
111 {
112 public:
116  static vtkSplineWidget *New();
117 
119  void PrintSelf(ostream& os, vtkIndent indent) override;
120 
122 
125  void SetEnabled(int) override;
126  void PlaceWidget(double bounds[6]) override;
127  void PlaceWidget() override
128  {this->Superclass::PlaceWidget();}
129  void PlaceWidget(double xmin, double xmax, double ymin, double ymax,
130  double zmin, double zmax) override
131  {this->Superclass::PlaceWidget(xmin,xmax,ymin,ymax,zmin,zmax);}
133 
135 
143  vtkSetMacro(ProjectToPlane,vtkTypeBool);
144  vtkGetMacro(ProjectToPlane,vtkTypeBool);
145  vtkBooleanMacro(ProjectToPlane,vtkTypeBool);
147 
153 
154  vtkSetClampMacro(ProjectionNormal,int,VTK_PROJECTION_YZ,VTK_PROJECTION_OBLIQUE);
155  vtkGetMacro(ProjectionNormal,int);
157  { this->SetProjectionNormal(0); }
159  { this->SetProjectionNormal(1); }
161  { this->SetProjectionNormal(2); }
163  { this->SetProjectionNormal(3); }
164 
166 
174  vtkGetMacro(ProjectionPosition, double);
176 
185 
187 
192  vtkGetObjectMacro(HandleProperty, vtkProperty);
194  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
196 
198 
202  virtual void SetLineProperty(vtkProperty*);
203  vtkGetObjectMacro(LineProperty, vtkProperty);
205  vtkGetObjectMacro(SelectedLineProperty, vtkProperty);
207 
209 
212  virtual void SetNumberOfHandles(int npts);
213  vtkGetMacro(NumberOfHandles, int);
215 
217 
222  vtkGetMacro(Resolution,int);
224 
226 
235  vtkGetObjectMacro(ParametricSpline,vtkParametricSpline);
237 
239 
243  void SetHandlePosition(int handle, double x, double y, double z);
244  void SetHandlePosition(int handle, double xyz[3]);
245  void GetHandlePosition(int handle, double xyz[3]);
246  double* GetHandlePosition(int handle) VTK_SIZEHINT(3);
248 
250 
257  void SetClosed(vtkTypeBool closed);
258  vtkGetMacro(Closed,vtkTypeBool);
259  vtkBooleanMacro(Closed,vtkTypeBool);
261 
267  int IsClosed();
268 
274  double GetSummedLength();
275 
283 
285 
289  vtkSetClampMacro(ProcessEvents, vtkTypeBool, 0, 1);
290  vtkGetMacro(ProcessEvents, vtkTypeBool);
291  vtkBooleanMacro( ProcessEvents, vtkTypeBool );
293 
294 protected:
296  ~vtkSplineWidget() override;
297 
298  // Manage the state of the widget
299  int State;
301  {
302  Start=0,
308  Outside
309  };
310 
311  //handles the events
312  static void ProcessEventsHandler(vtkObject* object,
313  unsigned long event,
314  void* clientdata,
315  void* calldata);
316 
317  // ProcessEventsHandler() dispatches to these methods.
324  void OnMouseMove();
325 
326  // Controlling vars
331 
332  // Projection capabilities
336 
337  // The spline
343 
344  // The line segments
346  void HighlightLine(int highlight);
348 
349  // Glyphs representing hot spots (e.g., handles)
352  void Initialize();
353  int HighlightHandle(vtkProp *prop); //returns handle index or -1 on fail
354  void SizeHandles() override;
355  void InsertHandleOnLine(double* pos);
356  void EraseHandle(const int&);
357 
358  // Do the picking
363 
364  // Register internal Pickers within PickingManager
365  void RegisterPickers() override;
366 
367  // Methods to manipulate the spline.
368  void MovePoint(double *p1, double *p2);
369  void Scale(double *p1, double *p2, int X, int Y);
370  void Translate(double *p1, double *p2);
371  void Spin(double *p1, double *p2, double *vpn);
372 
373  // Transform the control points (used for spinning)
375 
376  // Properties used to control the appearance of selected objects and
377  // the manipulator in general.
383 
384  // For efficient spinning
385  double Centroid[3];
388 
389 private:
390  vtkSplineWidget(const vtkSplineWidget&) = delete;
391  void operator=(const vtkSplineWidget&) = delete;
392 };
393 
394 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:40
vtkSplineWidget::Scaling
@ Scaling
Definition: vtkSplineWidget.h:304
vtkSplineWidget::CurrentHandleIndex
int CurrentHandleIndex
Definition: vtkSplineWidget.h:362
vtkSplineWidget::PlaneSource
vtkPlaneSource * PlaneSource
Definition: vtkSplineWidget.h:330
vtkSplineWidget::OnMouseMove
void OnMouseMove()
vtkSplineWidget::Inserting
@ Inserting
Definition: vtkSplineWidget.h:306
vtkSplineWidget::SizeHandles
void SizeHandles() override
vtkSplineWidget::SetHandlePosition
void SetHandlePosition(int handle, double x, double y, double z)
Set/Get the position of the spline handles.
vtkSplineWidget::SetParametricSpline
virtual void SetParametricSpline(vtkParametricSpline *)
Set the parametric spline object.
vtkParametricFunctionSource
tessellate parametric functions
Definition: vtkParametricFunctionSource.h:61
vtkSplineWidget::PlaceWidget
void PlaceWidget() override
Definition: vtkSplineWidget.h:127
vtkX3D::resolution
@ resolution
Definition: vtkX3D.h:466
vtkSplineWidget::HighlightLine
void HighlightLine(int highlight)
vtkSplineWidget::ProjectPointsToOrthoPlane
void ProjectPointsToOrthoPlane()
vtkSplineWidget::Scale
void Scale(double *p1, double *p2, int X, int Y)
vtkSplineWidget::LinePicker
vtkCellPicker * LinePicker
Definition: vtkSplineWidget.h:360
vtkPlaneSource
create an array of quadrilaterals located in a plane
Definition: vtkPlaneSource.h:61
vtkSplineWidget::GetHandlePosition
double * GetHandlePosition(int handle)
vtkSplineWidget::MovePoint
void MovePoint(double *p1, double *p2)
vtkSplineWidget::SetProjectionNormalToYAxes
void SetProjectionNormalToYAxes()
Definition: vtkSplineWidget.h:158
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkSplineWidget::SetSelectedHandleProperty
virtual void SetSelectedHandleProperty(vtkProperty *)
vtkSplineWidget::Translate
void Translate(double *p1, double *p2)
vtkSplineWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSplineWidget::SetSelectedLineProperty
virtual void SetSelectedLineProperty(vtkProperty *)
vtkSplineWidget::ParametricFunctionSource
vtkParametricFunctionSource * ParametricFunctionSource
Definition: vtkSplineWidget.h:339
vtkSplineWidget::Spinning
@ Spinning
Definition: vtkSplineWidget.h:305
vtkSplineWidget::WidgetState
WidgetState
Definition: vtkSplineWidget.h:301
vtkSplineWidget::NumberOfHandles
int NumberOfHandles
Definition: vtkSplineWidget.h:340
vtkSplineWidget::HighlightHandle
int HighlightHandle(vtkProp *prop)
vtkTransform
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:61
vtkSplineWidget::OnMiddleButtonUp
void OnMiddleButtonUp()
vtkSplineWidget::SetPlaneSource
void SetPlaneSource(vtkPlaneSource *plane)
Set up a reference to a vtkPlaneSource that could be from another widget object, e....
vtkSplineWidget::Closed
vtkTypeBool Closed
Definition: vtkSplineWidget.h:341
vtkSplineWidget::CreateDefaultProperties
void CreateDefaultProperties()
vtkParametricSpline
parametric function for 1D interpolating splines
Definition: vtkParametricSpline.h:54
vtkSplineWidget::EraseHandle
void EraseHandle(const int &)
vtkSplineWidget::SelectedHandleProperty
vtkProperty * SelectedHandleProperty
Definition: vtkSplineWidget.h:379
vtkSplineWidget::SetLineProperty
virtual void SetLineProperty(vtkProperty *)
Set/Get the line properties.
vtkSplineWidget::OnRightButtonUp
void OnRightButtonUp()
vtkX3D::position
@ position
Definition: vtkX3D.h:261
vtkX3D::points
@ points
Definition: vtkX3D.h:446
vtkSplineWidget::SetProjectionPosition
void SetProjectionPosition(double position)
Set the position of spline handles and points in terms of a plane's position.
vtkSplineWidget::Initialize
void Initialize()
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkSplineWidget::Handle
vtkActor ** Handle
Definition: vtkSplineWidget.h:350
vtkSplineWidget::BuildRepresentation
void BuildRepresentation()
vtkSplineWidget::OnLeftButtonUp
void OnLeftButtonUp()
vtkSplineWidget::Moving
@ Moving
Definition: vtkSplineWidget.h:303
vtkSplineWidget::LineActor
vtkActor * LineActor
Definition: vtkSplineWidget.h:345
vtkSphereSource
create a polygonal sphere centered at the origin
Definition: vtkSphereSource.h:47
vtkSplineWidget::SetClosed
void SetClosed(vtkTypeBool closed)
Control whether the spline is open or closed.
vtkSplineWidget::PlaceWidget
void PlaceWidget(double bounds[6]) override
This method is used to initially place the widget.
vtkSplineWidget::SelectedLineProperty
vtkProperty * SelectedLineProperty
Definition: vtkSplineWidget.h:381
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
vtkSplineWidget::OnLeftButtonDown
void OnLeftButtonDown()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkSplineWidget::RegisterPickers
void RegisterPickers() override
Register internal Pickers in the Picking Manager.
vtkSplineWidget::Erasing
@ Erasing
Definition: vtkSplineWidget.h:307
vtkSplineWidget::InitializeHandles
void InitializeHandles(vtkPoints *points)
Convenience method to allocate and set the handles from a vtkPoints instance.
vtkSplineWidget::ProcessEvents
vtkTypeBool ProcessEvents
Definition: vtkSplineWidget.h:387
vtkSplineWidget::HandleGeometry
vtkSphereSource ** HandleGeometry
Definition: vtkSplineWidget.h:351
vtkSplineWidget::SetProjectionNormalToXAxes
void SetProjectionNormalToXAxes()
Definition: vtkSplineWidget.h:156
vtkSplineWidget::CurrentHandle
vtkActor * CurrentHandle
Definition: vtkSplineWidget.h:361
vtkSplineWidget::HandleProperty
vtkProperty * HandleProperty
Definition: vtkSplineWidget.h:378
vtkSplineWidget::LineProperty
vtkProperty * LineProperty
Definition: vtkSplineWidget.h:380
vtkSplineWidget::SetNumberOfHandles
virtual void SetNumberOfHandles(int npts)
Set/Get the number of handles for this widget.
vtk3DWidget
an abstract superclass for 3D widgets
Definition: vtk3DWidget.h:68
vtkSplineWidget::SetHandlePosition
void SetHandlePosition(int handle, double xyz[3])
VTK_PROJECTION_OBLIQUE
#define VTK_PROJECTION_OBLIQUE
Definition: vtkSplineWidget.h:108
vtkSplineWidget::HandlePicker
vtkCellPicker * HandlePicker
Definition: vtkSplineWidget.h:359
vtkSplineWidget::New
static vtkSplineWidget * New()
Instantiate the object.
vtkSplineWidget::ParametricSpline
vtkParametricSpline * ParametricSpline
Definition: vtkSplineWidget.h:338
vtkSplineWidget::State
int State
Definition: vtkSplineWidget.h:299
vtkSplineWidget::SetProjectionNormalToZAxes
void SetProjectionNormalToZAxes()
Definition: vtkSplineWidget.h:160
vtkSplineWidget::Spin
void Spin(double *p1, double *p2, double *vpn)
vtkSplineWidget::ProjectToPlane
vtkTypeBool ProjectToPlane
Definition: vtkSplineWidget.h:329
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
vtkSplineWidget
3D widget for manipulating a spline
Definition: vtkSplineWidget.h:111
vtkSplineWidget::Resolution
int Resolution
Definition: vtkSplineWidget.h:347
vtkSplineWidget::GetPolyData
void GetPolyData(vtkPolyData *pd)
Grab the polydata (including points) that defines the spline.
vtkSplineWidget::OnMiddleButtonDown
void OnMiddleButtonDown()
vtkSplineWidget::Transform
vtkTransform * Transform
Definition: vtkSplineWidget.h:374
vtkSplineWidget::ProjectPointsToPlane
void ProjectPointsToPlane()
vtkSplineWidget::OnRightButtonDown
void OnRightButtonDown()
vtkSplineWidget::SetResolution
void SetResolution(int resolution)
Set/Get the number of line segments representing the spline for this widget.
VTK_PROJECTION_YZ
#define VTK_PROJECTION_YZ
Definition: vtkSplineWidget.h:105
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkSplineWidget::SetProjectionNormalToOblique
void SetProjectionNormalToOblique()
Definition: vtkSplineWidget.h:162
vtkSplineWidget::ProjectionPosition
double ProjectionPosition
Definition: vtkSplineWidget.h:328
vtkSplineWidget::vtkSplineWidget
vtkSplineWidget()
vtkSplineWidget::ProjectPointsToObliquePlane
void ProjectPointsToObliquePlane()
vtkSplineWidget::IsClosed
int IsClosed()
Convenience method to determine whether the spline is closed in a geometric sense.
vtkSplineWidget::PlaceWidget
void PlaceWidget(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
Definition: vtkSplineWidget.h:129
vtk3DWidget.h
vtkProperty
represent surface properties of a geometric object
Definition: vtkProperty.h:67
vtkSplineWidget::CalculateCentroid
void CalculateCentroid()
vtkSplineWidget::~vtkSplineWidget
~vtkSplineWidget() override
vtkSplineWidget::ProcessEventsHandler
static void ProcessEventsHandler(vtkObject *object, unsigned long event, void *clientdata, void *calldata)
vtkSplineWidget::GetSummedLength
double GetSummedLength()
Get the approximate vs.
vtkSplineWidget::ProjectionNormal
int ProjectionNormal
Definition: vtkSplineWidget.h:327
vtkSplineWidget::GetHandlePosition
void GetHandlePosition(int handle, double xyz[3])
vtkCellPicker
ray-cast cell picker for all kinds of Prop3Ds
Definition: vtkCellPicker.h:70
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkSplineWidget::InsertHandleOnLine
void InsertHandleOnLine(double *pos)
vtkSplineWidget::SetHandleProperty
virtual void SetHandleProperty(vtkProperty *)
Set/Get the handle properties (the spheres are the handles).
vtkSplineWidget::SetEnabled
void SetEnabled(int) override
Methods that satisfy the superclass' API.