3D widget for manipulating an infinite plane More...
#include <vtkImplicitPlaneWidget2.h>
Detailed Description
3D widget for manipulating an infinite plane
This 3D widget defines an infinite plane that can be interactively placed in a scene. The widget is assumed to consist of four parts: 1) a plane contained in a 2) bounding box, with a 3) plane normal, which is rooted at a 4) point on the plane. (The representation paired with this widget determines the actual geometry of the widget.)
To use this widget, you generally pair it with a vtkImplicitPlaneRepresentation (or a subclass). Variuos options are available for controlling how the representation appears, and how the widget functions.
- Event Bindings:
- By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
If the plane normal is selected: LeftButtonPressEvent - select normal LeftButtonReleaseEvent - release normal MouseMoveEvent - orient the normal vector If the origin point is selected: LeftButtonPressEvent - select slider (if on slider) LeftButtonReleaseEvent - release slider (if selected) MouseMoveEvent - move the origin point (constrained to the plane) If the plane is selected: LeftButtonPressEvent - select slider (if on slider) LeftButtonReleaseEvent - release slider (if selected) MouseMoveEvent - move the plane If the outline is selected: LeftButtonPressEvent - select slider (if on slider) LeftButtonReleaseEvent - release slider (if selected) MouseMoveEvent - move the outline If the keypress characters are used 'Down/Left' Move plane down 'Up/Right' Move plane up In all the cases, independent of what is picked, the widget responds to the following VTK events: MiddleButtonPressEvent - move the plane MiddleButtonReleaseEvent - release the plane RightButtonPressEvent - scale the widget's representation RightButtonReleaseEvent - stop scaling the widget MouseMoveEvent - scale (if right button) or move (if middle button) the widget
- Event Bindings:
- Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkImplicitPlaneWidget2's widget events:
vtkWidgetEvent::Select -- some part of the widget has been selected vtkWidgetEvent::EndSelect -- the selection process has completed vtkWidgetEvent::Move -- a request for slider motion has been invoked vtkWidgetEvent::Up and vtkWidgetEvent::Down -- MovePlaneAction
- Event Bindings:
- In turn, when these widget events are processed, the vtkImplicitPlaneWidget2 invokes the following VTK events on itself (which observers can listen for):
vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select) vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect) vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
- Event Bindings:
- This class, and vtkImplicitPlaneRepresentation, are next generation VTK widgets. An earlier version of this functionality was defined in the class vtkImplicitPlaneWidget.
- See also:
- vtk3DWidget vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget
- Events:
- vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::UpdateEvent
Definition at line 106 of file vtkImplicitPlaneWidget2.h.
Member Typedef Documentation
Standard vtkObject methods
Reimplemented from vtkAbstractWidget.
Definition at line 116 of file vtkImplicitPlaneWidget2.h.
Member Enumeration Documentation
enum vtkImplicitPlaneWidget2::_WidgetState [protected] |
Definition at line 149 of file vtkImplicitPlaneWidget2.h.
Constructor & Destructor Documentation
| vtkImplicitPlaneWidget2::vtkImplicitPlaneWidget2 | ( | ) | [protected] |
| vtkImplicitPlaneWidget2::~vtkImplicitPlaneWidget2 | ( | ) | [protected] |
Member Function Documentation
| static vtkImplicitPlaneWidget2* vtkImplicitPlaneWidget2::New | ( | ) | [static] |
Instantiate the object.
Reimplemented from vtkObject.
| static int vtkImplicitPlaneWidget2::IsTypeOf | ( | const char * | type | ) | [static] |
Standard vtkObject methods
Reimplemented from vtkAbstractWidget.
| virtual int vtkImplicitPlaneWidget2::IsA | ( | const char * | type | ) | [virtual] |
Standard vtkObject methods
Reimplemented from vtkAbstractWidget.
| static vtkImplicitPlaneWidget2* vtkImplicitPlaneWidget2::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Standard vtkObject methods
Reimplemented from vtkAbstractWidget.
| virtual vtkObjectBase* vtkImplicitPlaneWidget2::NewInstanceInternal | ( | ) | const [protected, virtual] |
Standard vtkObject methods
Reimplemented from vtkAbstractWidget.
Standard vtkObject methods
Reimplemented from vtkAbstractWidget.
| void vtkImplicitPlaneWidget2::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Standard vtkObject methods
Reimplemented from vtkAbstractWidget.
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.
| void vtkImplicitPlaneWidget2::SetEnabled | ( | int | ) | [virtual] |
Methods for activating this widget. Note that the widget representation must be specified or the widget will not appear. ProcessEvents (On by default) must be On for Enabled widget to respond to interaction. If ProcessEvents is Off, enabling/disabling a widget merely affects the visibility of the representation.
Reimplemented from vtkAbstractWidget.
| void vtkImplicitPlaneWidget2::SetLockNormalToCamera | ( | int | lock | ) |
Observe/Unobserve the camera if the widget is locked/unlocked to update the vtkImplicitePlaneRepresentation's normal.
| vtkImplicitPlaneRepresentation* vtkImplicitPlaneWidget2::GetImplicitPlaneRepresentation | ( | ) | [inline] |
Return the representation as a vtkImplicitPlaneRepresentation.
Definition at line 136 of file vtkImplicitPlaneWidget2.h.
| void vtkImplicitPlaneWidget2::CreateDefaultRepresentation | ( | ) | [virtual] |
Create the default widget representation if one is not set.
Implements vtkAbstractWidget.
| static void vtkImplicitPlaneWidget2::SelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkImplicitPlaneWidget2::TranslateAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkImplicitPlaneWidget2::ScaleAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkImplicitPlaneWidget2::EndSelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkImplicitPlaneWidget2::MoveAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkImplicitPlaneWidget2::MovePlaneAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| int vtkImplicitPlaneWidget2::UpdateCursorShape | ( | int | interactionState | ) | [protected] |
Update the cursor shape based on the interaction state. Returns 1 if the cursor shape requested is different from the existing one.
| void vtkImplicitPlaneWidget2::InvokeInteractionCallback | ( | ) | [protected] |
Handle the interaction callback that may come from the representation
Friends And Related Function Documentation
friend class vtkInteractionCallback [friend] |
Definition at line 108 of file vtkImplicitPlaneWidget2.h.
Member Data Documentation
int vtkImplicitPlaneWidget2::WidgetState [protected] |
Definition at line 148 of file vtkImplicitPlaneWidget2.h.
Handle the interaction callback that may come from the representation
Definition at line 166 of file vtkImplicitPlaneWidget2.h.
The documentation for this class was generated from the following file:
- dox/Interaction/Widgets/vtkImplicitPlaneWidget2.h
