define the API for widget / widget representation More...

#include <vtkAbstractWidget.h>

Inheritance diagram for vtkAbstractWidget:

Collaboration diagram for vtkAbstractWidget:

Public Member Functions
virtual void	SetEnabled (int)

virtual void	CreateDefaultRepresentation ()=0

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

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

Protected Member Functions
	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	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
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 vtkInteractorObserver	Superclass

static int	IsTypeOf (const char *type)

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkAbstractWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

Detailed Description

define the API for widget / widget representation

The vtkAbstractWidget defines an API and implements methods common to all widgets using the interaction/representation design. In this design, the term interaction means that part of the widget that performs event handling, while the representation corresponds to a vtkProp (or the subclass vtkWidgetRepresentation) used to represent the widget. vtkAbstractWidget also implements some methods common to all subclasses.

Note that vtkAbstractWidget provides access to the vtkWidgetEventTranslator. This class is responsible for translating VTK events (defined in vtkCommand.h) into widget events (defined in vtkWidgetEvent.h). This class can be manipulated so that different VTK events can be mapped into widget events, thereby allowing the modification of event bindings. Each subclass of vtkAbstractWidget defines the events to which it responds.

Warning: Note that the pair ( vtkAbstractWidget / vtkWidgetRepresentation ) is an implementation of the second generation VTK Widgets design. In the first generation design, widgets were implemented in a single monolithic class. This design was problematic because in client-server application it was difficult to manage widgets properly. Also, new "representations" or look-and-feel, for a widget required a whole new class, with a lot of redundant code. The separation of the widget event handling and representation enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).

See also: vtkWidgetRepresentation vtkWidgetEventTranslator vtkWidgetCallbackMapper

Events:: vtkCommand::DisableEvent vtkCommand::EnableEvent

Definition at line 65 of file vtkAbstractWidget.h.

Member Typedef Documentation

typedef vtkInteractorObserver vtkAbstractWidget::Superclass

Standard macros implementing standard VTK methods.

Definition at line 70 of file vtkAbstractWidget.h.

Constructor & Destructor Documentation

vtkAbstractWidget::vtkAbstractWidget ( )

protected

vtkAbstractWidget::~vtkAbstractWidget ( )

protected

Member Function Documentation

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

static

Standard macros implementing standard VTK methods.

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

virtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkContourWidget, vtkBiDimensionalWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkSphereWidget2, vtkLineWidget2, vtkAxesTransformWidget, vtkRectilinearWipeWidget, vtkAngleWidget, vtkBalloonWidget, vtkDistanceWidget, vtkBorderWidget, vtkCenteredSliderWidget, vtkSeedWidget, vtkSliderWidget, vtkHoverWidget, vtkHandleWidget, vtkCompassWidget, vtkAffineWidget, vtkContinuousValueWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkParallelopipedWidget, vtkCaptionWidget, vtkResliceCursorWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTensorProbeWidget, vtkTextWidget, vtkLogoWidget, vtkPlaybackWidget, vtkPolyLineWidget, and vtkSplineWidget2.

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

static

Standard macros implementing standard VTK methods.

virtual vtkObjectBase* vtkAbstractWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkContourWidget, vtkBiDimensionalWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkSphereWidget2, vtkLineWidget2, vtkAxesTransformWidget, vtkRectilinearWipeWidget, vtkAngleWidget, vtkBalloonWidget, vtkDistanceWidget, vtkBorderWidget, vtkCenteredSliderWidget, vtkSeedWidget, vtkSliderWidget, vtkHoverWidget, vtkHandleWidget, vtkCompassWidget, vtkAffineWidget, vtkContinuousValueWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkParallelopipedWidget, vtkCaptionWidget, vtkResliceCursorWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTensorProbeWidget, vtkTextWidget, vtkLogoWidget, vtkPlaybackWidget, vtkPolyLineWidget, and vtkSplineWidget2.

vtkAbstractWidget* vtkAbstractWidget::NewInstance ( ) const

Standard macros implementing standard VTK methods.

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

virtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkObject.

Reimplemented in vtkContourWidget, vtkBiDimensionalWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkSphereWidget2, vtkLineWidget2, vtkAxesTransformWidget, vtkRectilinearWipeWidget, vtkAngleWidget, vtkBalloonWidget, vtkDistanceWidget, vtkBorderWidget, vtkCenteredSliderWidget, vtkSeedWidget, vtkSliderWidget, vtkHoverWidget, vtkHandleWidget, vtkAffineWidget, vtkContinuousValueWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkParallelopipedWidget, vtkCaptionWidget, vtkResliceCursorWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTensorProbeWidget, vtkTextWidget, vtkLogoWidget, vtkPlaybackWidget, vtkPolyLineWidget, and vtkSplineWidget2.

virtual void vtkAbstractWidget::SetEnabled ( int )

virtual

