vtkAffineWidget Class Reference

#include <vtkAffineWidget.h>

Inheritance diagram for vtkAffineWidget:

Inheritance graph
[legend]
Collaboration diagram for vtkAffineWidget:

Collaboration graph
[legend]

List of all members.


Detailed Description

perform affine transformations

The vtkAffineWidget is used to perform affine transformations on objects. (Affine transformations are transformations that keep parallel lines parallel. Affine transformations include translation, scaling, rotation, and shearing.)

To use this widget, set the widget representation. The representation maintains a transformation matrix and other instance variables consistent with the transformations applied by this widget.

Event Bindings:
By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
   LeftButtonPressEvent - select widget: depending on which part is selected
                          translation, rotation, scaling, or shearing may follow.
   LeftButtonReleaseEvent - end selection of widget.
   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 vtkAffineWidget's widget events:
   vtkWidgetEvent::Select -- focal point is being selected
   vtkWidgetEvent::EndSelect -- the selection process has completed
   vtkWidgetEvent::Move -- a request for widget motion
 
Event Bindings:
In turn, when these widget events are processed, the vtkAffineWidget 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
Examples:
vtkAffineWidget (Examples)
Tests:
vtkAffineWidget (Tests)

Definition at line 74 of file vtkAffineWidget.h.

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

Public Member Functions

void CreateDefaultRepresentation ()
virtual void SetEnabled (int)
void SetRepresentation (vtkAffineRepresentation *r)
vtkAffineRepresentationGetAffineRepresentation ()

Static Public Member Functions

static vtkAffineWidgetNew ()

Protected Types

enum  _WidgetState { Start = 0, Active }

Protected Member Functions

 vtkAffineWidget ()
 ~vtkAffineWidget ()
void SetCursor (int state)

Static Protected Member Functions

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

Protected Attributes

int WidgetState
int ModifierActive

Member Typedef Documentation

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

Definition at line 82 of file vtkAffineWidget.h.


Member Enumeration Documentation

Enumerator:
Start 
Active 

Definition at line 123 of file vtkAffineWidget.h.


Constructor & Destructor Documentation

vtkAffineWidget::vtkAffineWidget (  )  [protected]

vtkAffineWidget::~vtkAffineWidget (  )  [protected]


Member Function Documentation

static vtkAffineWidget* vtkAffineWidget::New (  )  [static]

Instantiate this class.

Reimplemented from vtkObject.

virtual const char* vtkAffineWidget::GetClassName (  )  [virtual]

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

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

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

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

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

static vtkAffineWidget* vtkAffineWidget::SafeDownCast ( vtkObject o  )  [static]

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

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

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

void vtkAffineWidget::SetRepresentation ( vtkAffineRepresentation 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 90 of file vtkAffineWidget.h.

vtkAffineRepresentation* vtkAffineWidget::GetAffineRepresentation (  )  [inline]

Return the representation as a vtkAffineRepresentation.

Definition at line 96 of file vtkAffineWidget.h.

void vtkAffineWidget::CreateDefaultRepresentation (  )  [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

virtual void vtkAffineWidget::SetEnabled ( int   )  [virtual]

Methods for activiating this widget. This implementation extends the superclasses' in order to resize the widget handles due to a render start event.

Reimplemented from vtkAbstractWidget.

static void vtkAffineWidget::SelectAction ( vtkAbstractWidget  )  [static, protected]

static void vtkAffineWidget::EndSelectAction ( vtkAbstractWidget  )  [static, protected]

static void vtkAffineWidget::MoveAction ( vtkAbstractWidget  )  [static, protected]

static void vtkAffineWidget::ModifyEventAction ( vtkAbstractWidget  )  [static, protected]

void vtkAffineWidget::SetCursor ( int  state  )  [protected]


Member Data Documentation

Definition at line 122 of file vtkAffineWidget.h.

Definition at line 131 of file vtkAffineWidget.h.


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

Generated on Wed Aug 24 11:28:27 2011 for VTK by  doxygen 1.5.6