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

#include <vtkAxesTransformWidget.h>

Inheritance diagram for vtkAxesTransformWidget:

Collaboration diagram for vtkAxesTransformWidget:

Public Member Functions
virtual void	SetEnabled (int enabling)

void	CreateDefaultRepresentation ()

virtual void	SetProcessEvents (int)


void	SetRepresentation (vtkAxesTransformRepresentation *r)


vtkAxesTransformRepresentation *	GetLineRepresentation ()

Public Member Functions inherited from vtkAbstractWidget
void	Render ()

virtual void	SetPriority (float)

virtual int	GetProcessEvents ()

virtual void	ProcessEventsOn ()

virtual void	ProcessEventsOff ()

vtkWidgetEventTranslator *	GetEventTranslator ()

void	SetParent (vtkAbstractWidget *parent)

virtual vtkAbstractWidget *	GetParent ()

vtkWidgetRepresentation *	GetRepresentation ()

virtual void	SetManagesCursor (int)

virtual int	GetManagesCursor ()

virtual void	ManagesCursorOn ()

virtual void	ManagesCursorOff ()

vtkAbstractWidget *	NewInstance () const

Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	OnChar ()

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)

virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual float	GetPriority ()

virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetKeyPressActivation (int)

virtual int	GetKeyPressActivation ()

virtual void	KeyPressActivationOn ()

virtual void	KeyPressActivationOff ()

virtual void	SetKeyPressActivationValue (char)

virtual char	GetKeyPressActivationValue ()

virtual vtkRenderer *	GetDefaultRenderer ()

virtual void	SetDefaultRenderer (vtkRenderer *)

virtual vtkRenderer *	GetCurrentRenderer ()

virtual void	SetCurrentRenderer (vtkRenderer *)

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	ReleaseFocus ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkAxesTransformWidget *	New ()

Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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))

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver ()

virtual void	RegisterPickers ()

void	UnRegisterPickers ()

virtual void	PickersModified ()

vtkPickingManager *	GetPickingManager ()

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()

virtual void	EndInteraction ()

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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)

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)

Protected Attributes
int	WidgetState

int	CurrentHandle

vtkHandleWidget *	OriginWidget

vtkHandleWidget *	SelectionWidget

Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep

int	ManagesCursor

vtkWidgetEventTranslator *	EventTranslator

vtkWidgetCallbackMapper *	CallbackMapper

vtkAbstractWidget *	Parent

void *	CallData

int	ProcessEvents

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

int	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkAbstractWidget	Superclass

static int	IsTypeOf (const char *type)

static vtkAxesTransformWidget *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkAxesTransformWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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::LeftButtonReleaseEvent vtkCommand::InteractionEvent vtkCommand::MouseMoveEvent vtkCommand::StartInteractionEvent vtkCommand::LeftButtonPressEvent

Tests:: vtkAxesTransformWidget (Tests)

Definition at line 96 of file vtkAxesTransformWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkAxesTransformWidget::Superclass

Standard vtkObject methods

Definition at line 104 of file vtkAxesTransformWidget.h.

Member Enumeration Documentation

enum vtkAxesTransformWidget::_WidgetState

protected

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
	)

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.

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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkAxesTransformWidget.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation