vtkBoxWidget2 Class Reference

3D widget for manipulating a box More...

#include <vtkBoxWidget2.h>

Inheritance diagram for vtkBoxWidget2:

Collaboration diagram for vtkBoxWidget2:

Public Member Functions
void	CreateDefaultRepresentation ()
void	SetRepresentation (vtkBoxRepresentation *r)
virtual void	SetTranslationEnabled (int)
virtual int	GetTranslationEnabled ()
virtual void	TranslationEnabledOn ()
virtual void	TranslationEnabledOff ()
virtual void	SetScalingEnabled (int)
virtual int	GetScalingEnabled ()
virtual void	ScalingEnabledOn ()
virtual void	ScalingEnabledOff ()
virtual void	SetRotationEnabled (int)
virtual int	GetRotationEnabled ()
virtual void	RotationEnabledOn ()
virtual void	RotationEnabledOff ()
virtual void	SetMoveFacesEnabled (int)
virtual int	GetMoveFacesEnabled ()
virtual void	MoveFacesEnabledOn ()
virtual void	MoveFacesEnabledOff ()
Public Member Functions inherited from vtkAbstractWidget
virtual void	SetEnabled (int)
void	Render ()
virtual void	SetPriority (float)
virtual void	SetProcessEvents (int)
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 vtkBoxWidget2 *	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
	vtkBoxWidget2 ()
	~vtkBoxWidget2 ()
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	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)

Protected Attributes
int	WidgetState
int	TranslationEnabled
int	ScalingEnabled
int	RotationEnabled
int	MoveFacesEnabled
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 vtkBoxWidget2 *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkBoxWidget2 *	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 manipulating a box

This 3D widget interacts with a vtkBoxRepresentation class (i.e., it handles the events that drive its corresponding representation). The representation is assumed to represent a region of interest that is represented by an arbitrarily oriented hexahedron (or box) with interior face angles of 90 degrees (i.e., orthogonal faces). The representation manifests seven handles that can be moused on and manipulated, plus the six faces can also be interacted with. The first six handles are placed on the six faces, the seventh is in the center of the box. In addition, a bounding box outline is shown, the "faces" of which can be selected for object rotation or scaling. A nice feature of vtkBoxWidget2, like any 3D widget, will work with the current interactor style. That is, if vtkBoxWidget2 does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkBoxWidget will terminate the processing of the event that it handles.

To use this widget, you generally pair it with a vtkBoxRepresentation (or a subclass). Variuos 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 one of the seven handles are selected:
  LeftButtonPressEvent - select the appropriate handle
  LeftButtonReleaseEvent - release the currently selected handle
  MouseMoveEvent - move the handle
If one of the faces is selected:
  LeftButtonPressEvent - select a box face
  LeftButtonReleaseEvent - release the box face
  MouseMoveEvent - rotate the box
In all the cases, independent of what is picked, the widget responds to the
following VTK events:
  MiddleButtonPressEvent - translate the widget
  MiddleButtonReleaseEvent - release the widget
  RightButtonPressEvent - scale the widget's representation
  RightButtonReleaseEvent - stop scaling the widget
  MouseMoveEvent - scale (if right button) or move (if middle button) the 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 vtkBoxWidget2's widget events:

  vtkWidgetEvent::Select -- some part of the widget has been selected
  vtkWidgetEvent::EndSelect -- the selection process has completed
  vtkWidgetEvent::Scale -- some part of the widget has been selected
  vtkWidgetEvent::EndScale -- the selection process has completed
  vtkWidgetEvent::Translate -- some part of the widget has been selected
  vtkWidgetEvent::EndTranslate -- the selection process has completed
  vtkWidgetEvent::Move -- a request for motion has been invoked

Event Bindings:

In turn, when these widget events are processed, the vtkBoxWidget2 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)

Event Bindings:

This class, and the affiliated vtkBoxRepresentation, are second generation VTK widgets. An earlier version of this functionality was defined in the class vtkBoxWidget.

See also

vtkBoxRepresentation vtkBoxWidget

Events:

vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EndInteractionEvent

Tests:

vtkBoxWidget2 (Tests)

Definition at line 108 of file vtkBoxWidget2.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkBoxWidget2::Superclass

Standard class methods for type information and printing.

Definition at line 116 of file vtkBoxWidget2.h.

Member Enumeration Documentation

enum vtkBoxWidget2::_WidgetState

protected

Enumerator
Start
Active

Definition at line 159 of file vtkBoxWidget2.h.

Constructor & Destructor Documentation

vtkBoxWidget2::vtkBoxWidget2 ( )

protected

vtkBoxWidget2::~vtkBoxWidget2 ( )

protected

Member Function Documentation

static vtkBoxWidget2* vtkBoxWidget2::New ( )

static

Instantiate the object.

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

static

Standard class methods for type information and printing.

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

virtual

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

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

static

Standard class methods for type information and printing.

virtual vtkObjectBase* vtkBoxWidget2::NewInstanceInternal ( ) const

protectedvirtual

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

vtkBoxWidget2* vtkBoxWidget2::NewInstance

(

)

const

Standard class methods for type information and printing.

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

virtual

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

void vtkBoxWidget2::SetRepresentation ( vtkBoxRepresentation *  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 124 of file vtkBoxWidget2.h.

virtual void vtkBoxWidget2::SetTranslationEnabled ( int  )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual int vtkBoxWidget2::GetTranslationEnabled ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::TranslationEnabledOn ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::TranslationEnabledOff ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::SetScalingEnabled ( int  )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual int vtkBoxWidget2::GetScalingEnabled ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::ScalingEnabledOn ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::ScalingEnabledOff ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::SetRotationEnabled ( int  )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual int vtkBoxWidget2::GetRotationEnabled ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::RotationEnabledOn ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::RotationEnabledOff ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::SetMoveFacesEnabled ( int  )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual int vtkBoxWidget2::GetMoveFacesEnabled ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::MoveFacesEnabledOn ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

virtual void vtkBoxWidget2::MoveFacesEnabledOff ( )

virtual

Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).

void vtkBoxWidget2::CreateDefaultRepresentation ( )

virtual

Create the default widget representation if one is not set. By default, this is an instance of the vtkBoxRepresentation class.

Implements vtkAbstractWidget.

static void vtkBoxWidget2::SelectAction ( vtkAbstractWidget *  )

staticprotected

static void vtkBoxWidget2::EndSelectAction ( vtkAbstractWidget *  )

staticprotected

static void vtkBoxWidget2::TranslateAction ( vtkAbstractWidget *  )

staticprotected

static void vtkBoxWidget2::ScaleAction ( vtkAbstractWidget *  )

staticprotected

static void vtkBoxWidget2::MoveAction ( vtkAbstractWidget *  )

staticprotected

Member Data Documentation

int vtkBoxWidget2::WidgetState

protected

Definition at line 158 of file vtkBoxWidget2.h.

int vtkBoxWidget2::TranslationEnabled

protected

Definition at line 170 of file vtkBoxWidget2.h.

int vtkBoxWidget2::ScalingEnabled

protected

Definition at line 171 of file vtkBoxWidget2.h.

int vtkBoxWidget2::RotationEnabled

protected

Definition at line 172 of file vtkBoxWidget2.h.

int vtkBoxWidget2::MoveFacesEnabled

protected

Definition at line 173 of file vtkBoxWidget2.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/vtkBoxWidget2.h