VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractInteractionDevice Class Referenceabstract

#include <vtkAbstractInteractionDevice.h>

Inheritance diagram for vtkAbstractInteractionDevice:
[legend]
Collaboration diagram for vtkAbstractInteractionDevice:
[legend]

Public Types

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...
 
vtkAbstractInteractionDeviceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Initialize ()=0
 Initialize the interaction device. More...
 
virtual void Start ()=0
 Start the event loop. More...
 
virtual void ProcessEvents ()=0
 Process any pending events, this can be used to process OS level events without running a full event loop. More...
 
void SetRenderWidget (vtkRenderWidget *widget)
 
vtkRenderWidgetGetRenderWidget ()
 
void SetRenderDevice (vtkAbstractRenderDevice *device)
 
vtkAbstractRenderDeviceGetRenderDevice ()
 
- 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractInteractionDeviceSafeDownCast (vtkObjectBase *o)
 
static vtkAbstractInteractionDeviceNew ()
 Make a new device, this class is abstract and one of its derived forms will be returned, or NULL if no override has been provided. More...
 
- 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
 
 vtkAbstractInteractionDevice ()
 
 ~vtkAbstractInteractionDevice () 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

bool Initialized
 
vtkRenderWidgetRenderWidget
 
vtkAbstractRenderDeviceRenderDevice
 
- 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 23 of file vtkAbstractInteractionDevice.h.

Member Typedef Documentation

◆ Superclass

Definition at line 26 of file vtkAbstractInteractionDevice.h.

Constructor & Destructor Documentation

◆ vtkAbstractInteractionDevice()

vtkAbstractInteractionDevice::vtkAbstractInteractionDevice ( )
protected

◆ ~vtkAbstractInteractionDevice()

vtkAbstractInteractionDevice::~vtkAbstractInteractionDevice ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAbstractInteractionDevice::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 vtkAbstractInteractionDevice* vtkAbstractInteractionDevice::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractInteractionDevice::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAbstractInteractionDevice* vtkAbstractInteractionDevice::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractInteractionDevice::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.

◆ New()

static vtkAbstractInteractionDevice* vtkAbstractInteractionDevice::New ( )
static

Make a new device, this class is abstract and one of its derived forms will be returned, or NULL if no override has been provided.

Returns
A derived interaction device, or NULL if no suitable override is set.

◆ Initialize()

virtual void vtkAbstractInteractionDevice::Initialize ( )
pure virtual

Initialize the interaction device.

◆ Start()

virtual void vtkAbstractInteractionDevice::Start ( )
pure virtual

Start the event loop.

◆ ProcessEvents()

virtual void vtkAbstractInteractionDevice::ProcessEvents ( )
pure virtual

Process any pending events, this can be used to process OS level events without running a full event loop.

◆ SetRenderWidget()

void vtkAbstractInteractionDevice::SetRenderWidget ( vtkRenderWidget widget)

◆ GetRenderWidget()

vtkRenderWidget* vtkAbstractInteractionDevice::GetRenderWidget ( )
inline

Definition at line 53 of file vtkAbstractInteractionDevice.h.

◆ SetRenderDevice()

void vtkAbstractInteractionDevice::SetRenderDevice ( vtkAbstractRenderDevice device)

◆ GetRenderDevice()

vtkAbstractRenderDevice* vtkAbstractInteractionDevice::GetRenderDevice ( )
inline

Definition at line 55 of file vtkAbstractInteractionDevice.h.

Member Data Documentation

◆ Initialized

bool vtkAbstractInteractionDevice::Initialized
protected

Definition at line 61 of file vtkAbstractInteractionDevice.h.

◆ RenderWidget

vtkRenderWidget* vtkAbstractInteractionDevice::RenderWidget
protected

Definition at line 62 of file vtkAbstractInteractionDevice.h.

◆ RenderDevice

vtkAbstractRenderDevice* vtkAbstractInteractionDevice::RenderDevice
protected

Definition at line 63 of file vtkAbstractInteractionDevice.h.


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