vtkHandleWidget Class Reference
#include <vtkHandleWidget.h>
Detailed Description
a general widget for moving handlesThe vtkHandleWidget is used to position a handle. A handle is a widget with a position (in display and world space). Various appearances are available depending on its associated representation. The widget provides methods for translation, including constrained translation along coordinate axes. To use this widget, create and associate a representation with the widget.
- Event Bindings:
- By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
LeftButtonPressEvent - select focal point of widget LeftButtonReleaseEvent - end selection MiddleButtonPressEvent - translate widget MiddleButtonReleaseEvent - end translation RightButtonPressEvent - scale widget RightButtonReleaseEvent - end scaling MouseMoveEvent - interactive movement across 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 vtkHandleWidget's widget events:
vtkWidgetEvent::Select -- focal point is being selected vtkWidgetEvent::EndSelect -- the selection process has completed vtkWidgetEvent::Translate -- translate the widget vtkWidgetEvent::EndTranslate -- end widget translation vtkWidgetEvent::Scale -- scale the widget vtkWidgetEvent::EndScale -- end scaling the widget vtkWidgetEvent::Move -- a request for widget motion
- Event Bindings:
- In turn, when these widget events are processed, the vtkHandleWidget 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)
- Events:
- vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
- Tests:
- vtkHandleWidget (Tests)
Definition at line 77 of file vtkHandleWidget.h.
Member Typedef Documentation
Standard VTK class macros.
Reimplemented from vtkAbstractWidget.
Definition at line 85 of file vtkHandleWidget.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
| vtkHandleWidget::vtkHandleWidget | ( | ) | [protected] |
| vtkHandleWidget::~vtkHandleWidget | ( | ) | [protected] |
Member Function Documentation
| static vtkHandleWidget* vtkHandleWidget::New | ( | ) | [static] |
Instantiate this class.
Reimplemented from vtkObject.
| virtual const char* vtkHandleWidget::GetClassName | ( | ) | [virtual] |
Standard VTK class macros.
Reimplemented from vtkAbstractWidget.
| static int vtkHandleWidget::IsTypeOf | ( | const char * | type | ) | [static] |
Standard VTK class macros.
Reimplemented from vtkAbstractWidget.
| virtual int vtkHandleWidget::IsA | ( | const char * | type | ) | [virtual] |
Standard VTK class macros.
Reimplemented from vtkAbstractWidget.
| static vtkHandleWidget* vtkHandleWidget::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Standard VTK class macros.
Reimplemented from vtkAbstractWidget.
| void vtkHandleWidget::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Standard VTK class macros.
Reimplemented from vtkAbstractWidget.
| void vtkHandleWidget::SetRepresentation | ( | vtkHandleRepresentation * | r | ) | [inline] |
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.
Definition at line 93 of file vtkHandleWidget.h.
| void vtkHandleWidget::CreateDefaultRepresentation | ( | ) | [virtual] |
Create the default widget representation if one is not set. By default an instance of vtkPointHandleRepresenation3D is created.
Implements vtkAbstractWidget.
| virtual void vtkHandleWidget::SetEnableAxisConstraint | ( | int | ) | [virtual] |
Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.
| virtual int vtkHandleWidget::GetEnableAxisConstraint | ( | ) | [virtual] |
Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.
| virtual void vtkHandleWidget::EnableAxisConstraintOn | ( | ) | [virtual] |
Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.
| virtual void vtkHandleWidget::EnableAxisConstraintOff | ( | ) | [virtual] |
Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.
| virtual void vtkHandleWidget::SetAllowHandleResize | ( | int | ) | [virtual] |
Allow resizing of handles ? By default the right mouse button scales the handle size.
| virtual int vtkHandleWidget::GetAllowHandleResize | ( | ) | [virtual] |
Allow resizing of handles ? By default the right mouse button scales the handle size.
| virtual void vtkHandleWidget::AllowHandleResizeOn | ( | ) | [virtual] |
Allow resizing of handles ? By default the right mouse button scales the handle size.
| virtual void vtkHandleWidget::AllowHandleResizeOff | ( | ) | [virtual] |
Allow resizing of handles ? By default the right mouse button scales the handle size.
| virtual int vtkHandleWidget::GetWidgetState | ( | ) | [virtual] |
Get the widget state.
| static void vtkHandleWidget::GenericAction | ( | vtkHandleWidget * | ) | [static, protected] |
| static void vtkHandleWidget::SelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkHandleWidget::EndSelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkHandleWidget::TranslateAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkHandleWidget::ScaleAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkHandleWidget::MoveAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| void vtkHandleWidget::SetCursor | ( | int | state | ) | [protected] |
Member Data Documentation
int vtkHandleWidget::WidgetState [protected] |
Definition at line 142 of file vtkHandleWidget.h.
int vtkHandleWidget::EnableAxisConstraint [protected] |
Definition at line 143 of file vtkHandleWidget.h.
int vtkHandleWidget::AllowHandleResize [protected] |
Definition at line 146 of file vtkHandleWidget.h.
The documentation for this class was generated from the following file:
- dox/Widgets/vtkHandleWidget.h
