vtkHandleWidget Class Reference

#include <vtkHandleWidget.h>

Inheritance diagram for vtkHandleWidget:

Inheritance graph
[legend]
Collaboration diagram for vtkHandleWidget:

Collaboration graph
[legend]

List of all members.


Detailed Description

a general widget for moving handles

The 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.

typedef vtkAbstractWidget Superclass
static int IsTypeOf (const char *type)
static vtkHandleWidgetSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Types

enum  _WidgetState { Start = 0, Active }

Public Member Functions

void CreateDefaultRepresentation ()
void SetRepresentation (vtkHandleRepresentation *r)
vtkHandleRepresentationGetHandleRepresentation ()
virtual void SetEnableAxisConstraint (int)
virtual int GetEnableAxisConstraint ()
virtual void EnableAxisConstraintOn ()
virtual void EnableAxisConstraintOff ()
virtual void SetAllowHandleResize (int)
virtual int GetAllowHandleResize ()
virtual void AllowHandleResizeOn ()
virtual void AllowHandleResizeOff ()
virtual int GetWidgetState ()

Static Public Member Functions

static vtkHandleWidgetNew ()

Protected Member Functions

 vtkHandleWidget ()
 ~vtkHandleWidget ()
void SetCursor (int state)

Static Protected Member Functions

static void GenericAction (vtkHandleWidget *)
static void SelectAction (vtkAbstractWidget *)
static void EndSelectAction (vtkAbstractWidget *)
static void TranslateAction (vtkAbstractWidget *)
static void ScaleAction (vtkAbstractWidget *)
static void MoveAction (vtkAbstractWidget *)

Protected Attributes

int WidgetState
int EnableAxisConstraint
int AllowHandleResize

Member Typedef Documentation

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

Definition at line 85 of file vtkHandleWidget.h.


Member Enumeration Documentation

Enumerator:
Start 
Active 

Definition at line 130 of file vtkHandleWidget.h.


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.

vtkHandleRepresentation* vtkHandleWidget::GetHandleRepresentation (  )  [inline]

Return the representation as a vtkHandleRepresentation.

Definition at line 99 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

Definition at line 148 of file vtkHandleWidget.h.

Definition at line 149 of file vtkHandleWidget.h.

Definition at line 152 of file vtkHandleWidget.h.


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

Generated on Wed Aug 24 11:39:07 2011 for VTK by  doxygen 1.5.6