vtkTDxMacDevice Class Reference

#include <vtkTDxMacDevice.h>

Inheritance diagram for vtkTDxMacDevice:

Inheritance graph
[legend]
Collaboration diagram for vtkTDxMacDevice:

Collaboration graph
[legend]

List of all members.


Detailed Description

Implementation of vtkTDxDevice on Mac.

vtkTDxMacDevice is a concrete implementation of vtkTDxDevice on Mac It uses the 3DxMacWare SDK.

See also:
vtkTDxDevice, vtkTDxUnixDevice, vtkTDxWinDevice
Events:
vtkCommand::TDxButtonReleaseEvent vtkCommand::TDxButtonPressEvent vtkCommand::TDxMotionEvent

Definition at line 35 of file vtkTDxMacDevice.h.


Public Types

typedef vtkTDxDevice Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Initialize ()
virtual void Close ()
void ProcessEvent (const ConnexionDeviceState *s)
virtual char * GetClientApplicationName ()
virtual void SetClientApplicationName (const char *)

Static Public Member Functions

static vtkTDxMacDeviceNew ()
static int IsTypeOf (const char *type)
static vtkTDxMacDeviceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTDxMacDevice ()
virtual ~vtkTDxMacDevice ()
unsigned char * CStringToPascalString (const char *s)

Protected Attributes

char * ClientApplicationName
UInt16 ClientID
UInt16 LastButtonState

Member Typedef Documentation

Reimplemented from vtkTDxDevice.

Definition at line 39 of file vtkTDxMacDevice.h.


Constructor & Destructor Documentation

vtkTDxMacDevice::vtkTDxMacDevice (  )  [protected]

Default constructor. Just set initial values for ClientApplicationName ("3DxClientTest").

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

Destructor. If the device is not initialized, do nothing. If the device is initialized, close the device.


Member Function Documentation

static vtkTDxMacDevice* vtkTDxMacDevice::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

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

Reimplemented from vtkTDxDevice.

static int vtkTDxMacDevice::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 vtkTDxDevice.

virtual int vtkTDxMacDevice::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 vtkTDxDevice.

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

Reimplemented from vtkTDxDevice.

void vtkTDxMacDevice::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 vtkTDxDevice.

virtual char* vtkTDxMacDevice::GetClientApplicationName (  )  [virtual]

Name of the client application to pass for registration with the driver. Initial value is "\p3DxClientTest".

virtual void vtkTDxMacDevice::SetClientApplicationName ( const char *   )  [virtual]

Name of the client application to pass for registration with the driver. Initial value is "\p3DxClientTest".

void vtkTDxMacDevice::Initialize (  ) 

Initialize the device with the current ClientApplicationName. It updates the value of GetInitialized(). Initialization can fail (if the device is not present or the driver is not running). You must look for the value of GetInitialized() before processing further.

Precondition:
not_yet_initialized: !GetInitialized()

valid_name: GetClientApplicationName()!=0

virtual void vtkTDxMacDevice::Close (  )  [virtual]

See description in the superclass. Implementation for Mac.

Implements vtkTDxDevice.

void vtkTDxMacDevice::ProcessEvent ( const ConnexionDeviceState *  s  ) 

Translate the X11 event by invoking a VTK event, if the event came from the device. Return true if the event passed in argument was effectively an event from the device, return false otherwise.

Precondition:
initialized: GetInitialized()

s_exists: s!=0

client_matches: s->client==this->ClientID

unsigned char* vtkTDxMacDevice::CStringToPascalString ( const char *  s  )  [protected]

Convert a C string to a Pascal String. Allocation happens with new[]. It is the responsability of the user to call delete[]. Apple specific. String literal starting with are pascal strings: it is an unsigned char array starting with the length and terminated by . The length does not include the length value neither the . Pascal strings literal are allowed with apple specific gcc option -fpascal-strings. Pascal literal are writable is -fwritable-strings is set. -Wwrite-strings is a related warning flag.

Precondition:
s_exists: s!=0

s_small_enough: strlen(s)<=255

Postcondition:
result_exists: result!=0


Member Data Documentation

Definition at line 88 of file vtkTDxMacDevice.h.

UInt16 vtkTDxMacDevice::ClientID [protected]

Definition at line 90 of file vtkTDxMacDevice.h.

Definition at line 91 of file vtkTDxMacDevice.h.


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

Generated on Wed Aug 24 12:11:06 2011 for VTK by  doxygen 1.5.6