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 Member Functions
void	AddWidget (vtkAbstractWidget *)
	Add a widget to the set. More...

void	RemoveWidget (vtkAbstractWidget *)
	Remove a widget from the set. More...

unsigned int	GetNumberOfWidgets ()
	Get number of widgets in the set. More...

vtkAbstractWidget *	GetNthWidget (unsigned int)
	Get the Nth widget in the set. More...


virtual void	SetEnabled (vtkTypeBool)
	Method for activating and deactivating all widgets in the group. More...

virtual void	EnabledOn ()
	Method for activating and deactivating all widgets in the group. More...

virtual void	EnabledOff ()
	Method for activating and deactivating all widgets in the group. 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 ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	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...

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

vtkTypeBool	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 vtkWidgetSet *	New ()
	Instantiate this class. 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...

Public Attributes
WidgetContainerType	Widget

typedef vtkObject	Superclass
	Standard methods for a VTK class. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for a VTK class. More...

static vtkWidgetSet *	SafeDownCast (vtkObjectBase *o)
	Standard methods for a VTK class. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for a VTK class. More...

vtkWidgetSet *	NewInstance () const
	Standard methods for a VTK class. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for a VTK class. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for a VTK class. More...

template<class TWidget >
void	DispatchAction (TWidget *caller, typename ActionFunction< TWidget >::TActionFunctionPointer action)
	Dispatch an "Action" to every widget in this set. More...

	vtkWidgetSet ()
	Dispatch an "Action" to every widget in this set. More...

	~vtkWidgetSet () override
	Dispatch an "Action" to every widget in this set. More...

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

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, nullptr,
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 111 of file vtkWidgetSet.h.

Member Typedef Documentation

typedef vtkObject vtkWidgetSet::Superclass

Standard methods for a VTK class.

Definition at line 123 of file vtkWidgetSet.h.

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

Definition at line 157 of file vtkWidgetSet.h.

typedef WidgetContainerType::iterator vtkWidgetSet::WidgetIteratorType

Definition at line 158 of file vtkWidgetSet.h.

typedef WidgetContainerType::const_iterator vtkWidgetSet::WidgetConstIteratorType

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

overrideprotected

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 vtkTypeBool vtkWidgetSet::IsTypeOf ( const char * type )

static

Standard methods for a VTK class.

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

virtual

Standard methods for a VTK class.

Reimplemented from vtkObjectBase.

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.

vtkWidgetSet* vtkWidgetSet::NewInstance ( ) const

Standard methods for a VTK class.

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

overridevirtual

Standard methods for a VTK class.

Reimplemented from vtkObject.

virtual void vtkWidgetSet::SetEnabled ( vtkTypeBool )

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 168 of file vtkWidgetSet.h.

Member Data Documentation

WidgetContainerType vtkWidgetSet::Widget

Definition at line 160 of file vtkWidgetSet.h.

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

/home/demarle/Source/VTK/release/8.2/build/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