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

3D widget for performing 3D transformations around an axes More...

#include <vtkAxesTransformWidget.h>

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

Public Member Functions

virtual void SetEnabled (int enabling)
 
void CreateDefaultRepresentation ()
 
virtual void SetProcessEvents (int)
 
void SetRepresentation (vtkAxesTransformRepresentation *r)
 
vtkAxesTransformRepresentationGetLineRepresentation ()
 
- Public Member Functions inherited from vtkAbstractWidget
void Render ()
 
virtual void SetPriority (float)
 
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 vtkAxesTransformWidgetNew ()
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Types

enum  _WidgetState { Start =0, Active }
 

Protected Member Functions

 vtkAxesTransformWidget ()
 
 ~vtkAxesTransformWidget ()
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget ()
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
 
static void EndSelectAction (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 CurrentHandle
 
vtkHandleWidgetOriginWidget
 
vtkHandleWidgetSelectionWidget
 
- 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 vtkAxesTransformWidgetSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkAxesTransformWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

Detailed Description

3D widget for performing 3D transformations around an axes

This 3D widget defines an axes which is used to guide transformation. The widget can translate, scale, and rotate around one of the three coordinate axes. The widget consists of a handle at the origin (used for translation), three axes (around which rotations occur), and three end arrows (or cones depending on the representation) that can be stretched to scale an object. Optionally a text label can be used to indicate the amount of the transformation.

To use this widget, you generally pair it with a vtkAxesTransformRepresentation (or a subclass). Various options are available in the representation for controlling how the widget 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 origin handle is selected:
  LeftButtonPressEvent - activate the associated handle widget
  LeftButtonReleaseEvent - release the handle widget associated with the point
  MouseMoveEvent - move the handle and hence the origin and the widget
If one of the lines is selected:
  LeftButtonPressEvent - activate rotation by selecting one of the three axes.
  LeftButtonReleaseEvent - end rotation
  MouseMoveEvent - moving along the selected axis causes rotation to occur.
If one of the arrows/cones is selected:
  LeftButtonPressEvent - activate scaling by selecting the ends of one of the three axes.
  LeftButtonReleaseEvent - end scaling
  MouseMoveEvent - moving along the selected axis causes scaling to occur.
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkAxesTransformWidget'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
Event Bindings:
In turn, when these widget events are processed, the vtkAxesTransformWidget 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)
Warning
Note that the widget can be picked even when it is "behind" other actors. This is an intended feature and not a bug.
This class, and vtkAxesTransformRepresentation, are next generation VTK widgets.
See Also
vtkAxesTransformRepresentation vtkAffineWidget vtkBoxWidget2
Events:
vtkCommand::LeftButtonReleaseEvent vtkCommand::MouseMoveEvent vtkCommand::EndInteractionEvent vtkCommand::LeftButtonPressEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
Tests:
vtkAxesTransformWidget (Tests)

Definition at line 96 of file vtkAxesTransformWidget.h.

Member Typedef Documentation

Standard vtkObject methods

Definition at line 104 of file vtkAxesTransformWidget.h.

Member Enumeration Documentation

Enumerator
Start 
Active 

Definition at line 138 of file vtkAxesTransformWidget.h.

Constructor & Destructor Documentation

vtkAxesTransformWidget::vtkAxesTransformWidget ( )
protected
vtkAxesTransformWidget::~vtkAxesTransformWidget ( )
protected

Member Function Documentation

static vtkAxesTransformWidget* vtkAxesTransformWidget::New ( )
static

Instantiate the object.

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

Standard vtkObject methods

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

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

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

Standard vtkObject methods

virtual vtkObjectBase* vtkAxesTransformWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

vtkAxesTransformWidget* vtkAxesTransformWidget::NewInstance ( ) const

Standard vtkObject methods

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

Standard vtkObject methods

virtual void vtkAxesTransformWidget::SetEnabled ( int  enabling)
virtual

Override superclasses' SetEnabled() method because the line widget must enable its internal handle widgets.

Reimplemented from vtkAbstractWidget.

void vtkAxesTransformWidget::SetRepresentation ( vtkAxesTransformRepresentation 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 116 of file vtkAxesTransformWidget.h.

vtkAxesTransformRepresentation* vtkAxesTransformWidget::GetLineRepresentation ( )
inline

Return the representation as a vtkAxesTransformRepresentation.

Definition at line 122 of file vtkAxesTransformWidget.h.

void vtkAxesTransformWidget::CreateDefaultRepresentation ( )
virtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

virtual void vtkAxesTransformWidget::SetProcessEvents ( int  )
virtual

Methods to change the whether the widget responds to interaction. Overridden to pass the state to component widgets.

Reimplemented from vtkAbstractWidget.

static void vtkAxesTransformWidget::SelectAction ( vtkAbstractWidget )
staticprotected
static void vtkAxesTransformWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkAxesTransformWidget::MoveAction ( vtkAbstractWidget )
staticprotected

Member Data Documentation

int vtkAxesTransformWidget::WidgetState
protected

Definition at line 137 of file vtkAxesTransformWidget.h.

int vtkAxesTransformWidget::CurrentHandle
protected

Definition at line 139 of file vtkAxesTransformWidget.h.

vtkHandleWidget* vtkAxesTransformWidget::OriginWidget
protected

Definition at line 147 of file vtkAxesTransformWidget.h.

vtkHandleWidget* vtkAxesTransformWidget::SelectionWidget
protected

Definition at line 148 of file vtkAxesTransformWidget.h.


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