a general widget for moving handles More...

#include <vtkHandleWidget.h>

Inheritance diagram for vtkHandleWidget:

Collaboration diagram for vtkHandleWidget:

Public Types
enum	_WidgetState { Start =0, Active }

Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass
	Standard macros implementing standard VTK methods. More...

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Member Functions
void	SetRepresentation (vtkHandleRepresentation *r)
	Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...

vtkHandleRepresentation *	GetHandleRepresentation ()
	Return the representation as a vtkHandleRepresentation. More...

void	CreateDefaultRepresentation ()
	Create the default widget representation if one is not set. More...


virtual void	SetEnableAxisConstraint (int)
	Enable / disable axis constrained motion of the handles. More...

virtual int	GetEnableAxisConstraint ()
	Enable / disable axis constrained motion of the handles. More...

virtual void	EnableAxisConstraintOn ()
	Enable / disable axis constrained motion of the handles. More...

virtual void	EnableAxisConstraintOff ()
	Enable / disable axis constrained motion of the handles. More...


virtual void	SetAllowHandleResize (int)
	Allow resizing of handles ? By default the right mouse button scales the handle size. More...

virtual int	GetAllowHandleResize ()
	Allow resizing of handles ? By default the right mouse button scales the handle size. More...

virtual void	AllowHandleResizeOn ()
	Allow resizing of handles ? By default the right mouse button scales the handle size. More...

virtual void	AllowHandleResizeOff ()
	Allow resizing of handles ? By default the right mouse button scales the handle size. More...


virtual int	GetWidgetState ()
	Get the widget state. More...

Public Member Functions inherited from vtkAbstractWidget
virtual void	SetEnabled (int)
	Methods for activating this widget. More...

vtkWidgetEventTranslator *	GetEventTranslator ()
	Get the event translator. More...

void	Render ()
	This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...

void	SetParent (vtkAbstractWidget *parent)
	Specifying a parent to this widget is used when creating composite widgets. More...

virtual vtkAbstractWidget *	GetParent ()

virtual void	SetPriority (float)
	Override the superclass method. More...

virtual void	SetProcessEvents (int)
	Methods to change whether the widget responds to interaction. More...

virtual int	GetProcessEvents ()
	Methods to change whether the widget responds to interaction. More...

virtual void	ProcessEventsOn ()
	Methods to change whether the widget responds to interaction. More...

virtual void	ProcessEventsOff ()
	Methods to change whether the widget responds to interaction. More...

vtkWidgetRepresentation *	GetRepresentation ()
	Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...

virtual void	SetManagesCursor (int)
	Turn on or off the management of the cursor. More...

virtual int	GetManagesCursor ()
	Turn on or off the management of the cursor. More...

virtual void	ManagesCursorOn ()
	Turn on or off the management of the cursor. More...

virtual void	ManagesCursorOff ()
	Turn on or off the management of the cursor. More...

vtkAbstractWidget *	NewInstance () const
	Standard macros implementing standard VTK methods. More...

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

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	OnChar ()
	Sets up the keypress-i event. More...

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
	This method is used to associate the widget with the render window interactor. More...

virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor. More...

virtual float	GetPriority ()
	Set/Get the priority at which events are processed. More...

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	SetPickingManaged (bool)
	Enable/Disable the use of a manager to process the picking. More...

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	SetKeyPressActivation (int)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual int	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...

virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer. More...

virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer. More...

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer. More...

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer. More...

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...

void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkHandleWidget *	New ()
	Instantiate this class. More...

Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)
	Standard macros implementing standard VTK methods. More...

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)
	Standard macros implementing standard VTK methods. More...

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])
	Convenience methods for outside classes. More...

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

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

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver ()

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...

virtual void	PickersModified ()
	Update the pickers registered in the Picking Manager when pickers are modified. More...

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong. More...

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
	Utility routines used to start and end interaction. More...

virtual void	EndInteraction ()
	Utility routines used to start and end interaction. More...

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses. More...

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
	Handles the char widget activation event. More...

Protected Attributes
int	WidgetState

int	EnableAxisConstraint

int	AllowHandleResize

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
	Standard VTK class macros. More...

static int	IsTypeOf (const char *type)
	Standard VTK class macros. More...

static vtkHandleWidget *	SafeDownCast (vtkObjectBase *o)
	Standard VTK class macros. More...

virtual int	IsA (const char *type)
	Standard VTK class macros. More...

vtkHandleWidget *	NewInstance () const
	Standard VTK class macros. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Standard VTK class macros. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard VTK class macros. More...

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)

Tests:: vtkHandleWidget (Tests)

Definition at line 76 of file vtkHandleWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkHandleWidget::Superclass

Standard VTK class macros.

Definition at line 88 of file vtkHandleWidget.h.

Member Enumeration Documentation

enum vtkHandleWidget::_WidgetState

Enumerator
Start
Active

Definition at line 141 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
	)

virtual

Standard VTK class macros.

Reimplemented from vtkAbstractWidget.

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

vtkHandleRepresentation* vtkHandleWidget::GetHandleRepresentation ( )

inline

Return the representation as a vtkHandleRepresentation.

Definition at line 103 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 158 of file vtkHandleWidget.h.

int vtkHandleWidget::EnableAxisConstraint

protected

Definition at line 159 of file vtkHandleWidget.h.

int vtkHandleWidget::AllowHandleResize

protected

Definition at line 162 of file vtkHandleWidget.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Interaction/Widgets/vtkHandleWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation