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

API to access a 3DConnexion input device. More...

#include <vtkTDxDevice.h>

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

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTDxDevice * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
bool GetInitialized () const
 
virtual void Close ()=0
 
vtkRenderWindowInteractor * GetInteractor () const
 
void SetInteractor (vtkRenderWindowInteractor *i)
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkTDxDevice * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkTDxDevice ()
 
virtual ~vtkTDxDevice ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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
 
vtkRenderWindowInteractor * Interactor
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

API to access a 3DConnexion input device.

vtkTDxDevice is an abstract class providing access to a 3DConnexion input device, such as the SpaceNavigator.

Concrete classes are platform-dependent

See also
vtkTDxUnixDevice, vtkTDxWinDevice
Warning
THIS IS EXPERIMENTAL CODE. THE API MIGHT CHANGE.

Definition at line 36 of file vtkTDxDevice.h.

Member Typedef Documentation

typedef vtkObject vtkTDxDevice::Superclass

Definition at line 39 of file vtkTDxDevice.h.

Constructor & Destructor Documentation

vtkTDxDevice::vtkTDxDevice ( )
protected

Default constructor. Just set initial values for Initialized (false).

virtual vtkTDxDevice::~vtkTDxDevice ( )
protectedvirtual

Destructor. If the device is not initialized, do nothing. If the device is initialized, close the device. This behavior has to be implemented in subclasses.

Member Function Documentation

static int vtkTDxDevice::IsTypeOf ( const char *  type)
static
virtual int vtkTDxDevice::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 vtkObject.

Reimplemented in vtkTDxUnixDevice, vtkTDxWinDevice, and vtkTDxMacDevice.

static vtkTDxDevice* vtkTDxDevice::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkTDxDevice::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkTDxUnixDevice, vtkTDxWinDevice, and vtkTDxMacDevice.

vtkTDxDevice* vtkTDxDevice::NewInstance ( ) const
void vtkTDxDevice::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

Reimplemented in vtkTDxUnixDevice, vtkTDxWinDevice, and vtkTDxMacDevice.

bool vtkTDxDevice::GetInitialized ( ) const

Tell if the device is initialized. Initial value is false.

virtual void vtkTDxDevice::Close ( )
pure virtual

Close the device. This is called by the destructor. You don't have to close the device explicitly, as the destructor do it automatically, but you can.

Precondition
initialized: GetInitialized().
Postcondition
restored: !GetInitialized()

Implemented in vtkTDxUnixDevice, vtkTDxWinDevice, and vtkTDxMacDevice.

vtkRenderWindowInteractor* vtkTDxDevice::GetInteractor ( ) const

Get the interactor on which events will be invoked. Initial value is 0. Called by the Interactor itself ONLY.

void vtkTDxDevice::SetInteractor ( vtkRenderWindowInteractor *  i)

Set the interactor on which events will be invoked. Initial value is 0. Called by the Interactor itself ONLY. It can be called if the device is initialized or not.

Member Data Documentation

bool vtkTDxDevice::Initialized
protected

Definition at line 69 of file vtkTDxDevice.h.

vtkRenderWindowInteractor* vtkTDxDevice::Interactor
protected

Definition at line 70 of file vtkTDxDevice.h.

The documentation for this class was generated from the following file:
Generated on Wed Dec 16 2015 17:20:16 for VTK by   doxygen 1.8.9.1