vtkEvent Class Reference

a complete specification of a VTK event including all modifiers More...

#include <vtkEvent.h>

Inheritance diagram for vtkEvent:

Collaboration diagram for vtkEvent:

Public Types
enum	EventModifiers {   AnyModifier = -1 , NoModifier = 0 , ShiftModifier = 1 , ControlModifier = 2 ,   AltModifier = 4 }
	Ways to specify modifiers to VTK events. More...

Public Member Functions
bool	operator== (vtkEvent *) const
	Used to compare whether two events are equal.
bool	operator== (unsigned long VTKEvent) const
virtual void	SetEventId (unsigned long)
	Set the modifier for the event.
virtual unsigned long	GetEventId ()
	Set the modifier for the event.
virtual void	SetModifier (int)
	Set the modifier for the event.
virtual int	GetModifier ()
	Set the modifier for the event.
virtual void	SetKeyCode (char)
	Set the KeyCode for the event.
virtual char	GetKeyCode ()
	Set the KeyCode for the event.
virtual void	SetRepeatCount (int)
	Set the repease count for the event.
virtual int	GetRepeatCount ()
	Set the repease count for the event.
virtual void	SetKeySym (const char *)
	Set the complex key symbol (compound key strokes) for the event.
virtual char *	GetKeySym ()
	Set the complex key symbol (compound key strokes) for the event.
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 vtkEvent *	New ()
	The object factory constructor.
static int	GetModifier (vtkRenderWindowInteractor *)
	Convenience method computes the event modifier from an interactor.
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
	vtkEvent ()
	~vtkEvent () 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 *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
unsigned long	EventId
int	Modifier
char	KeyCode
int	RepeatCount
char *	KeySym
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 vtkEvent *	SafeDownCast (vtkObjectBase *o)
	Standard macros.
virtual vtkTypeBool	IsA (const char *type)
	Standard macros.
vtkEvent *	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

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.

Tests:

vtkEvent (Tests)

Definition at line 23 of file vtkEvent.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkEvent::Superclass

Standard macros.

Definition at line 35 of file vtkEvent.h.

Member Enumeration Documentation

EventModifiers

enum vtkEvent::EventModifiers

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 43 of file vtkEvent.h.

Constructor & Destructor Documentation

vtkEvent()

vtkEvent::vtkEvent ( )

protected

~vtkEvent()

vtkEvent::~vtkEvent ( )

overrideprotected

Member Function Documentation

New()

static vtkEvent * vtkEvent::New ( )

static

The object factory constructor.

IsTypeOf()

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

static

Standard macros.

IsA()

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

virtual

Standard macros.

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

Standard macros.

NewInstanceInternal()

virtual vtkObjectBase * vtkEvent::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

NewInstance()

vtkEvent * vtkEvent::NewInstance

(

)

const

Standard macros.

PrintSelf()

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

overridevirtual

Standard macros.

Reimplemented from vtkObjectBase.

SetEventId()

virtual void vtkEvent::SetEventId ( unsigned long  )

virtual

Set the modifier for the event.

GetEventId()

virtual unsigned long vtkEvent::GetEventId ( )

virtual

Set the modifier for the event.

SetModifier()

virtual void vtkEvent::SetModifier ( int  )

virtual

Set the modifier for the event.

GetModifier() [1/2]

virtual int vtkEvent::GetModifier ( )

virtual

Set the modifier for the event.

SetKeyCode()

virtual void vtkEvent::SetKeyCode ( char  )

virtual

Set the KeyCode for the event.

Default is 0.

GetKeyCode()

virtual char vtkEvent::GetKeyCode ( )

virtual

Set the KeyCode for the event.

Default is 0.

SetRepeatCount()

virtual void vtkEvent::SetRepeatCount ( int  )

virtual

Set the repease count for the event.

GetRepeatCount()

virtual int vtkEvent::GetRepeatCount ( )

virtual

Set the repease count for the event.

SetKeySym()

virtual void vtkEvent::SetKeySym ( const char *  )

virtual

Set the complex key symbol (compound key strokes) for the event.

Default is nullptr.

GetKeySym()

virtual char * vtkEvent::GetKeySym ( )

virtual

Set the complex key symbol (compound key strokes) for the event.

Default is nullptr.

GetModifier() [2/2]

static int vtkEvent::GetModifier ( vtkRenderWindowInteractor *  )

static

Convenience method computes the event modifier from an interactor.

operator==() [1/2]

bool vtkEvent::operator==

(

vtkEvent *

)

const

Used to compare whether two events are equal.

Takes into account the EventId as well as the various modifiers.

operator==() [2/2]

bool vtkEvent::operator==

(

unsigned long

VTKEvent

)

const

Member Data Documentation

EventId

unsigned long vtkEvent::EventId

protected

Definition at line 110 of file vtkEvent.h.

Modifier

int vtkEvent::Modifier

protected

Definition at line 111 of file vtkEvent.h.

KeyCode

char vtkEvent::KeyCode

protected

Definition at line 112 of file vtkEvent.h.

RepeatCount

int vtkEvent::RepeatCount

protected

Definition at line 113 of file vtkEvent.h.

KeySym

char* vtkEvent::KeySym

protected

Definition at line 114 of file vtkEvent.h.

---

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

• Interaction/Widgets/vtkEvent.h