map VTK events into widget events More...

#include <vtkWidgetEventTranslator.h>

Inheritance diagram for vtkWidgetEventTranslator:

Collaboration diagram for vtkWidgetEventTranslator:

Public Member Functions
void	ClearEvents ()
	Clear all events from the translator (i.e., no events will be translated).


void	SetTranslation (unsigned long VTKEvent, unsigned long widgetEvent)
	Use these methods to create the translation from a VTK event to a widget event.

void	SetTranslation (const char VTKEvent, const char widgetEvent)
	Use these methods to create the translation from a VTK event to a widget event.

void	SetTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent)
	Use these methods to create the translation from a VTK event to a widget event.

void	SetTranslation (vtkEvent *VTKevent, unsigned long widgetEvent)
	Use these methods to create the translation from a VTK event to a widget event.

void	SetTranslation (unsigned long VTKEvent, vtkEventData *edata, unsigned long widgetEvent)
	Use these methods to create the translation from a VTK event to a widget event.


unsigned long	GetTranslation (unsigned long VTKEvent)
	Translate a VTK event into a widget event.

const char *	GetTranslation (const char *VTKEvent)
	Translate a VTK event into a widget event.

unsigned long	GetTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym)
	Translate a VTK event into a widget event.

unsigned long	GetTranslation (unsigned long VTKEvent, vtkEventData *edata)
	Translate a VTK event into a widget event.

unsigned long	GetTranslation (vtkEvent *VTKEvent)
	Translate a VTK event into a widget event.


int	RemoveTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym)
	Remove translations for a binding.

int	RemoveTranslation (vtkEvent *e)
	Remove translations for a binding.

int	RemoveTranslation (vtkEventData *e)
	Remove translations for a binding.

int	RemoveTranslation (unsigned long VTKEvent)
	Remove translations for a binding.

int	RemoveTranslation (const char *VTKEvent)
	Remove translations for a binding.


void	AddEventsToParent (vtkAbstractWidget , vtkCallbackCommand , float priority)
	Add the events in the current translation table to the interactor.

void	AddEventsToInteractor (vtkRenderWindowInteractor , vtkCallbackCommand , float priority)
	Add the events in the current translation table to the interactor.

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)

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.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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.

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

Static Public Member Functions
static vtkWidgetEventTranslator *	New ()
	Instantiate the object.

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

	~vtkWidgetEventTranslator () 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 *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkEventMap *	EventMap

vtkEvent *	Event

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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 vtkWidgetEventTranslator *	SafeDownCast (vtkObjectBase *o)
	Standard macros.

virtual vtkTypeBool	IsA (const char *type)
	Standard macros.

vtkWidgetEventTranslator *	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 VTK events into widget events

vtkWidgetEventTranslator maps VTK events (defined on vtkCommand) into widget events (defined in vtkWidgetEvent.h). This class is typically used in combination with vtkWidgetCallbackMapper, which is responsible for translating widget events into method callbacks, and then invoking the callbacks.

This class can be used to define different mappings of VTK events into the widget events. Thus widgets can be reconfigured to use different event bindings.

See also: vtkWidgetEvent vtkCommand vtkInteractorObserver

Online Examples:

OctreeVisualize

VisualizeKDTree

VisualizeModifiedBSPTree

VisualizeOBBTree

CellLocatorVisualization

PointLocatorVisualization

Slider

Slider2D

Definition at line 137 of file vtkWidgetEventTranslator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkWidgetEventTranslator::Superclass

Standard macros.

Definition at line 149 of file vtkWidgetEventTranslator.h.

Constructor & Destructor Documentation

◆ vtkWidgetEventTranslator()

vtkWidgetEventTranslator::vtkWidgetEventTranslator ( )

protected

◆ ~vtkWidgetEventTranslator()

vtkWidgetEventTranslator::~vtkWidgetEventTranslator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkWidgetEventTranslator * vtkWidgetEventTranslator::New ( )

static

Instantiate the object.

◆ IsTypeOf()

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

static

Standard macros.

◆ IsA()

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

virtual

Standard macros.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

Standard macros.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWidgetEventTranslator::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

◆ NewInstance()

vtkWidgetEventTranslator * vtkWidgetEventTranslator::NewInstance ( ) const

Standard macros.

◆ PrintSelf()

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

overridevirtual

Standard macros.

Reimplemented from vtkObject.

◆ SetTranslation() [1/5]

void vtkWidgetEventTranslator::SetTranslation	(	unsigned long	VTKEvent,
		unsigned long	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event.

Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

◆ SetTranslation() [2/5]

void vtkWidgetEventTranslator::SetTranslation	(	const char *	VTKEvent,
		const char *	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event.

Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

◆ SetTranslation() [3/5]

void vtkWidgetEventTranslator::SetTranslation	(	unsigned long	VTKEvent,
		int	modifier,
		char	keyCode,
		int	repeatCount,
		const char *	keySym,
		unsigned long	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event.

Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

◆ SetTranslation() [4/5]

void vtkWidgetEventTranslator::SetTranslation	(	vtkEvent *	VTKevent,
		unsigned long	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event.

Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

◆ SetTranslation() [5/5]

void vtkWidgetEventTranslator::SetTranslation	(	unsigned long	VTKEvent,
		vtkEventData *	edata,
		unsigned long	widgetEvent
	)

Use these methods to create the translation from a VTK event to a widget event.

Specifying vtkWidgetEvent::NoEvent or an empty string for the (toEvent) erases the mapping for the event.

◆ GetTranslation() [1/5]

unsigned long vtkWidgetEventTranslator::GetTranslation ( unsigned long VTKEvent )

Translate a VTK event into a widget event.

If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a nullptr string.

◆ GetTranslation() [2/5]

const char * vtkWidgetEventTranslator::GetTranslation ( const char * VTKEvent )

Translate a VTK event into a widget event.

If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a nullptr string.

◆ GetTranslation() [3/5]

unsigned long vtkWidgetEventTranslator::GetTranslation	(	unsigned long	VTKEvent,
		int	modifier,
		char	keyCode,
		int	repeatCount,
		const char *	keySym
	)

Translate a VTK event into a widget event.

If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a nullptr string.

◆ GetTranslation() [4/5]

unsigned long vtkWidgetEventTranslator::GetTranslation	(	unsigned long	VTKEvent,
		vtkEventData *	edata
	)

Translate a VTK event into a widget event.

If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a nullptr string.

◆ GetTranslation() [5/5]

unsigned long vtkWidgetEventTranslator::GetTranslation ( vtkEvent * VTKEvent )

Translate a VTK event into a widget event.

If no event mapping is found, then the methods return vtkWidgetEvent::NoEvent or a nullptr string.