vtkTDxDevice Class Reference

#include <vtkTDxDevice.h>

Inheritance diagram for vtkTDxDevice:

Inheritance graph
[legend]
Collaboration diagram for vtkTDxDevice:

Collaboration graph
[legend]

List of all members.


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


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
bool GetInitialized () const
virtual void Close ()=0
vtkRenderWindowInteractorGetInteractor () const
void SetInteractor (vtkRenderWindowInteractor *i)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkTDxDeviceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTDxDevice ()
virtual ~vtkTDxDevice ()

Protected Attributes

bool Initialized
vtkRenderWindowInteractorInteractor

Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkTDxMacDevice, vtkTDxUnixDevice, and vtkTDxWinDevice.

Definition at line 38 of file vtkTDxDevice.h.


Constructor & Destructor Documentation

vtkTDxDevice::vtkTDxDevice (  )  [protected]

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

virtual vtkTDxDevice::~vtkTDxDevice (  )  [protected, virtual]

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

virtual const char* vtkTDxDevice::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkTDxMacDevice, vtkTDxUnixDevice, and vtkTDxWinDevice.

static int vtkTDxDevice::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type 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 vtkTDxMacDevice, vtkTDxUnixDevice, and vtkTDxWinDevice.

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 vtkTDxMacDevice, vtkTDxUnixDevice, and vtkTDxWinDevice.

static vtkTDxDevice* vtkTDxDevice::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

Reimplemented in vtkTDxMacDevice, vtkTDxUnixDevice, and vtkTDxWinDevice.

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 vtkTDxMacDevice, vtkTDxUnixDevice, and vtkTDxWinDevice.

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 vtkTDxMacDevice, vtkTDxUnixDevice, and vtkTDxWinDevice.

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.

Precondition:
not_yet_initialized: !GetInitialized()


Member Data Documentation

bool vtkTDxDevice::Initialized [protected]

Definition at line 68 of file vtkTDxDevice.h.

Definition at line 69 of file vtkTDxDevice.h.


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

Generated on Mon Sep 27 18:53:59 2010 for VTK by  doxygen 1.5.6