vtkSplineWidget Class Reference

#include <vtkSplineWidget.h>

Inheritance diagram for vtkSplineWidget:

Inheritance graph
[legend]
Collaboration diagram for vtkSplineWidget:

Collaboration graph
[legend]

List of all members.


Detailed Description

3D widget for manipulating a spline

This 3D widget defines a spline that can be interactively placed in a scene. The spline has handles, the number of which can be changed, plus it can be picked on the spline itself to translate or rotate it in the scene. A nice feature of the object is that the vtkSplineWidget, like any 3D widget, will work with the current interactor style. That is, if vtkSplineWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkSplineWidget will terminate the processing of the event that it handles.

To use this object, just invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor. You may also wish to invoke "PlaceWidget()" to initially position the widget. The interactor will act normally until the "i" key (for "interactor") is pressed, at which point the vtkSplineWidget will appear. (See superclass documentation for information about changing this behavior.) Events that occur outside of the widget (i.e., no part of the widget is picked) are propagated to any other registered obsevers (such as the interaction style). Turn off the widget by pressing the "i" key again (or invoke the Off() method).

The button actions and key modifiers are as follows for controlling the widget: 1) left button down on and drag one of the spherical handles to change the shape of the spline: the handles act as "control points". 2) left button or middle button down on a line segment forming the spline allows uniform translation of the widget. 3) ctrl + middle button down on the widget enables spinning of the widget about its center. 4) right button down on the widget enables scaling of the widget. By moving the mouse "up" the render window the spline will be made bigger; by moving "down" the render window the widget will be made smaller. 5) ctrl key + right button down on any handle will erase it providing there will be two or more points remaining to form a spline. 6) shift key + right button down on any line segment will insert a handle onto the spline at the cursor position.

The vtkSplineWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the spline; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding streamlines or probing other data sets. Typical usage of the widget is to make use of the StartInteractionEvent, InteractionEvent, and EndInteractionEvent events. The InteractionEvent is called on mouse motion; the other two events are called on button down and button up (either left or right button).

Some additional features of this class include the ability to control the properties of the widget. You can set the properties of the selected and unselected representations of the spline. For example, you can set the property for the handles and spline. In addition there are methods to constrain the spline so that it is aligned with a plane. Note that a simple ruler widget can be derived by setting the resolution to 1, the number of handles to 2, and calling the GetSummedLength method!

Thanks:
Thanks to Dean Inglis for developing and contributing this class.
Warning:
Note that handles and line can be picked even when they are "behind" other actors. This is an intended feature and not a bug.
See also:
vtk3DWidget vtkBoxWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget vtkImplicitPlaneWidget vtkPlaneWidget
Events:
vtkCommand::DisableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EnableEvent
Examples:
vtkSplineWidget (Examples)
Tests:
vtkSplineWidget (Tests)

Definition at line 115 of file vtkSplineWidget.h.


Public Types

typedef vtk3DWidget Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetPlaneSource (vtkPlaneSource *plane)
virtual void SetProjectionNormal (int)
virtual int GetProjectionNormal ()
void SetProjectionNormalToXAxes ()
void SetProjectionNormalToYAxes ()
void SetProjectionNormalToZAxes ()
void SetProjectionNormalToOblique ()
void GetPolyData (vtkPolyData *pd)
int IsClosed ()
double GetSummedLength ()
void InitializeHandles (vtkPoints *points)
virtual void SetEnabled (int)
virtual void PlaceWidget (double bounds[6])
void PlaceWidget ()
void PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
virtual void SetProjectToPlane (int)
virtual int GetProjectToPlane ()
virtual void ProjectToPlaneOn ()
virtual void ProjectToPlaneOff ()
void SetProjectionPosition (double position)
virtual double GetProjectionPosition ()
virtual void SetHandleProperty (vtkProperty *)
virtual vtkPropertyGetHandleProperty ()
virtual void SetSelectedHandleProperty (vtkProperty *)
virtual vtkPropertyGetSelectedHandleProperty ()
virtual void SetLineProperty (vtkProperty *)
virtual vtkPropertyGetLineProperty ()
virtual void SetSelectedLineProperty (vtkProperty *)
virtual vtkPropertyGetSelectedLineProperty ()
virtual void SetNumberOfHandles (int npts)
virtual int GetNumberOfHandles ()
void SetResolution (int resolution)
virtual int GetResolution ()
virtual void SetParametricSpline (vtkParametricSpline *)
virtual vtkParametricSplineGetParametricSpline ()
void SetHandlePosition (int handle, double x, double y, double z)
void SetHandlePosition (int handle, double xyz[3])
void GetHandlePosition (int handle, double xyz[3])
double * GetHandlePosition (int handle)
void SetClosed (int closed)
virtual int GetClosed ()
virtual void ClosedOn ()
virtual void ClosedOff ()

Static Public Member Functions

static vtkSplineWidgetNew ()
static int IsTypeOf (const char *type)
static vtkSplineWidgetSafeDownCast (vtkObject *o)

Protected Types

enum  WidgetState {
  Start = 0, Moving, Scaling, Spinning,
  Inserting, Erasing, Outside
}

Protected Member Functions

 vtkSplineWidget ()
 ~vtkSplineWidget ()
void OnLeftButtonDown ()
void OnLeftButtonUp ()
void OnMiddleButtonDown ()
void OnMiddleButtonUp ()
void OnRightButtonDown ()
void OnRightButtonUp ()
void OnMouseMove ()
void ProjectPointsToPlane ()
void ProjectPointsToOrthoPlane ()
void ProjectPointsToObliquePlane ()
void BuildRepresentation ()
void HighlightLine (int highlight)
void Initialize ()
int HighlightHandle (vtkProp *prop)
virtual void SizeHandles ()
void InsertHandleOnLine (double *pos)
void EraseHandle (const int &)
void MovePoint (double *p1, double *p2)
void Scale (double *p1, double *p2, int X, int Y)
void Translate (double *p1, double *p2)
void Spin (double *p1, double *p2, double *vpn)
void CreateDefaultProperties ()
void CalculateCentroid ()

Static Protected Member Functions

static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

Protected Attributes

int State
int ProjectionNormal
double ProjectionPosition
int ProjectToPlane
vtkPlaneSourcePlaneSource
vtkParametricSplineParametricSpline
vtkParametricFunctionSourceParametricFunctionSource
int NumberOfHandles
int Closed
vtkActorLineActor
int Resolution
vtkActor ** Handle
vtkSphereSource ** HandleGeometry
vtkCellPickerHandlePicker
vtkCellPickerLinePicker
vtkActorCurrentHandle
int CurrentHandleIndex
vtkTransformTransform
vtkPropertyHandleProperty
vtkPropertySelectedHandleProperty
vtkPropertyLineProperty
vtkPropertySelectedLineProperty
double Centroid [3]

Member Typedef Documentation

Reimplemented from vtk3DWidget.

Definition at line 121 of file vtkSplineWidget.h.


Member Enumeration Documentation

enum vtkSplineWidget::WidgetState [protected]

Enumerator:
Start 
Moving 
Scaling 
Spinning 
Inserting 
Erasing 
Outside 

Definition at line 265 of file vtkSplineWidget.h.


Constructor & Destructor Documentation

vtkSplineWidget::vtkSplineWidget (  )  [protected]

vtkSplineWidget::~vtkSplineWidget (  )  [protected]


Member Function Documentation

static vtkSplineWidget* vtkSplineWidget::New (  )  [static]

Instantiate the object.

Reimplemented from vtkObject.

virtual const char* vtkSplineWidget::GetClassName (  )  [virtual]

Reimplemented from vtk3DWidget.

static int vtkSplineWidget::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtk3DWidget.

virtual int vtkSplineWidget::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtk3DWidget.

static vtkSplineWidget* vtkSplineWidget::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtk3DWidget.

void vtkSplineWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtk3DWidget.

virtual void vtkSplineWidget::SetEnabled ( int   )  [virtual]

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

virtual void vtkSplineWidget::PlaceWidget ( double  bounds[6]  )  [virtual]

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

void vtkSplineWidget::PlaceWidget (  )  [inline, virtual]

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 128 of file vtkSplineWidget.h.

void vtkSplineWidget::PlaceWidget ( double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
) [inline, virtual]

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 130 of file vtkSplineWidget.h.

virtual void vtkSplineWidget::SetProjectToPlane ( int   )  [virtual]

Force the spline widget to be projected onto one of the orthogonal planes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the spline to the plane if it is orginally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

virtual int vtkSplineWidget::GetProjectToPlane (  )  [virtual]

Force the spline widget to be projected onto one of the orthogonal planes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the spline to the plane if it is orginally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

virtual void vtkSplineWidget::ProjectToPlaneOn (  )  [virtual]

Force the spline widget to be projected onto one of the orthogonal planes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the spline to the plane if it is orginally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

virtual void vtkSplineWidget::ProjectToPlaneOff (  )  [virtual]

Force the spline widget to be projected onto one of the orthogonal planes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the spline to the plane if it is orginally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

void vtkSplineWidget::SetPlaneSource ( vtkPlaneSource plane  ) 

Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.

virtual void vtkSplineWidget::SetProjectionNormal ( int   )  [virtual]

virtual int vtkSplineWidget::GetProjectionNormal (  )  [virtual]

void vtkSplineWidget::SetProjectionNormalToXAxes (  )  [inline]

Definition at line 153 of file vtkSplineWidget.h.

void vtkSplineWidget::SetProjectionNormalToYAxes (  )  [inline]

Definition at line 155 of file vtkSplineWidget.h.

void vtkSplineWidget::SetProjectionNormalToZAxes (  )  [inline]

Definition at line 157 of file vtkSplineWidget.h.

void vtkSplineWidget::SetProjectionNormalToOblique (  )  [inline]

Definition at line 159 of file vtkSplineWidget.h.

void vtkSplineWidget::SetProjectionPosition ( double  position  ) 

Set the position of spline handles and points in terms of a plane's position. i.e., if ProjectionNormal is 0, all of the x-coordinate values of the points are set to position. Any value can be passed (and is ignored) to update the spline points when Projection normal is set to 3 for arbritrary plane orientations.

virtual double vtkSplineWidget::GetProjectionPosition (  )  [virtual]

Set the position of spline handles and points in terms of a plane's position. i.e., if ProjectionNormal is 0, all of the x-coordinate values of the points are set to position. Any value can be passed (and is ignored) to update the spline points when Projection normal is set to 3 for arbritrary plane orientations.

void vtkSplineWidget::GetPolyData ( vtkPolyData pd  ) 

Grab the polydata (including points) that defines the spline. The polydata consists of points and line segments numbering Resolution + 1 and Resoltuion, respectively. Points are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and polyline are added to it.

virtual void vtkSplineWidget::SetHandleProperty ( vtkProperty  )  [virtual]

Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.

virtual vtkProperty* vtkSplineWidget::GetHandleProperty (  )  [virtual]

Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.

virtual void vtkSplineWidget::SetSelectedHandleProperty ( vtkProperty  )  [virtual]

Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.

virtual vtkProperty* vtkSplineWidget::GetSelectedHandleProperty (  )  [virtual]

Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.

virtual void vtkSplineWidget::SetLineProperty ( vtkProperty  )  [virtual]

Set/Get the line properties. The properties of the line when selected and unselected can be manipulated.

virtual vtkProperty* vtkSplineWidget::GetLineProperty (  )  [virtual]

Set/Get the line properties. The properties of the line when selected and unselected can be manipulated.

virtual void vtkSplineWidget::SetSelectedLineProperty ( vtkProperty  )  [virtual]

Set/Get the line properties. The properties of the line when selected and unselected can be manipulated.

virtual vtkProperty* vtkSplineWidget::GetSelectedLineProperty (  )  [virtual]

Set/Get the line properties. The properties of the line when selected and unselected can be manipulated.

virtual void vtkSplineWidget::SetNumberOfHandles ( int  npts  )  [virtual]

Set/Get the number of handles for this widget.

virtual int vtkSplineWidget::GetNumberOfHandles (  )  [virtual]

Set/Get the number of handles for this widget.

void vtkSplineWidget::SetResolution ( int  resolution  ) 

Set/Get the number of line segments representing the spline for this widget.

virtual int vtkSplineWidget::GetResolution (  )  [virtual]

Set/Get the number of line segments representing the spline for this widget.

virtual void vtkSplineWidget::SetParametricSpline ( vtkParametricSpline  )  [virtual]

Set the parametric spline object. Through vtkParametricSpline's API, the user can supply and configure one of currently two types of spline: vtkCardinalSpline, vtkKochanekSpline. The widget controls the open or closed configuration of the spline. WARNING: The widget does not enforce internal consistency so that all three are of the same type.

virtual vtkParametricSpline* vtkSplineWidget::GetParametricSpline (  )  [virtual]

Set the parametric spline object. Through vtkParametricSpline's API, the user can supply and configure one of currently two types of spline: vtkCardinalSpline, vtkKochanekSpline. The widget controls the open or closed configuration of the spline. WARNING: The widget does not enforce internal consistency so that all three are of the same type.

void vtkSplineWidget::SetHandlePosition ( int  handle,
double  x,
double  y,
double  z 
)

Set/Get the position of the spline handles. Call GetNumberOfHandles to determine the valid range of handle indices.

void vtkSplineWidget::SetHandlePosition ( int  handle,
double  xyz[3] 
)

Set/Get the position of the spline handles. Call GetNumberOfHandles to determine the valid range of handle indices.

void vtkSplineWidget::GetHandlePosition ( int  handle,
double  xyz[3] 
)

Set/Get the position of the spline handles. Call GetNumberOfHandles to determine the valid range of handle indices.

double* vtkSplineWidget::GetHandlePosition ( int  handle  ) 

Set/Get the position of the spline handles. Call GetNumberOfHandles to determine the valid range of handle indices.

void vtkSplineWidget::SetClosed ( int  closed  ) 

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.

virtual int vtkSplineWidget::GetClosed (  )  [virtual]

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.

virtual void vtkSplineWidget::ClosedOn (  )  [virtual]

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.

virtual void vtkSplineWidget::ClosedOff (  )  [virtual]

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.

int vtkSplineWidget::IsClosed (  ) 

Convenience method to determine whether the spline is closed in a geometric sense. The widget may be set "closed" but still be geometrically open (e.g., a straight line).

double vtkSplineWidget::GetSummedLength (  ) 

Get the approximate vs. the true arc length of the spline. Calculated as the summed lengths of the individual straight line segments. Use SetResolution to control the accuracy.

void vtkSplineWidget::InitializeHandles ( vtkPoints points  ) 

Convenience method to allocate and set the handles from a vtkPoints instance. If the first and last points are the same, the spline sets Closed to the on state and disregards the last point, otherwise Closed remains unchanged.

static void vtkSplineWidget::ProcessEvents ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
) [static, protected]

Handles the char widget activation event. Also handles the delete event.

Reimplemented from vtkInteractorObserver.

void vtkSplineWidget::OnLeftButtonDown (  )  [protected]

void vtkSplineWidget::OnLeftButtonUp (  )  [protected]

void vtkSplineWidget::OnMiddleButtonDown (  )  [protected]

void vtkSplineWidget::OnMiddleButtonUp (  )  [protected]

void vtkSplineWidget::OnRightButtonDown (  )  [protected]

void vtkSplineWidget::OnRightButtonUp (  )  [protected]

void vtkSplineWidget::OnMouseMove (  )  [protected]

void vtkSplineWidget::ProjectPointsToPlane (  )  [protected]

void vtkSplineWidget::ProjectPointsToOrthoPlane (  )  [protected]

void vtkSplineWidget::ProjectPointsToObliquePlane (  )  [protected]

void vtkSplineWidget::BuildRepresentation (  )  [protected]

void vtkSplineWidget::HighlightLine ( int  highlight  )  [protected]

void vtkSplineWidget::Initialize (  )  [protected]

int vtkSplineWidget::HighlightHandle ( vtkProp prop  )  [protected]

virtual void vtkSplineWidget::SizeHandles (  )  [protected, virtual]

Reimplemented from vtk3DWidget.

void vtkSplineWidget::InsertHandleOnLine ( double *  pos  )  [protected]

void vtkSplineWidget::EraseHandle ( const int &   )  [protected]

void vtkSplineWidget::MovePoint ( double *  p1,
double *  p2 
) [protected]

void vtkSplineWidget::Scale ( double *  p1,
double *  p2,
int  X,
int  Y 
) [protected]

void vtkSplineWidget::Translate ( double *  p1,
double *  p2 
) [protected]

void vtkSplineWidget::Spin ( double *  p1,
double *  p2,
double *  vpn 
) [protected]

void vtkSplineWidget::CreateDefaultProperties (  )  [protected]

void vtkSplineWidget::CalculateCentroid (  )  [protected]


Member Data Documentation

int vtkSplineWidget::State [protected]

Definition at line 264 of file vtkSplineWidget.h.

Definition at line 293 of file vtkSplineWidget.h.

Definition at line 294 of file vtkSplineWidget.h.

Definition at line 295 of file vtkSplineWidget.h.

Definition at line 296 of file vtkSplineWidget.h.

Definition at line 304 of file vtkSplineWidget.h.

Definition at line 305 of file vtkSplineWidget.h.

Definition at line 306 of file vtkSplineWidget.h.

int vtkSplineWidget::Closed [protected]

Definition at line 307 of file vtkSplineWidget.h.

Definition at line 311 of file vtkSplineWidget.h.

int vtkSplineWidget::Resolution [protected]

Definition at line 313 of file vtkSplineWidget.h.

Definition at line 316 of file vtkSplineWidget.h.

Definition at line 317 of file vtkSplineWidget.h.

Definition at line 325 of file vtkSplineWidget.h.

Definition at line 326 of file vtkSplineWidget.h.

Definition at line 327 of file vtkSplineWidget.h.

Definition at line 328 of file vtkSplineWidget.h.

Definition at line 337 of file vtkSplineWidget.h.

Definition at line 341 of file vtkSplineWidget.h.

Definition at line 342 of file vtkSplineWidget.h.

Definition at line 343 of file vtkSplineWidget.h.

Definition at line 344 of file vtkSplineWidget.h.

double vtkSplineWidget::Centroid[3] [protected]

Definition at line 348 of file vtkSplineWidget.h.


The documentation for this class was generated from the following file:

Generated on Sat Dec 27 13:51:05 2008 for VTK by  doxygen 1.5.6