Synchronize a collection on vtkWidgets drawn on different renderwindows using the Callback - Dispatch Action mechanism. More...

#include <vtkWidgetSet.h>

Inheritance diagram for vtkWidgetSet:

[legend]

Collaboration diagram for vtkWidgetSet:

[legend]

Public Types
typedef std::vector< vtkAbstractWidget * >	WidgetContainerType

typedef WidgetContainerType::iterator	WidgetIteratorType

typedef WidgetContainerType::const_iterator	WidgetConstIteratorType

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
void	AddWidget (vtkAbstractWidget *)

void	RemoveWidget (vtkAbstractWidget *)

unsigned int	GetNumberOfWidgets ()

vtkAbstractWidget *	GetNthWidget (unsigned int)


virtual void	SetEnabled (int)

virtual void	EnabledOn ()

virtual void	EnabledOff ()

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 vtkWidgetSet *	New ()

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

Public Attributes
WidgetContainerType	Widget

typedef vtkObject	Superclass

static int	IsTypeOf (const char *type)

static vtkWidgetSet *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkWidgetSet *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

template<class TWidget >
void	DispatchAction (TWidget *caller, typename ActionFunction< TWidget >::TActionFunctionPointer action)

	vtkWidgetSet ()

	~vtkWidgetSet ()

Additional Inherited Members
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 &)

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Synchronize a collection on vtkWidgets drawn on different renderwindows using the Callback - Dispatch Action mechanism.

The class synchronizes a set of vtkAbstractWidget(s). Widgets typically invoke "Actions" that drive the geometry/behaviour of their representations in response to interactor events. Interactor interactions on a render window are mapped into "Callbacks" by the widget, from which "Actions" are dispatched to the entire set. This architecture allows us to tie widgets existing in different render windows together. For instance a HandleWidget might exist on the sagittal view. Moving it around should update the representations of the corresponding handle widget that lies on the axial and coronal and volume views as well.

User API:: A user would use this class as follows.
vtkWidgetSet *set = vtkWidgetSet::New();

vtkParallelopipedWidget *w1 = vtkParallelopipedWidget::New();

set->AddWidget(w1);

w1->SetInteractor(axialRenderWindow->GetInteractor());

vtkParallelopipedWidget *w2 = vtkParallelopipedWidget::New();

set->AddWidget(w2);

w2->SetInteractor(coronalRenderWindow->GetInteractor());

vtkParallelopipedWidget *w3 = vtkParallelopipedWidget::New();

set->AddWidget(w3);

w3->SetInteractor(sagittalRenderWindow->GetInteractor());

set->SetEnabled(1);

Motivation:: The motivation for this class is really to provide a usable API to tie together multiple widgets of the same kind. To enable this, subclasses of vtkAbstractWidget, must be written as follows: They will generally have callback methods mapped to some user interaction such as:
this->CallbackMapper->SetCallbackMethod(vtkCommand::LeftButtonPressEvent,

vtkEvent::NoModifier, 0, 0, NULL,

vtkPaintbrushWidget::BeginDrawStrokeEvent,

this, vtkPaintbrushWidget::BeginDrawCallback);

The callback invoked when the left button is pressed looks like:
void vtkPaintbrushWidget::BeginDrawCallback(vtkAbstractWidget *w)

{

vtkPaintbrushWidget *self = vtkPaintbrushWidget::SafeDownCast(w);

self->WidgetSet->DispatchAction(self, &vtkPaintbrushWidget::BeginDrawAction);

}

The actual code for handling the drawing is written in the BeginDrawAction method.
void vtkPaintbrushWidget::BeginDrawAction( vtkPaintbrushWidget *dispatcher)

{

// Do stuff to draw...

// Here dispatcher is the widget that was interacted with, the one that

// dispatched an action to all the other widgets in its group. You may, if

// necessary find it helpful to get parameters from it.

// For instance for a ResizeAction:

// if (this != dispatcher)

// {

// double *newsize = dispatcher->GetRepresentation()->GetSize();

// this->WidgetRep->SetSize(newsize);

// }

// else

// {

// this->WidgetRep->IncrementSizeByDelta();

// }

}

Warning: Actions are always dispatched first to the activeWidget, the one calling the set, and then to the other widgets in the set.

Definition at line 112 of file vtkWidgetSet.h.

Member Typedef Documentation

typedef vtkObject vtkWidgetSet::Superclass

Standard methods for a VTK class.

Definition at line 120 of file vtkWidgetSet.h.

typedef std::vector< vtkAbstractWidget * > vtkWidgetSet::WidgetContainerType

Definition at line 145 of file vtkWidgetSet.h.

typedef WidgetContainerType::iterator vtkWidgetSet::WidgetIteratorType

Definition at line 146 of file vtkWidgetSet.h.

typedef WidgetContainerType::const_iterator vtkWidgetSet::WidgetConstIteratorType

Definition at line 147 of file vtkWidgetSet.h.

Constructor & Destructor Documentation

vtkWidgetSet::vtkWidgetSet ( )

protected

Dispatch an "Action" to every widget in this set. This is meant to be invoked from a "Callback" in a widget.

vtkWidgetSet::~vtkWidgetSet ( )

protected

Dispatch an "Action" to every widget in this set. This is meant to be invoked from a "Callback" in a widget.

Member Function Documentation

static vtkWidgetSet* vtkWidgetSet::New ( )

static

Instantiate this class.

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

static

Standard methods for a VTK class.

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

virtual

Standard methods for a VTK class.

Reimplemented from vtkObject.

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

static

Standard methods for a VTK class.

virtual vtkObjectBase* vtkWidgetSet::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for a VTK class.

Reimplemented from vtkObject.

vtkWidgetSet* vtkWidgetSet::NewInstance ( ) const

Standard methods for a VTK class.

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

virtual

Standard methods for a VTK class.

Reimplemented from vtkObject.

virtual void vtkWidgetSet::SetEnabled ( int )

virtual

Method for activating and deactivating all widgets in the group.

virtual void vtkWidgetSet::EnabledOn ( )

virtual

Method for activating and deactivating all widgets in the group.

virtual void vtkWidgetSet::EnabledOff ( )

virtual

Method for activating and deactivating all widgets in the group.

void vtkWidgetSet::AddWidget ( vtkAbstractWidget * )

Add a widget to the set.

void vtkWidgetSet::RemoveWidget ( vtkAbstractWidget * )

Remove a widget from the set

unsigned int vtkWidgetSet::GetNumberOfWidgets ( )

Get number of widgets in the set.

vtkAbstractWidget* vtkWidgetSet::GetNthWidget ( unsigned int )

Get the Nth widget in the set.

template<class TWidget >

void vtkWidgetSet::DispatchAction	(	TWidget *	caller,
		typename ActionFunction< TWidget >::TActionFunctionPointer	action
	)

inline

Dispatch an "Action" to every widget in this set. This is meant to be invoked from a "Callback" in a widget.

Definition at line 154 of file vtkWidgetSet.h.

Member Data Documentation

WidgetContainerType vtkWidgetSet::Widget

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation