|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More...
|
|
vtkSplineWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
void | SetEnabled (int) override |
| Methods that satisfy the superclass' API. More...
|
|
void | PlaceWidget (double bounds[6]) override |
| This method is used to initially place the widget. More...
|
|
void | PlaceWidget () override |
|
void | PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override |
|
virtual void | SetProjectToPlane (vtkTypeBool) |
| Force the spline widget to be projected onto one of the orthogonal planes. More...
|
|
virtual vtkTypeBool | GetProjectToPlane () |
|
virtual void | ProjectToPlaneOn () |
|
virtual void | ProjectToPlaneOff () |
|
void | SetPlaneSource (vtkPlaneSource *plane) |
| Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. More...
|
|
virtual void | SetProjectionNormal (int) |
|
virtual int | GetProjectionNormal () |
|
void | SetProjectionNormalToXAxes () |
|
void | SetProjectionNormalToYAxes () |
|
void | SetProjectionNormalToZAxes () |
|
void | SetProjectionNormalToOblique () |
|
void | SetProjectionPosition (double position) |
| Set the position of spline handles and points in terms of a plane's position. More...
|
|
virtual double | GetProjectionPosition () |
|
void | GetPolyData (vtkPolyData *pd) |
| Grab the polydata (including points) that defines the spline. More...
|
|
virtual void | SetHandleProperty (vtkProperty *) |
| Set/Get the handle properties (the spheres are the handles). More...
|
|
virtual vtkProperty * | GetHandleProperty () |
|
virtual void | SetSelectedHandleProperty (vtkProperty *) |
|
virtual vtkProperty * | GetSelectedHandleProperty () |
|
virtual void | SetLineProperty (vtkProperty *) |
| Set/Get the line properties. More...
|
|
virtual vtkProperty * | GetLineProperty () |
|
virtual void | SetSelectedLineProperty (vtkProperty *) |
|
virtual vtkProperty * | GetSelectedLineProperty () |
|
virtual void | SetNumberOfHandles (int npts) |
| Set/Get the number of handles for this widget. More...
|
|
virtual int | GetNumberOfHandles () |
|
void | SetResolution (int resolution) |
| Set/Get the number of line segments representing the spline for this widget. More...
|
|
virtual int | GetResolution () |
|
virtual void | SetParametricSpline (vtkParametricSpline *) |
| Set the parametric spline object. More...
|
|
virtual vtkParametricSpline * | GetParametricSpline () |
|
void | SetHandlePosition (int handle, double x, double y, double z) |
| Set/Get the position of the spline handles. More...
|
|
void | SetHandlePosition (int handle, double xyz[3]) |
|
void | GetHandlePosition (int handle, double xyz[3]) |
|
double * | GetHandlePosition (int handle) |
|
void | SetClosed (vtkTypeBool closed) |
| Control whether the spline is open or closed. More...
|
|
virtual vtkTypeBool | GetClosed () |
|
virtual void | ClosedOn () |
|
virtual void | ClosedOff () |
|
int | IsClosed () |
| Convenience method to determine whether the spline is closed in a geometric sense. More...
|
|
double | GetSummedLength () |
| Get the approximate vs. More...
|
|
void | InitializeHandles (vtkPoints *points) |
| Convenience method to allocate and set the handles from a vtkPoints instance. More...
|
|
virtual void | SetProcessEvents (vtkTypeBool) |
| Turn on / off event processing for this widget. More...
|
|
virtual vtkTypeBool | GetProcessEvents () |
|
virtual void | ProcessEventsOn () |
|
virtual void | ProcessEventsOff () |
|
vtk3DWidget * | NewInstance () const |
|
virtual void | SetProp3D (vtkProp3D *) |
| Specify a vtkProp3D around which to place the widget. More...
|
|
virtual vtkProp3D * | GetProp3D () |
|
virtual void | SetInputData (vtkDataSet *) |
| Specify the input dataset. More...
|
|
virtual void | SetInputConnection (vtkAlgorithmOutput *) |
|
virtual vtkDataSet * | GetInput () |
|
virtual void | SetPlaceFactor (double) |
| Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
|
|
virtual double | GetPlaceFactor () |
|
virtual void | SetHandleSize (double) |
| Set/Get the factor that controls the size of the handles that appear as part of the widget. More...
|
|
virtual double | GetHandleSize () |
|
vtkInteractorObserver * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
int | GetEnabled () |
|
void | EnabledOn () |
|
void | EnabledOff () |
|
void | On () |
|
void | Off () |
|
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
| This method is used to associate the widget with the render window interactor. More...
|
|
virtual vtkRenderWindowInteractor * | GetInteractor () |
|
virtual void | SetPriority (float) |
| Set/Get the priority at which events are processed. More...
|
|
virtual float | GetPriority () |
|
virtual void | PickingManagedOn () |
| Enable/Disable the use of a manager to process the picking. More...
|
|
virtual void | PickingManagedOff () |
|
virtual void | SetPickingManaged (bool managed) |
|
virtual bool | GetPickingManaged () |
|
virtual void | SetKeyPressActivation (vtkTypeBool) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
|
|
virtual vtkTypeBool | GetKeyPressActivation () |
|
virtual void | KeyPressActivationOn () |
|
virtual void | KeyPressActivationOff () |
|
virtual void | SetKeyPressActivationValue (char) |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
|
|
virtual char | GetKeyPressActivationValue () |
|
virtual vtkRenderer * | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer. More...
|
|
virtual void | SetDefaultRenderer (vtkRenderer *) |
|
virtual vtkRenderer * | GetCurrentRenderer () |
| Set/Get the current renderer. More...
|
|
virtual void | SetCurrentRenderer (vtkRenderer *) |
|
virtual void | OnChar () |
| Sets up the keypress-i event. More...
|
|
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
|
|
void | ReleaseFocus () |
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
| Turn debugging output on. More...
|
|
virtual void | DebugOff () |
| Turn debugging output off. More...
|
|
bool | GetDebug () |
| Get the value of the debug flag. More...
|
|
void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More...
|
|
virtual void | Modified () |
| Update the modification time for this object. More...
|
|
virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More...
|
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
|
vtkCommand * | GetCommand (unsigned long tag) |
|
void | RemoveObserver (vtkCommand *) |
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
|
void | RemoveObservers (const char *event, vtkCommand *) |
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
|
void | RemoveObserver (unsigned long tag) |
|
void | RemoveObservers (unsigned long event) |
|
void | RemoveObservers (const char *event) |
|
void | RemoveAllObservers () |
|
vtkTypeBool | HasObserver (unsigned long event) |
|
vtkTypeBool | HasObserver (const char *event) |
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More...
|
|
int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More...
|
|
int | InvokeEvent (const char *event, void *callData) |
|
int | InvokeEvent (unsigned long event) |
|
int | InvokeEvent (const char *event) |
|
const char * | GetClassName () const |
| Return the class name as a string. More...
|
|
virtual void | Delete () |
| Delete a VTK object. More...
|
|
virtual void | FastDelete () |
| Delete a reference to this object. More...
|
|
void | InitializeObjectBase () |
|
void | Print (ostream &os) |
| Print an object to an ostream. More...
|
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
|
virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More...
|
|
virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More...
|
|
int | GetReferenceCount () |
| Return the current reference count of this object. More...
|
|
void | SetReferenceCount (int) |
| Sets the reference count. More...
|
|
void | PrintRevisions (ostream &) |
| Legacy. More...
|
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkSplineWidget () |
|
| ~vtkSplineWidget () override |
|
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) |
|
void | SizeHandles () override |
|
void | InsertHandleOnLine (double *pos) |
|
void | EraseHandle (const int &) |
|
void | RegisterPickers () override |
| Register internal Pickers in the Picking Manager. More...
|
|
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 () |
|
| vtk3DWidget () |
|
| ~vtk3DWidget () override |
|
void | AdjustBounds (double bounds[6], double newBounds[6], double center[3]) |
|
double | SizeHandles (double factor) |
|
void | UpdateInput () |
|
| vtkInteractorObserver () |
|
| ~vtkInteractorObserver () override |
|
virtual void | StartInteraction () |
| Utility routines used to start and end interaction. More...
|
|
virtual void | EndInteraction () |
|
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
| Helper method for subclasses. More...
|
|
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
|
void | UnRegisterPickers () |
| Unregister internal pickers from the Picking Manager. More...
|
|
vtkPickingManager * | GetPickingManager () |
| Return the picking manager associated on the context on which the observer currently belong. More...
|
|
vtkAssemblyPath * | GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker) |
| Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
|
|
int | RequestCursorShape (int requestedShape) |
|
| vtkObject () |
|
| ~vtkObject () override |
|
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
|
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
|
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More...
|
|
void | InternalReleaseFocus () |
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
virtual void | CollectRevisions (ostream &) |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
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.
- See also
- vtk3DWidget vtkBoxWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget vtkImplicitPlaneWidget vtkPlaneWidget
- Examples:
- vtkSplineWidget (Examples)
- Tests:
- vtkSplineWidget (Tests)
Definition at line 110 of file vtkSplineWidget.h.