|
VTK
9.0.1
|
map VTK events into widget events More...
#include <vtkWidgetEventTranslator.h>
Public Types | |
| typedef vtkObject | Superclass |
| Standard macros. More... | |
Public Member Functions | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkWidgetEventTranslator * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | SetTranslation (unsigned long VTKEvent, unsigned long widgetEvent) |
| Use these methods to create the translation from a VTK event to a widget event. More... | |
| void | SetTranslation (const char *VTKEvent, const char *widgetEvent) |
| void | SetTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent) |
| void | SetTranslation (vtkEvent *VTKevent, unsigned long widgetEvent) |
| void | SetTranslation (unsigned long VTKEvent, vtkEventData *edata, unsigned long widgetEvent) |
| unsigned long | GetTranslation (unsigned long VTKEvent) |
| Translate a VTK event into a widget event. More... | |
| const char * | GetTranslation (const char *VTKEvent) |
| unsigned long | GetTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym) |
| unsigned long | GetTranslation (unsigned long VTKEvent, vtkEventData *edata) |
| unsigned long | GetTranslation (vtkEvent *VTKEvent) |
| int | RemoveTranslation (unsigned long VTKEvent, int modifier, char keyCode, int repeatCount, const char *keySym) |
| Remove translations for a binding. More... | |
| int | RemoveTranslation (vtkEvent *e) |
| int | RemoveTranslation (vtkEventData *e) |
| int | RemoveTranslation (unsigned long VTKEvent) |
| int | RemoveTranslation (const char *VTKEvent) |
| void | ClearEvents () |
| Clear all events from the translator (i.e., no events will be translated). More... | |
| void | AddEventsToParent (vtkAbstractWidget *, vtkCallbackCommand *, float priority) |
| Add the events in the current translation table to the interactor. More... | |
| void | AddEventsToInteractor (vtkRenderWindowInteractor *, vtkCallbackCommand *, float priority) |
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... | |
| 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) |
| vtkCommand * | GetCommand (unsigned long tag) |
| void | RemoveObserver (vtkCommand *) |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| void | RemoveObservers (const char *event, vtkCommand *) |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| 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) |
| 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) |
| 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) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual vtkIdType | GetNumberOfGenerationsFromBase (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). 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 | PrintHeader (ostream &os, vtkIndent indent) |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| 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... | |
Static Public Member Functions | |
| static vtkWidgetEventTranslator * | New () |
| Instantiate the object. More... | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkWidgetEventTranslator * | SafeDownCast (vtkObjectBase *o) |
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 () |
| static void | GlobalWarningDisplayOff () |
| static int | GetGlobalWarningDisplay () |
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 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). More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| 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. More... | |
| 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 | |
| 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 |
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.
Definition at line 48 of file vtkWidgetEventTranslator.h.
Standard macros.
Definition at line 60 of file vtkWidgetEventTranslator.h.
|
protected |
|
overrideprotected |
|
static |
Instantiate the object.
|
static |
|
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 vtkObjectBase.
|
static |
|
protectedvirtual |
| vtkWidgetEventTranslator* vtkWidgetEventTranslator::NewInstance | ( | ) | const |
|
overridevirtual |
| 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.
| void vtkWidgetEventTranslator::SetTranslation | ( | const char * | VTKEvent, |
| const char * | widgetEvent | ||
| ) |
| void vtkWidgetEventTranslator::SetTranslation | ( | unsigned long | VTKEvent, |
| int | modifier, | ||
| char | keyCode, | ||
| int | repeatCount, | ||
| const char * | keySym, | ||
| unsigned long | widgetEvent | ||
| ) |
| void vtkWidgetEventTranslator::SetTranslation | ( | vtkEvent * | VTKevent, |
| unsigned long | widgetEvent | ||
| ) |
| void vtkWidgetEventTranslator::SetTranslation | ( | unsigned long | VTKEvent, |
| vtkEventData * | edata, | ||
| unsigned long | widgetEvent | ||
| ) |
| 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.
| const char* vtkWidgetEventTranslator::GetTranslation | ( | const char * | VTKEvent | ) |
| unsigned long vtkWidgetEventTranslator::GetTranslation | ( | unsigned long | VTKEvent, |
| int | modifier, | ||
| char | keyCode, | ||
| int | repeatCount, | ||
| const char * | keySym | ||
| ) |
| unsigned long vtkWidgetEventTranslator::GetTranslation | ( | unsigned long | VTKEvent, |
| vtkEventData * | edata | ||
| ) |
| unsigned long vtkWidgetEventTranslator::GetTranslation | ( | vtkEvent * | VTKEvent | ) |
| int vtkWidgetEventTranslator::RemoveTranslation | ( | unsigned long | VTKEvent, |
| int | modifier, | ||
| char | keyCode, | ||
| int | repeatCount, | ||
| const char * | keySym | ||
| ) |
Remove translations for a binding.
Returns the number of translations removed.
| int vtkWidgetEventTranslator::RemoveTranslation | ( | vtkEvent * | e | ) |
| int vtkWidgetEventTranslator::RemoveTranslation | ( | vtkEventData * | e | ) |
| int vtkWidgetEventTranslator::RemoveTranslation | ( | unsigned long | VTKEvent | ) |
| int vtkWidgetEventTranslator::RemoveTranslation | ( | const char * | VTKEvent | ) |
| void vtkWidgetEventTranslator::ClearEvents | ( | ) |
Clear all events from the translator (i.e., no events will be translated).
| void vtkWidgetEventTranslator::AddEventsToParent | ( | vtkAbstractWidget * | , |
| vtkCallbackCommand * | , | ||
| float | priority | ||
| ) |
Add the events in the current translation table to the interactor.
| void vtkWidgetEventTranslator::AddEventsToInteractor | ( | vtkRenderWindowInteractor * | , |
| vtkCallbackCommand * | , | ||
| float | priority | ||
| ) |
|
protected |
Definition at line 124 of file vtkWidgetEventTranslator.h.
|
protected |
Definition at line 127 of file vtkWidgetEventTranslator.h.
1.8.17