VTK
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes
vtkAxesTransformWidget Class Reference

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

#include <vtkAxesTransformWidget.h>

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

List of all members.

Public Member Functions

virtual void SetEnabled (int enabling)
void CreateDefaultRepresentation ()
virtual void SetProcessEvents (int)
void SetRepresentation (vtkAxesTransformRepresentation *r)
vtkAxesTransformRepresentationGetLineRepresentation ()

Static Public Member Functions

static vtkAxesTransformWidgetNew ()

Protected Types

enum  _WidgetState { Start = 0, Active }

Protected Member Functions

 vtkAxesTransformWidget ()
 ~vtkAxesTransformWidget ()

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
static void EndSelectAction (vtkAbstractWidget *)
static void MoveAction (vtkAbstractWidget *)

Protected Attributes

int WidgetState
int CurrentHandle
vtkHandleWidgetOriginWidget
vtkHandleWidgetSelectionWidget
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 vtkObjectBaseNewInstanceInternal () 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::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::MouseMoveEvent vtkCommand::LeftButtonPressEvent vtkCommand::StartInteractionEvent vtkCommand::LeftButtonReleaseEvent
Tests:
vtkAxesTransformWidget (Tests)

Definition at line 96 of file vtkAxesTransformWidget.h.


Member Typedef Documentation

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

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


Member Function Documentation

Instantiate the object.

Reimplemented from vtkObject.

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

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

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

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

virtual vtkObjectBase* vtkAxesTransformWidget::NewInstanceInternal ( ) const [protected, virtual]

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

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

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

virtual void vtkAxesTransformWidget::SetEnabled ( int  enabling) [virtual]

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

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.

Definition at line 116 of file vtkAxesTransformWidget.h.

Return the representation as a vtkAxesTransformRepresentation.

Definition at line 122 of file vtkAxesTransformWidget.h.

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 ) [static, protected]
static void vtkAxesTransformWidget::EndSelectAction ( vtkAbstractWidget ) [static, protected]
static void vtkAxesTransformWidget::MoveAction ( vtkAbstractWidget ) [static, protected]

Member Data Documentation

Definition at line 137 of file vtkAxesTransformWidget.h.

Definition at line 139 of file vtkAxesTransformWidget.h.

Definition at line 147 of file vtkAxesTransformWidget.h.

Definition at line 148 of file vtkAxesTransformWidget.h.


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