VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkHandleWidget Class Reference

a general widget for moving handles More...

#include <vtkHandleWidget.h>

Inheritance diagram for vtkHandleWidget:
[legend]
Collaboration diagram for vtkHandleWidget:
[legend]

Public Types

enum  _WidgetState { Start =0, Active }
 
- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 

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 ()
 
- Public Member Functions inherited from vtkAbstractWidget
virtual void SetEnabled (int)
 
void Render ()
 
virtual void SetPriority (float)
 
virtual void SetProcessEvents (int)
 
virtual int GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
vtkWidgetEventTranslatorGetEventTranslator ()
 
void SetParent (vtkAbstractWidget *parent)
 
virtual vtkAbstractWidgetGetParent ()
 
vtkWidgetRepresentationGetRepresentation ()
 
virtual void SetManagesCursor (int)
 
virtual int GetManagesCursor ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
vtkAbstractWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkHandleWidgetNew ()
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

 vtkHandleWidget ()
 
 ~vtkHandleWidget ()
 
void SetCursor (int state)
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget ()
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(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 *)
 
- Static Protected Member Functions inherited from vtkAbstractWidget
static void ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 

Protected Attributes

int WidgetState
 
int EnableAxisConstraint
 
int AllowHandleResize
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 
typedef vtkAbstractWidget Superclass
 
static int IsTypeOf (const char *type)
 
static vtkHandleWidgetSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkHandleWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

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::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EndInteractionEvent
Tests:
vtkHandleWidget (Tests)

Definition at line 78 of file vtkHandleWidget.h.

Member Typedef Documentation

Standard VTK class macros.

Definition at line 86 of file vtkHandleWidget.h.

Member Enumeration Documentation

Enumerator
Start 
Active 

Definition at line 131 of file vtkHandleWidget.h.

Constructor & Destructor Documentation

vtkHandleWidget::vtkHandleWidget ( )
protected
vtkHandleWidget::~vtkHandleWidget ( )
protected

Member Function Documentation

static vtkHandleWidget* vtkHandleWidget::New ( )
static

Instantiate this class.

static int vtkHandleWidget::IsTypeOf ( const char *  type)
static

Standard VTK class macros.

virtual int vtkHandleWidget::IsA ( const char *  type)
virtual

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

static vtkHandleWidget* vtkHandleWidget::SafeDownCast ( vtkObjectBase *  o)
static

Standard VTK class macros.

virtual vtkObjectBase* vtkHandleWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

vtkHandleWidget* vtkHandleWidget::NewInstance ( ) const

Standard VTK class macros.

void vtkHandleWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Standard VTK class macros.

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 94 of file vtkHandleWidget.h.

vtkHandleRepresentation* vtkHandleWidget::GetHandleRepresentation ( )
inline

Return the representation as a vtkHandleRepresentation.

Definition at line 100 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 )
staticprotected
static void vtkHandleWidget::SelectAction ( vtkAbstractWidget )
staticprotected
static void vtkHandleWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkHandleWidget::TranslateAction ( vtkAbstractWidget )
staticprotected
static void vtkHandleWidget::ScaleAction ( vtkAbstractWidget )
staticprotected
static void vtkHandleWidget::MoveAction ( vtkAbstractWidget )
staticprotected
void vtkHandleWidget::SetCursor ( int  state)
protected

Member Data Documentation

int vtkHandleWidget::WidgetState
protected

Definition at line 149 of file vtkHandleWidget.h.

int vtkHandleWidget::EnableAxisConstraint
protected

Definition at line 150 of file vtkHandleWidget.h.

int vtkHandleWidget::AllowHandleResize
protected

Definition at line 153 of file vtkHandleWidget.h.


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