vtkTDxUnixDevice Class Reference

#include <vtkTDxUnixDevice.h>

Inheritance diagram for vtkTDxUnixDevice:

[legend]

Collaboration diagram for vtkTDxUnixDevice:

[legend]

List of all members.

Detailed Description

Implementation of vtkTDxDevice on Unix.

vtkTDxUnixDevice is a concrete implementation of vtkTDxDevice on Unix It uses the Magellan API.

See also:: vtkTDxDevice, vtkTDxWinDevice

Events:: vtkCommand::TDxButtonReleaseEvent vtkCommand::TDxButtonPressEvent vtkCommand::TDxMotionEvent

Definition at line 42 of file vtkTDxUnixDevice.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)
vtkTDxUnixDeviceDisplay *	GetDisplayId () const
vtkTDxUnixDeviceWindow	GetWindowId () const
void	SetDisplayId (vtkTDxUnixDeviceDisplay *id)
void	SetWindowId (vtkTDxUnixDeviceWindow id)
void	Initialize ()
virtual void	Close ()
bool	ProcessEvent (const vtkTDxUnixDeviceXEvent *e)
void	SetSensitivity (double sensitivity)

virtual double	GetTranslationScale ()
virtual void	SetTranslationScale (double)

virtual double	GetRotationScale ()
virtual void	SetRotationScale (double)
Static Public Member Functions
static vtkTDxUnixDevice *	New ()
static int	IsTypeOf (const char *type)
static vtkTDxUnixDevice *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkTDxUnixDevice ()
virtual	~vtkTDxUnixDevice ()
Protected Attributes
vtkTDxUnixDeviceDisplay *	DisplayId
vtkTDxUnixDeviceWindow	WindowId
double	TranslationScale
double	RotationScale

Member Typedef Documentation

typedef vtkTDxDevice vtkTDxUnixDevice::Superclass

Reimplemented from vtkTDxDevice.

Definition at line 46 of file vtkTDxUnixDevice.h.

Constructor & Destructor Documentation

vtkTDxUnixDevice::vtkTDxUnixDevice ( ) [protected]

Default constructor. Just set initial values for DisplayId (0), WindowId (0), TranslationScale (1.0), RotationScale (1.0).

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

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

Member Function Documentation

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

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

Reimplemented from vtkObject.

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

Reimplemented from vtkTDxDevice.

static int vtkTDxUnixDevice::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 vtkTDxUnixDevice::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 vtkTDxUnixDevice* vtkTDxUnixDevice::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkTDxDevice.

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

vtkTDxUnixDeviceDisplay* vtkTDxUnixDevice::GetDisplayId ( ) const

Get the ID of the X Display. Initial value is 0. The return value type is actually a "Display *"

vtkTDxUnixDeviceWindow vtkTDxUnixDevice::GetWindowId ( ) const

Get the ID of the X Window. Initial value is 0. The return value type is actually a "Window"

void vtkTDxUnixDevice::SetDisplayId ( vtkTDxUnixDeviceDisplay * id )

Set the ID of the X Display. The argument type is actually a "Display ".

Precondition:: not_yet_initialized: !GetInitialized()

void vtkTDxUnixDevice::SetWindowId ( vtkTDxUnixDeviceWindow id )

Set the ID of the X Window.

Precondition:: not_yet_initialized: !GetInitialized()

void vtkTDxUnixDevice::Initialize ( )

Initialize the device with the current display and window ids. 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. This interactor does not have to be set before calling Initialize(). However, in order to handle the events the Interactor has to be set otherwise ProcessEvent will be a no-op.

Precondition:

not_yet_initialized: !GetInitialized()

valid_display: GetDisplayId()!=0

valid_window: GetWindowId()!=0

valid_interactor: GetInteractor()!=0

virtual void vtkTDxUnixDevice::Close ( ) [virtual]

See description in the superclass. Implementation for Unix.

Implements vtkTDxDevice.

bool vtkTDxUnixDevice::ProcessEvent ( const vtkTDxUnixDeviceXEvent * e )

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. The interactor has to be set in order to get some events, otherwise they will be ignored.

Precondition:

initialized: GetInitialized()

e_exists: e!=0

e_is_client_message: e->type==ClientMessage

virtual double vtkTDxUnixDevice::GetTranslationScale ( ) [virtual]

PROBABLY TRANSFER IT TO THE SUPERCLASS Get/Set Scale factor on the translation motion. Initial value is 1.0

virtual void vtkTDxUnixDevice::SetTranslationScale ( double ) [virtual]

PROBABLY TRANSFER IT TO THE SUPERCLASS Get/Set Scale factor on the translation motion. Initial value is 1.0

virtual double vtkTDxUnixDevice::GetRotationScale ( ) [virtual]

PROBABLY TRANSFER IT TO THE SUPERCLASS Get/Set Scale factor on the rotation motion. Initial value is 1.0

virtual void vtkTDxUnixDevice::SetRotationScale ( double ) [virtual]

PROBABLY TRANSFER IT TO THE SUPERCLASS Get/Set Scale factor on the rotation motion. Initial value is 1.0