vtkWidgetSet Class Reference

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

#include <vtkWidgetSet.h>

Inheritance diagram for vtkWidgetSet:

Collaboration diagram for vtkWidgetSet:

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.
void	RemoveWidget (vtkAbstractWidget *)
	Remove a widget from the set.
unsigned int	GetNumberOfWidgets ()
	Get number of widgets in the set.
vtkAbstractWidget *	GetNthWidget (unsigned int)
	Get the Nth widget in the set.
virtual void	SetEnabled (vtkTypeBool)
	Method for activating and deactivating all widgets in the group.
virtual void	EnabledOn ()
	Method for activating and deactivating all widgets in the group.
virtual void	EnabledOff ()
	Method for activating and deactivating all widgets in the group.
template<class TWidget >
void	DispatchAction (TWidget *caller, typename ActionFunction< TWidget >::TActionFunctionPointer action)
	Dispatch an "Action" to every widget in this set.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkWidgetSet *	New ()
	Instantiate this class.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Public Attributes
WidgetContainerType	Widget

Protected Member Functions
	vtkWidgetSet ()
	~vtkWidgetSet () override
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
typedef vtkObject	Superclass
	Standard methods for a VTK class.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for a VTK class.
static vtkWidgetSet *	SafeDownCast (vtkObjectBase *o)
	Standard methods for a VTK class.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for a VTK class.
vtkWidgetSet *	NewInstance () const
	Standard methods for a VTK class.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for a VTK class.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for a VTK class.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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 102 of file vtkWidgetSet.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkWidgetSet::Superclass

Standard methods for a VTK class.

Definition at line 114 of file vtkWidgetSet.h.

WidgetContainerType

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

Definition at line 148 of file vtkWidgetSet.h.

WidgetIteratorType

typedef WidgetContainerType::iterator vtkWidgetSet::WidgetIteratorType

Definition at line 149 of file vtkWidgetSet.h.

WidgetConstIteratorType

typedef WidgetContainerType::const_iterator vtkWidgetSet::WidgetConstIteratorType

Definition at line 150 of file vtkWidgetSet.h.

Constructor & Destructor Documentation

vtkWidgetSet()

vtkWidgetSet::vtkWidgetSet ( )

protected

~vtkWidgetSet()

vtkWidgetSet::~vtkWidgetSet ( )

overrideprotected

Member Function Documentation

New()

static vtkWidgetSet * vtkWidgetSet::New ( )

static

Instantiate this class.

IsTypeOf()

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

static

Standard methods for a VTK class.

IsA()

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

virtual

Standard methods for a VTK class.

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

Standard methods for a VTK class.

NewInstanceInternal()

virtual vtkObjectBase * vtkWidgetSet::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for a VTK class.

NewInstance()

vtkWidgetSet * vtkWidgetSet::NewInstance

(

)

const

Standard methods for a VTK class.

PrintSelf()

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

overridevirtual

Standard methods for a VTK class.

Reimplemented from vtkObject.

SetEnabled()

virtual void vtkWidgetSet::SetEnabled ( vtkTypeBool  )

virtual

Method for activating and deactivating all widgets in the group.

EnabledOn()

virtual void vtkWidgetSet::EnabledOn ( )

virtual

Method for activating and deactivating all widgets in the group.

EnabledOff()

virtual void vtkWidgetSet::EnabledOff ( )

virtual

Method for activating and deactivating all widgets in the group.

AddWidget()

void vtkWidgetSet::AddWidget

(

vtkAbstractWidget *

)

Add a widget to the set.

RemoveWidget()

void vtkWidgetSet::RemoveWidget

(

vtkAbstractWidget *

)

Remove a widget from the set.

GetNumberOfWidgets()

unsigned int vtkWidgetSet::GetNumberOfWidgets

(

)

Get number of widgets in the set.

GetNthWidget()

vtkAbstractWidget * vtkWidgetSet::GetNthWidget

(

unsigned int

)

Get the Nth widget in the set.

DispatchAction()

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

Member Data Documentation

Widget

WidgetContainerType vtkWidgetSet::Widget

Definition at line 151 of file vtkWidgetSet.h.

---

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

• Interaction/Widgets/vtkWidgetSet.h