vtkWidgetCallbackMapper Class Reference

map widget events into callbacks More...

#include <vtkWidgetCallbackMapper.h>

Inheritance diagram for vtkWidgetCallbackMapper:

Collaboration diagram for vtkWidgetCallbackMapper:

Public Types
typedef void(*	CallbackType) (vtkAbstractWidget *)
	Convenient typedef for working with callbacks.

Public Member Functions
void	InvokeCallback (unsigned long widgetEvent)
	This method invokes the callback given a widget event.
void	SetEventTranslator (vtkWidgetEventTranslator *t)
	Specify the vtkWidgetEventTranslator to coordinate with.
virtual vtkWidgetEventTranslator *	GetEventTranslator ()
	Specify the vtkWidgetEventTranslator to coordinate with.
void	SetCallbackMethod (unsigned long VTKEvent, unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)
	This class works with the class vtkWidgetEventTranslator to set up the initial coorespondence between VTK events, widget events, and callbacks.
void	SetCallbackMethod (unsigned long VTKEvent, int modifiers, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)
	This class works with the class vtkWidgetEventTranslator to set up the initial coorespondence between VTK events, widget events, and callbacks.
void	SetCallbackMethod (unsigned long VTKEvent, vtkEventData *ed, unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)
	This class works with the class vtkWidgetEventTranslator to set up the initial coorespondence between VTK events, widget events, and callbacks.
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 vtkWidgetCallbackMapper *	New ()
	Instantiate the 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.

Protected Member Functions
	vtkWidgetCallbackMapper ()
	~vtkWidgetCallbackMapper () override
void	SetCallbackMethod (unsigned long widgetEvent, vtkAbstractWidget *w, CallbackType f)
	This method is used to assign a callback (implemented as a static class method) to a particular widget event.
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 &)

Protected Attributes
vtkWidgetEventTranslator *	EventTranslator
vtkCallbackMap *	CallbackMap
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
typedef vtkObject	Superclass
	Standard macros.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard macros.
static vtkWidgetCallbackMapper *	SafeDownCast (vtkObjectBase *o)
	Standard macros.
virtual vtkTypeBool	IsA (const char *type)
	Standard macros.
vtkWidgetCallbackMapper *	NewInstance () const
	Standard macros.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard macros.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard macros.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

map widget events into callbacks

vtkWidgetCallbackMapper maps widget events (defined in vtkWidgetEvent.h) into static class methods, and provides facilities to invoke the methods. This class is templated and meant to be used as an internal helper class by the widget classes. The class works in combination with the class vtkWidgetEventTranslator, which translates VTK events into widget events.

See also

vtkWidgetEvent vtkWidgetEventTranslator

Online Examples:

BorderWidgetQt

BorderWidget

Definition at line 59 of file vtkWidgetCallbackMapper.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkWidgetCallbackMapper::Superclass

Standard macros.

Definition at line 71 of file vtkWidgetCallbackMapper.h.

CallbackType

typedef void(* vtkWidgetCallbackMapper::CallbackType) (vtkAbstractWidget *)

Convenient typedef for working with callbacks.

Definition at line 86 of file vtkWidgetCallbackMapper.h.

Constructor & Destructor Documentation

vtkWidgetCallbackMapper()

vtkWidgetCallbackMapper::vtkWidgetCallbackMapper ( )

protected

~vtkWidgetCallbackMapper()

vtkWidgetCallbackMapper::~vtkWidgetCallbackMapper ( )

overrideprotected

Member Function Documentation

New()

static vtkWidgetCallbackMapper * vtkWidgetCallbackMapper::New ( )

static

Instantiate the class.

IsTypeOf()

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

static

Standard macros.

IsA()

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

virtual

Standard macros.

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

Standard macros.

NewInstanceInternal()

virtual vtkObjectBase * vtkWidgetCallbackMapper::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

NewInstance()

