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

#include <vtkTDxDevice.h>

Inheritance diagram for vtkTDxDevice:

Collaboration diagram for vtkTDxDevice:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkTDxDevice *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

bool	GetInitialized () const
	Tell if the device is initialized. More...

virtual void	Close ()=0
	Close the device. More...

vtkRenderWindowInteractor *	GetInteractor () const
	Get the interactor on which events will be invoked. More...

void	SetInteractor (vtkRenderWindowInteractor *i)
	Set the interactor on which events will be invoked. More...

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

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkTDxDevice *	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

	vtkTDxDevice ()
	Default constructor. More...

virtual	~vtkTDxDevice ()
	Destructor. More...

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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 37 of file vtkTDxDevice.h.

Member Typedef Documentation

typedef vtkObject vtkTDxDevice::Superclass

Definition at line 40 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 vtkObjectBase.

Reimplemented in vtkTDxUnixDevice, vtkTDxWinDevice, and vtkTDxMacDevice.

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

static

virtual vtkObjectBase* vtkTDxDevice::NewInstanceInternal ( ) const

protectedvirtual

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 85 of file vtkTDxDevice.h.

vtkRenderWindowInteractor* vtkTDxDevice::Interactor

protected

Definition at line 86 of file vtkTDxDevice.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkTDxDevice.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation