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

vtkWebInteractionEvent *	NewInstance () 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)

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 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 vtkWebInteractionEvent *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkWebInteractionEvent *	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 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

	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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Definition at line 27 of file vtkWebInteractionEvent.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkWebInteractionEvent::Superclass

Definition at line 31 of file vtkWebInteractionEvent.h.

Member Enumeration Documentation

◆ MouseButton

enum vtkWebInteractionEvent::MouseButton

Enumerator
LEFT_BUTTON
MIDDLE_BUTTON
RIGHT_BUTTON

Definition at line 34 of file vtkWebInteractionEvent.h.

◆ ModifierKeys

enum vtkWebInteractionEvent::ModifierKeys

Enumerator
SHIFT_KEY
CTRL_KEY
ALT_KEY
META_KEY

Definition at line 41 of file vtkWebInteractionEvent.h.

Constructor & Destructor Documentation

◆ vtkWebInteractionEvent()

vtkWebInteractionEvent::vtkWebInteractionEvent ( )

protected

◆ ~vtkWebInteractionEvent()

vtkWebInteractionEvent::~vtkWebInteractionEvent ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkWebInteractionEvent* vtkWebInteractionEvent::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWebInteractionEvent::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkWebInteractionEvent* vtkWebInteractionEvent::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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 )

virtual

Set/Get the mouse buttons state.

◆ GetButtons()

virtual unsigned int vtkWebInteractionEvent::GetButtons ( )

virtual

◆ SetModifiers()

virtual void vtkWebInteractionEvent::SetModifiers ( unsigned int )

virtual

Set/Get modifier state.

◆ GetModifiers()

virtual unsigned int vtkWebInteractionEvent::GetModifiers ( )

virtual

◆ SetKeyCode()

virtual void vtkWebInteractionEvent::SetKeyCode ( char )

virtual

Set/Get the chart code.

◆ GetKeyCode()

virtual char vtkWebInteractionEvent::GetKeyCode ( )

virtual

◆ SetX()

virtual void vtkWebInteractionEvent::SetX ( double )

virtual

Set/Get event position.

◆ GetX()

virtual double vtkWebInteractionEvent::GetX ( )

virtual

◆ SetY()

virtual void vtkWebInteractionEvent::SetY ( double )

virtual

◆ GetY()

virtual double vtkWebInteractionEvent::GetY ( )

virtual

◆ SetScroll()

virtual void vtkWebInteractionEvent::SetScroll ( double )

virtual

◆ GetScroll()

virtual double vtkWebInteractionEvent::GetScroll ( )

virtual

◆ SetRepeatCount()

virtual void vtkWebInteractionEvent::SetRepeatCount ( int )

virtual

◆ GetRepeatCount()

virtual int vtkWebInteractionEvent::GetRepeatCount ( )

virtual

Member Data Documentation

◆ Buttons

unsigned int vtkWebInteractionEvent::Buttons

protected

Definition at line 93 of file vtkWebInteractionEvent.h.

◆ Modifiers

unsigned int vtkWebInteractionEvent::Modifiers

protected

Definition at line 94 of file vtkWebInteractionEvent.h.

◆ KeyCode

char vtkWebInteractionEvent::KeyCode

protected

Definition at line 95 of file vtkWebInteractionEvent.h.

◆ X

double vtkWebInteractionEvent::X

protected

Definition at line 96 of file vtkWebInteractionEvent.h.

◆ Y

double vtkWebInteractionEvent::Y

protected

Definition at line 97 of file vtkWebInteractionEvent.h.

◆ Scroll

double vtkWebInteractionEvent::Scroll

protected

Definition at line 98 of file vtkWebInteractionEvent.h.

◆ RepeatCount

int vtkWebInteractionEvent::RepeatCount

protected

Definition at line 99 of file vtkWebInteractionEvent.h.

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

dox/Web/Core/vtkWebInteractionEvent.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ MouseButton

◆ ModifierKeys

Constructor & Destructor Documentation

◆ vtkWebInteractionEvent()

◆ ~vtkWebInteractionEvent()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetButtons()

◆ GetButtons()

◆ SetModifiers()

◆ GetModifiers()

◆ SetKeyCode()

◆ GetKeyCode()

◆ SetX()

◆ GetX()

◆ SetY()

◆ GetY()

◆ SetScroll()

◆ GetScroll()

◆ SetRepeatCount()

◆ GetRepeatCount()

Member Data Documentation

◆ Buttons

◆ Modifiers

◆ KeyCode

◆ X

◆ Y

◆ Scroll

◆ RepeatCount