vtkWidgetCallbackMapper * vtkWidgetCallbackMapper::NewInstance

(

)

const

Standard macros.

PrintSelf()

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

overridevirtual

Standard macros.

Reimplemented from vtkObject.

SetEventTranslator()

void vtkWidgetCallbackMapper::SetEventTranslator

(

vtkWidgetEventTranslator *

t

)

Specify the vtkWidgetEventTranslator to coordinate with.

GetEventTranslator()

virtual vtkWidgetEventTranslator * vtkWidgetCallbackMapper::GetEventTranslator ( )

virtual

Specify the vtkWidgetEventTranslator to coordinate with.

SetCallbackMethod() [1/4]

void vtkWidgetCallbackMapper::SetCallbackMethod	(	unsigned long	VTKEvent,
		unsigned long	widgetEvent,
		vtkAbstractWidget *	w,
		CallbackType	f
	)

This class works with the class vtkWidgetEventTranslator to set up the initial coorespondence between VTK events, widget events, and callbacks.

Different flavors of the SetCallbackMethod() are available depending on what sort of modifiers are to be associated with a particular event. Typically the widgets should use this method to set up their event callbacks. If modifiers are not provided (i.e., the VTKEvent is a unsigned long eventId) then modifiers are ignored. Otherwise, a vtkEvent instance is used to fully quality the events.

SetCallbackMethod() [2/4]

void vtkWidgetCallbackMapper::SetCallbackMethod	(	unsigned long	VTKEvent,
		int	modifiers,
		char	keyCode,
		int	repeatCount,
		const char *	keySym,
		unsigned long	widgetEvent,
		vtkAbstractWidget *	w,
		CallbackType	f
	)

This class works with the class vtkWidgetEventTranslator to set up the initial coorespondence between VTK events, widget events, and callbacks.

Different flavors of the SetCallbackMethod() are available depending on what sort of modifiers are to be associated with a particular event. Typically the widgets should use this method to set up their event callbacks. If modifiers are not provided (i.e., the VTKEvent is a unsigned long eventId) then modifiers are ignored. Otherwise, a vtkEvent instance is used to fully quality the events.

SetCallbackMethod() [3/4]

void vtkWidgetCallbackMapper::SetCallbackMethod	(	unsigned long	VTKEvent,
		vtkEventData *	ed,
		unsigned long	widgetEvent,
		vtkAbstractWidget *	w,
		CallbackType	f
	)

This class works with the class vtkWidgetEventTranslator to set up the initial coorespondence between VTK events, widget events, and callbacks.

Different flavors of the SetCallbackMethod() are available depending on what sort of modifiers are to be associated with a particular event. Typically the widgets should use this method to set up their event callbacks. If modifiers are not provided (i.e., the VTKEvent is a unsigned long eventId) then modifiers are ignored. Otherwise, a vtkEvent instance is used to fully quality the events.

InvokeCallback()

void vtkWidgetCallbackMapper::InvokeCallback

(

unsigned long

widgetEvent

)

This method invokes the callback given a widget event.

A non-zero value is returned if the listed event is registered.

SetCallbackMethod() [4/4]

void vtkWidgetCallbackMapper::SetCallbackMethod ( unsigned long  widgetEvent, vtkAbstractWidget *  w, CallbackType  f  )

protected

This method is used to assign a callback (implemented as a static class method) to a particular widget event.

This is an internal method used by widgets to map widget events into invocations of class methods.

Member Data Documentation

EventTranslator

vtkWidgetEventTranslator* vtkWidgetCallbackMapper::EventTranslator

protected

Definition at line 120 of file vtkWidgetCallbackMapper.h.

CallbackMap

vtkCallbackMap* vtkWidgetCallbackMapper::CallbackMap

protected

Definition at line 123 of file vtkWidgetCallbackMapper.h.

---

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

• Interaction/Widgets/vtkWidgetCallbackMapper.h