|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkPlaneWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
void | GetPolyData (vtkPolyData *pd) |
| Grab the polydata (including points) that defines the plane.
|
|
void | GetPlane (vtkPlane *plane) |
| Get the planes describing the implicit function defined by the plane widget.
|
|
vtkPolyDataAlgorithm * | GetPolyDataAlgorithm () override |
| Satisfies superclass API.
|
|
void | UpdatePlacement (void) override |
| Satisfies superclass API.
|
|
|
void | SetEnabled (int) override |
| Methods that satisfy the superclass' API.
|
|
void | PlaceWidget (double bounds[6]) override |
| Methods that satisfy the superclass' API.
|
|
void | PlaceWidget () override |
| Methods that satisfy the superclass' API.
|
|
void | PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override |
| Methods that satisfy the superclass' API.
|
|
|
void | SetResolution (int r) |
| Set/Get the resolution (number of subdivisions) of the plane.
|
|
int | GetResolution () |
| Set/Get the resolution (number of subdivisions) of the plane.
|
|
|
void | SetOrigin (double x, double y, double z) |
| Set/Get the origin of the plane.
|
|
void | SetOrigin (double x[3]) |
| Set/Get the origin of the plane.
|
|
double * | GetOrigin () |
| Set/Get the origin of the plane.
|
|
void | GetOrigin (double xyz[3]) |
| Set/Get the origin of the plane.
|
|
|
void | SetPoint1 (double x, double y, double z) |
| Set/Get the position of the point defining the first axis of the plane.
|
|
void | SetPoint1 (double x[3]) |
| Set/Get the position of the point defining the first axis of the plane.
|
|
double * | GetPoint1 () |
| Set/Get the position of the point defining the first axis of the plane.
|
|
void | GetPoint1 (double xyz[3]) |
| Set/Get the position of the point defining the first axis of the plane.
|
|
|
void | SetPoint2 (double x, double y, double z) |
| Set/Get the position of the point defining the second axis of the plane.
|
|
void | SetPoint2 (double x[3]) |
| Set/Get the position of the point defining the second axis of the plane.
|
|
double * | GetPoint2 () |
| Set/Get the position of the point defining the second axis of the plane.
|
|
void | GetPoint2 (double xyz[3]) |
| Set/Get the position of the point defining the second axis of the plane.
|
|
|
void | SetCenter (double x, double y, double z) |
| Get the center of the plane.
|
|
void | SetCenter (double x[3]) |
| Get the center of the plane.
|
|
double * | GetCenter () |
| Get the center of the plane.
|
|
void | GetCenter (double xyz[3]) |
| Get the center of the plane.
|
|
|
void | SetNormal (double x, double y, double z) |
| Get the normal to the plane.
|
|
void | SetNormal (double x[3]) |
| Get the normal to the plane.
|
|
double * | GetNormal () |
| Get the normal to the plane.
|
|
void | GetNormal (double xyz[3]) |
| Get the normal to the plane.
|
|
|
virtual void | SetRepresentation (int) |
| Control how the plane appears when GetPolyData() is invoked.
|
|
virtual int | GetRepresentation () |
| Control how the plane appears when GetPolyData() is invoked.
|
|
void | SetRepresentationToOff () |
| Control how the plane appears when GetPolyData() is invoked.
|
|
void | SetRepresentationToOutline () |
| Control how the plane appears when GetPolyData() is invoked.
|
|
void | SetRepresentationToWireframe () |
| Control how the plane appears when GetPolyData() is invoked.
|
|
void | SetRepresentationToSurface () |
| Control how the plane appears when GetPolyData() is invoked.
|
|
|
virtual void | SetNormalToXAxis (vtkTypeBool) |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual vtkTypeBool | GetNormalToXAxis () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual void | NormalToXAxisOn () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual void | NormalToXAxisOff () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual void | SetNormalToYAxis (vtkTypeBool) |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual vtkTypeBool | GetNormalToYAxis () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual void | NormalToYAxisOn () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual void | NormalToYAxisOff () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual void | SetNormalToZAxis (vtkTypeBool) |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual vtkTypeBool | GetNormalToZAxis () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual void | NormalToZAxisOn () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
virtual void | NormalToZAxisOff () |
| Force the plane widget to be aligned with one of the x-y-z axes.
|
|
|
virtual vtkProperty * | GetHandleProperty () |
| Get the handle properties (the little balls are the handles).
|
|
virtual vtkProperty * | GetSelectedHandleProperty () |
| Get the handle properties (the little balls are the handles).
|
|
|
virtual void | SetPlaneProperty (vtkProperty *) |
| Get the plane properties.
|
|
virtual vtkProperty * | GetPlaneProperty () |
| Get the plane properties.
|
|
virtual vtkProperty * | GetSelectedPlaneProperty () |
| Get the plane properties.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkPolyDataSourceWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
void | PlaceWidget () override |
| Overrides vtk3DWidget PlaceWidget() so that it doesn't complain if there's no Input and no Prop3D.
|
|
void | PlaceWidget (double bounds[6]) override=0 |
| We have to redeclare this abstract, PlaceWidget() requires it.
|
|
void | PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override |
| Convenience method brought over from vtkPlaneWidget.
|
|
virtual vtkPolyDataAlgorithm * | GetPolyDataAlgorithm ()=0 |
| Returns underlying vtkPolyDataAlgorithm that determines geometry.
|
|
virtual void | UpdatePlacement ()=0 |
| If you've made changes to the underlying vtkPolyDataSource AFTER your initial call to PlaceWidget(), use this method to realise the changes in the widget.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtk3DWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | SetProp3D (vtkProp3D *) |
| Specify a vtkProp3D around which to place the widget.
|
|
virtual vtkProp3D * | GetProp3D () |
| Specify a vtkProp3D around which to place the widget.
|
|
virtual void | SetInputData (vtkDataSet *) |
| Specify the input dataset.
|
|
virtual void | SetInputConnection (vtkAlgorithmOutput *) |
| Specify the input dataset.
|
|
virtual vtkDataSet * | GetInput () |
| Specify the input dataset.
|
|
virtual void | SetPlaceFactor (double) |
| Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
|
|
virtual double | GetPlaceFactor () |
| Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
|
|
virtual void | SetHandleSize (double) |
| Set/Get the factor that controls the size of the handles that appear as part of the widget.
|
|
virtual double | GetHandleSize () |
| Set/Get the factor that controls the size of the handles that appear as part of the widget.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkInteractorObserver * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | SetEnabled (int) |
| Methods for turning the interactor observer on and off, and determining its state.
|
|
int | GetEnabled () |
|
void | EnabledOn () |
|
void | EnabledOff () |
|
void | On () |
|
void | Off () |
|
virtual void | OnChar () |
| Sets up the keypress-i event.
|
|
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
| This method is used to associate the widget with the render window interactor.
|
|
virtual vtkRenderWindowInteractor * | GetInteractor () |
| This method is used to associate the widget with the render window interactor.
|
|
virtual void | SetPriority (float) |
| Set/Get the priority at which events are processed.
|
|
virtual float | GetPriority () |
| Set/Get the priority at which events are processed.
|
|
virtual void | PickingManagedOn () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | PickingManagedOff () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | SetPickingManaged (bool managed) |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual bool | GetPickingManaged () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | SetKeyPressActivation (vtkTypeBool) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual vtkTypeBool | GetKeyPressActivation () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | KeyPressActivationOn () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | KeyPressActivationOff () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | SetKeyPressActivationValue (char) |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
|
|
virtual char | GetKeyPressActivationValue () |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
|
|
virtual vtkRenderer * | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer.
|
|
virtual void | SetDefaultRenderer (vtkRenderer *) |
| Set/Get the default renderer to use when activating the interactor observer.
|
|
virtual vtkRenderer * | GetCurrentRenderer () |
| Set/Get the current renderer.
|
|
virtual void | SetCurrentRenderer (vtkRenderer *) |
| Set/Get the current renderer.
|
|
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
|
|
void | ReleaseFocus () |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
|
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
| Turn debugging output on.
|
|
virtual void | DebugOff () |
| Turn debugging output off.
|
|
bool | GetDebug () |
| Get the value of the debug flag.
|
|
void | SetDebug (bool debugFlag) |
| Set the value of the debug flag.
|
|
virtual void | Modified () |
| Update the modification time for this object.
|
|
virtual vtkMTimeType | GetMTime () |
| Return this object's modified time.
|
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
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) |
|
int | InvokeEvent (unsigned long event) |
|
int | InvokeEvent (const char *event) |
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
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.
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
|
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.
|
|
int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
const char * | GetClassName () const |
| Return the class name as a string.
|
|
virtual vtkTypeBool | IsA (const char *name) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
|
virtual void | Delete () |
| Delete a VTK object.
|
|
virtual void | FastDelete () |
| Delete a reference to this object.
|
|
void | InitializeObjectBase () |
|
void | Print (ostream &os) |
| Print an object to an ostream.
|
|
virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object).
|
|
virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object).
|
|
int | GetReferenceCount () |
| Return the current reference count of this object.
|
|
void | SetReferenceCount (int) |
| Sets the reference count.
|
|
bool | GetIsInMemkind () const |
| A local state flag that remembers whether this object lives in the normal or extended memory space.
|
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkPlaneWidget () |
|
| ~vtkPlaneWidget () override |
|
void | OnLeftButtonDown () |
|
void | OnLeftButtonUp () |
|
void | OnMiddleButtonDown () |
|
void | OnMiddleButtonUp () |
|
void | OnRightButtonDown () |
|
void | OnRightButtonUp () |
|
void | OnMouseMove () |
|
void | OnStartPinch () |
|
void | OnPinch () |
|
void | OnEndPinch () |
|
void | SelectRepresentation () |
|
void | HighlightPlane (int highlight) |
|
void | PositionHandles () |
|
void | HandlesOn (double length) |
|
void | HandlesOff () |
|
int | HighlightHandle (vtkProp *prop) |
|
void | SizeHandles () override |
|
void | HighlightNormal (int highlight) |
|
void | RegisterPickers () override |
| Register internal Pickers in the Picking Manager.
|
|
void | MoveOrigin (double *p1, double *p2) |
|
void | MovePoint1 (double *p1, double *p2) |
|
void | MovePoint2 (double *p1, double *p2) |
|
void | MovePoint3 (double *p1, double *p2) |
|
void | Rotate (int X, int Y, double *p1, double *p2, double *vpn) |
|
void | Spin (double *p1, double *p2) |
|
void | Scale (double *p1, double *p2, int X, int Y) |
|
void | Translate (double *p1, double *p2) |
|
void | Push (double *p1, double *p2) |
|
void | CreateDefaultProperties () |
|
void | GeneratePlane () |
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkPolyDataSourceWidget () |
| Empty constructor that calls the parent constructor.
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtk3DWidget () |
|
| ~vtk3DWidget () override |
|
void | AdjustBounds (double bounds[6], double newBounds[6], double center[3]) |
|
double | SizeHandles (double factor) |
|
virtual void | SizeHandles () |
|
void | UpdateInput () |
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkInteractorObserver () |
|
| ~vtkInteractorObserver () override |
|
virtual void | RegisterPickers () |
| Register internal Pickers in the Picking Manager.
|
|
void | UnRegisterPickers () |
| Unregister internal pickers from the Picking Manager.
|
|
vtkPickingManager * | GetPickingManager () |
| Return the picking manager associated on the context on which the observer currently belong.
|
|
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.
|
|
int | RequestCursorShape (int requestedShape) |
|
virtual void | StartInteraction () |
| Utility routines used to start and end interaction.
|
|
virtual void | EndInteraction () |
| Utility routines used to start and end interaction.
|
|
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
| Helper method for subclasses.
|
|
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
| Helper method for subclasses.
|
|
| 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.
|
|
void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events.
|
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
|
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
3D widget for manipulating a finite plane
This 3D widget defines a finite (bounded) plane that can be interactively placed in a scene. The plane has four handles (at its corner vertices), a normal vector, and the plane itself. The handles are used to resize the plane; the normal vector to rotate it, and the plane can be picked and translated. Selecting the plane while pressing CTRL makes it spin around the normal. A nice feature of the object is that the vtkPlaneWidget, like any 3D widget, will work with the current interactor style. That is, if vtkPlaneWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkPlaneWidget 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. If the "i" key (for "interactor") is pressed, the vtkPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing the one of the four handles (use the left mouse button), the plane can be resized. By grabbing the plane itself, the entire plane can be arbitrarily translated. Pressing CTRL while grabbing the plane will spin the plane around the normal. If you select the normal vector, the plane can be arbitrarily rotated. Selecting any part of the widget with the middle mouse button enables translation of the plane along its normal. (Once selected using middle mouse, moving the mouse in the direction of the normal translates the plane in the direction of the normal; moving in the direction opposite the normal translates the plane in the direction opposite the normal.) Scaling (about the center of the plane) is achieved by using the right mouse button. By moving the mouse "up" the render window the plane will be made bigger; by moving "down" the render window the widget will be made smaller. 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 vtkPlaneWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the plane; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding stream lines. GetPlane() can be used to update a vtkPlane implicit function. 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 plane. For example, you can set the property for the handles and plane. In addition there are methods to constrain the plane so that it is perpendicular to the x-y-z axes.
- See also
- vtk3DWidget vtkBoxWidget vtkLineWidget vtkSphereWidget vtkImplicitPlaneWidget
- Events:
- vtkCommand::DisableEvent vtkCommand::EnableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
- Online Examples:
- Tests:
- vtkPlaneWidget (Tests)
Definition at line 127 of file vtkPlaneWidget.h.