VTK
9.0.1
|
a complete specification of a VTK event including all modifiers More...
#include <vtkEvent.h>
Public Types | |
enum | EventModifiers { AnyModifier = -1 , NoModifier = 0 , ShiftModifier = 1 , ControlModifier = 2 , AltModifier = 4 } |
Ways to specify modifiers to VTK events. More... | |
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... | |
vtkEvent * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | SetEventId (unsigned long) |
Set the modifier for the event. More... | |
virtual unsigned long | GetEventId () |
virtual void | SetModifier (int) |
Set the modifier for the event. More... | |
virtual int | GetModifier () |
virtual void | SetKeyCode (char) |
Set the KeyCode for the event. More... | |
virtual char | GetKeyCode () |
virtual void | SetRepeatCount (int) |
Set the repease count for the event. More... | |
virtual int | GetRepeatCount () |
virtual void | SetKeySym (const char *) |
Set the complex key symbol (compound key strokes) for the event. More... | |
virtual char * | GetKeySym () |
bool | operator== (vtkEvent *) |
Used to compare whether two events are equal. More... | |
bool | operator== (unsigned long VTKEvent) |
![]() | |
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) |
![]() | |
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 vtkEvent * | New () |
The object factory constructor. More... | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkEvent * | SafeDownCast (vtkObjectBase *o) |
static int | GetModifier (vtkRenderWindowInteractor *) |
Convenience method computes the event modifier from an interactor. More... | |
![]() | |
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 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 |
vtkEvent () | |
~vtkEvent () override | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
unsigned long | EventId |
int | Modifier |
char | KeyCode |
int | RepeatCount |
char * | KeySym |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
a complete specification of a VTK event including all modifiers
vtkEvent is a class that fully describes a VTK event. It is used by the widgets to help specify the mapping between VTK events and widget events.
Definition at line 31 of file vtkEvent.h.
typedef vtkObject vtkEvent::Superclass |
Standard macros.
Definition at line 43 of file vtkEvent.h.
Ways to specify modifiers to VTK events.
These can be logical OR'd to produce combinations of modifiers.
Enumerator | |
---|---|
AnyModifier | |
NoModifier | |
ShiftModifier | |
ControlModifier | |
AltModifier |
Definition at line 51 of file vtkEvent.h.
|
protected |
|
overrideprotected |
|
static |
The object factory constructor.
|
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 |
vtkEvent* vtkEvent::NewInstance | ( | ) | const |
|
overridevirtual |
|
virtual |
Set the modifier for the event.
|
virtual |
|
virtual |
Set the modifier for the event.
|
virtual |
|
virtual |
Set the KeyCode for the event.
|
virtual |
|
virtual |
Set the repease count for the event.
|
virtual |
|
virtual |
Set the complex key symbol (compound key strokes) for the event.
|
virtual |
|
static |
Convenience method computes the event modifier from an interactor.
bool vtkEvent::operator== | ( | vtkEvent * | ) |
Used to compare whether two events are equal.
Takes into account the EventId as well as the various modifiers.
bool vtkEvent::operator== | ( | unsigned long | VTKEvent | ) |
|
protected |
Definition at line 116 of file vtkEvent.h.
|
protected |
Definition at line 117 of file vtkEvent.h.
|
protected |
Definition at line 118 of file vtkEvent.h.
|
protected |
Definition at line 119 of file vtkEvent.h.
|
protected |
Definition at line 120 of file vtkEvent.h.