Methods for activating this widget. Note that the widget representation must be specified or the widget will not appear. ProcessEvents (On by default) must be On for Enabled widget to respond to interaction. If ProcessEvents is Off, enabling/disabling a widget merely affects the visibility of the representation.

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkContourWidget, vtkImplicitPlaneWidget2, vtkBiDimensionalWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkAffineWidget, vtkAngleWidget, vtkBalloonWidget, vtkHoverWidget, vtkDistanceWidget, vtkSeedWidget, vtkResliceCursorWidget, vtkCheckerboardWidget, vtkParallelopipedWidget, and vtkCaptionWidget.

virtual void vtkAbstractWidget::SetProcessEvents ( int )

virtual

Methods to change whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

Reimplemented in vtkBiDimensionalWidget, vtkLineWidget2, vtkSeedWidget, vtkAxesTransformWidget, vtkAngleWidget, vtkDistanceWidget, and vtkParallelopipedWidget.

virtual int vtkAbstractWidget::GetProcessEvents ( )

virtual

Methods to change whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

virtual void vtkAbstractWidget::ProcessEventsOn ( )

virtual

Methods to change whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

virtual void vtkAbstractWidget::ProcessEventsOff ( )

virtual

Methods to change whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.

vtkWidgetEventTranslator* vtkAbstractWidget::GetEventTranslator ( )

inline

Get the event translator. Careful manipulation of this class enables the user to override the default event bindings.

Definition at line 94 of file vtkAbstractWidget.h.

virtual void vtkAbstractWidget::CreateDefaultRepresentation ( )

pure virtual

Create the default widget representation if one is not set. The representation defines the geometry of the widget (i.e., how it appears) as well as providing special methods for manipulting the state and appearance of the widget.

Implemented in vtkContourWidget, vtkBoxWidget2, vtkBiDimensionalWidget, vtkImplicitPlaneWidget2, vtkBorderWidget, vtkSphereWidget2, vtkSliderWidget, vtkLineWidget2, vtkSeedWidget, vtkAxesTransformWidget, vtkBalloonWidget, vtkDistanceWidget, vtkRectilinearWipeWidget, vtkAngleWidget, vtkCenteredSliderWidget, vtkHoverWidget, vtkHandleWidget, vtkAffineWidget, vtkParallelopipedWidget, vtkCompassWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkCaptionWidget, vtkResliceCursorWidget, vtkScalarBarWidget, vtkTextWidget, vtkTensorProbeWidget, vtkCameraWidget, vtkLogoWidget, vtkPlaybackWidget, vtkPolyLineWidget, and vtkSplineWidget2.

void vtkAbstractWidget::Render ( )

This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. This method should be called (instead of vtkRenderWindow::Render() because it has built into it optimizations for minimizing renders and/or speeding renders.

void vtkAbstractWidget::SetParent ( vtkAbstractWidget * parent )

inline

Specifying a parent to this widget is used when creating composite widgets. It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).

Definition at line 115 of file vtkAbstractWidget.h.

virtual vtkAbstractWidget* vtkAbstractWidget::GetParent ( )

virtual

Specifying a parent to this widget is used when creating composite widgets. It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).

vtkWidgetRepresentation* vtkAbstractWidget::GetRepresentation ( )

inline

Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp (typically a subclass of vtkWidgetRepresenation) so it can be added to the renderer independent of the widget.

Definition at line 124 of file vtkAbstractWidget.h.

virtual void vtkAbstractWidget::SetManagesCursor ( int )

virtual

Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

virtual int vtkAbstractWidget::GetManagesCursor ( )

virtual

Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

virtual void vtkAbstractWidget::ManagesCursorOn ( )

virtual

Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

virtual void vtkAbstractWidget::ManagesCursorOff ( )

virtual

Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

virtual void vtkAbstractWidget::SetPriority ( float )

virtual

Override the superclass method. This will automatically change the priority of the widget. Unlike the superclass documentation, no methods such as SetInteractor to null and reset it etc. are necessary

Reimplemented from vtkInteractorObserver.

static void vtkAbstractWidget::ProcessEventsHandler	(	vtkObject *	object,
		unsigned long	event,
		void *	clientdata,
		void *	calldata
	)

staticprotected

void vtkAbstractWidget::SetWidgetRepresentation ( vtkWidgetRepresentation * r )

protected

virtual void vtkAbstractWidget::SetCursor ( int vtkNotUsedstate )

inlineprotectedvirtual

Definition at line 163 of file vtkAbstractWidget.h.

Member Data Documentation

vtkWidgetRepresentation* vtkAbstractWidget::WidgetRep

protected

Definition at line 159 of file vtkAbstractWidget.h.

int vtkAbstractWidget::ManagesCursor

protected

Definition at line 162 of file vtkAbstractWidget.h.

vtkWidgetEventTranslator* vtkAbstractWidget::EventTranslator

protected

Definition at line 166 of file vtkAbstractWidget.h.

vtkWidgetCallbackMapper* vtkAbstractWidget::CallbackMapper

protected

Definition at line 167 of file vtkAbstractWidget.h.

vtkAbstractWidget* vtkAbstractWidget::Parent

protected

Definition at line 170 of file vtkAbstractWidget.h.

void* vtkAbstractWidget::CallData

protected

Definition at line 175 of file vtkAbstractWidget.h.

int vtkAbstractWidget::ProcessEvents

protected

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation