map widget events into callbacks More...

#include <vtkWidgetCallbackMapper.h>

Inheritance diagram for vtkWidgetCallbackMapper:

Collaboration diagram for vtkWidgetCallbackMapper:

Public Types
typedef vtkObject	Superclass

typedef void(*	CallbackType) (vtkAbstractWidget *)

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkWidgetCallbackMapper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetEventTranslator (vtkWidgetEventTranslator *t)

virtual vtkWidgetEventTranslator *	GetEventTranslator ()

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

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

void	InvokeCallback (unsigned long widgetEvent)

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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

int	GetReferenceCount ()

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkWidgetCallbackMapper *	New ()

static int	IsTypeOf (const char *type)

static vtkWidgetCallbackMapper *	SafeDownCast (vtkObjectBase *o)

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWidgetCallbackMapper ()

	~vtkWidgetCallbackMapper ()

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

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
vtkWidgetEventTranslator *	EventTranslator

vtkCallbackMap *	CallbackMap

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Definition at line 40 of file vtkWidgetCallbackMapper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkWidgetCallbackMapper::Superclass

Standard macros.

Definition at line 48 of file vtkWidgetCallbackMapper.h.

◆ CallbackType

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

Convenient typedef for working with callbacks.

Definition at line 61 of file vtkWidgetCallbackMapper.h.

Constructor & Destructor Documentation

◆ vtkWidgetCallbackMapper()

vtkWidgetCallbackMapper::vtkWidgetCallbackMapper ( )

protected

◆ ~vtkWidgetCallbackMapper()

vtkWidgetCallbackMapper::~vtkWidgetCallbackMapper ( )

protected

Member Function Documentation

◆ New()

static vtkWidgetCallbackMapper* vtkWidgetCallbackMapper::New ( )

static

Instantiate the class.

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkWidgetCallbackMapper::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWidgetCallbackMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

◆ NewInstance()

vtkWidgetCallbackMapper* vtkWidgetCallbackMapper::NewInstance ( ) const

◆ PrintSelf()

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetEventTranslator()

void vtkWidgetCallbackMapper::SetEventTranslator ( vtkWidgetEventTranslator * t )

Specify the vtkWidgetEventTranslator to coordinate with.

◆ GetEventTranslator()

virtual vtkWidgetEventTranslator* vtkWidgetCallbackMapper::GetEventTranslator ( )

virtual

◆ SetCallbackMethod() [1/3]

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/3]

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

◆ 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() [3/3]

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 93 of file vtkWidgetCallbackMapper.h.

◆ CallbackMap

vtkCallbackMap* vtkWidgetCallbackMapper::CallbackMap

protected

Definition at line 96 of file vtkWidgetCallbackMapper.h.

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

dox/opt/build/vtk6-6.3.0+dfsg2/Interaction/Widgets/vtkWidgetCallbackMapper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ CallbackType

Constructor & Destructor Documentation

◆ vtkWidgetCallbackMapper()

◆ ~vtkWidgetCallbackMapper()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetEventTranslator()

◆ GetEventTranslator()

◆ SetCallbackMethod() [1/3]

◆ SetCallbackMethod() [2/3]

◆ InvokeCallback()

◆ SetCallbackMethod() [3/3]

Member Data Documentation

◆ EventTranslator

◆ CallbackMap