Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWebInteractionEvent Class Reference

#include <vtkWebInteractionEvent.h>

Inheritance diagram for vtkWebInteractionEvent:
Collaboration diagram for vtkWebInteractionEvent:

Public Types

enum  MouseButton { LEFT_BUTTON = 0x01, MIDDLE_BUTTON = 0x02, RIGHT_BUTTON = 0x04 }
enum  ModifierKeys { SHIFT_KEY = 0x01, CTRL_KEY = 0x02, ALT_KEY = 0x04, META_KEY = 0x08 }
typedef vtkObject Superclass

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...
vtkWebInteractionEventNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
virtual void SetButtons (unsigned int)
 Set/Get the mouse buttons state. More...
virtual unsigned int GetButtons ()
virtual void SetModifiers (unsigned int)
 Set/Get modifier state. More...
virtual unsigned int GetModifiers ()
virtual void SetKeyCode (char)
 Set/Get the chart code. More...
virtual char GetKeyCode ()
virtual void SetX (double)
 Set/Get event position. More...
virtual double GetX ()
virtual void SetY (double)
virtual double GetY ()
virtual void SetScroll (double)
virtual double GetScroll ()
virtual void SetRepeatCount (int)
virtual int GetRepeatCount ()
- 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)
vtkCommandGetCommand (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 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 vtkWebInteractionEventNew ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkWebInteractionEventSafeDownCast (vtkObjectBase *o)
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkWebInteractionEvent ()
 ~vtkWebInteractionEvent () 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

unsigned int Buttons
unsigned int Modifiers
char KeyCode
double X
double Y
double Scroll
int RepeatCount
- Protected Attributes inherited from vtkObject
bool Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

Definition at line 27 of file vtkWebInteractionEvent.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkWebInteractionEvent.h.

Member Enumeration Documentation

◆ MouseButton


Definition at line 34 of file vtkWebInteractionEvent.h.

◆ ModifierKeys


Definition at line 41 of file vtkWebInteractionEvent.h.

Constructor & Destructor Documentation

◆ vtkWebInteractionEvent()

vtkWebInteractionEvent::vtkWebInteractionEvent ( )

◆ ~vtkWebInteractionEvent()

vtkWebInteractionEvent::~vtkWebInteractionEvent ( )

Member Function Documentation

◆ New()

static vtkWebInteractionEvent* vtkWebInteractionEvent::New ( )

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkWebInteractionEvent::IsA ( const char *  name)

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.

◆ SafeDownCast()

static vtkWebInteractionEvent* vtkWebInteractionEvent::SafeDownCast ( vtkObjectBase o)

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWebInteractionEvent::NewInstanceInternal ( ) const

◆ NewInstance()

vtkWebInteractionEvent* vtkWebInteractionEvent::NewInstance ( ) const

◆ PrintSelf()

void vtkWebInteractionEvent::PrintSelf ( ostream &  os,
vtkIndent  indent 

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.

◆ SetButtons()

virtual void vtkWebInteractionEvent::SetButtons ( unsigned int  )

Set/Get the mouse buttons state.

◆ GetButtons()

virtual unsigned int vtkWebInteractionEvent::GetButtons ( )

◆ SetModifiers()

virtual void vtkWebInteractionEvent::SetModifiers ( unsigned int  )

Set/Get modifier state.

◆ GetModifiers()

virtual unsigned int vtkWebInteractionEvent::GetModifiers ( )

◆ SetKeyCode()

virtual void vtkWebInteractionEvent::SetKeyCode ( char  )

Set/Get the chart code.

◆ GetKeyCode()

virtual char vtkWebInteractionEvent::GetKeyCode ( )

◆ SetX()

virtual void vtkWebInteractionEvent::SetX ( double  )

Set/Get event position.

◆ GetX()

virtual double vtkWebInteractionEvent::GetX ( )

◆ SetY()

virtual void vtkWebInteractionEvent::SetY ( double  )

◆ GetY()

virtual double vtkWebInteractionEvent::GetY ( )

◆ SetScroll()

virtual void vtkWebInteractionEvent::SetScroll ( double  )

◆ GetScroll()

virtual double vtkWebInteractionEvent::GetScroll ( )

◆ SetRepeatCount()

virtual void vtkWebInteractionEvent::SetRepeatCount ( int  )

◆ GetRepeatCount()

virtual int vtkWebInteractionEvent::GetRepeatCount ( )

Member Data Documentation

◆ Buttons

unsigned int vtkWebInteractionEvent::Buttons

Definition at line 93 of file vtkWebInteractionEvent.h.

◆ Modifiers

unsigned int vtkWebInteractionEvent::Modifiers

Definition at line 94 of file vtkWebInteractionEvent.h.

◆ KeyCode

char vtkWebInteractionEvent::KeyCode

Definition at line 95 of file vtkWebInteractionEvent.h.

◆ X

double vtkWebInteractionEvent::X

Definition at line 96 of file vtkWebInteractionEvent.h.

◆ Y

double vtkWebInteractionEvent::Y

Definition at line 97 of file vtkWebInteractionEvent.h.

◆ Scroll

double vtkWebInteractionEvent::Scroll

Definition at line 98 of file vtkWebInteractionEvent.h.

◆ RepeatCount

int vtkWebInteractionEvent::RepeatCount

Definition at line 99 of file vtkWebInteractionEvent.h.

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