VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTDxUnixDevice Class Reference

Implementation of vtkTDxDevice on Unix. More...

#include <vtkTDxUnixDevice.h>

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

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkTDxUnixDeviceDisplayGetDisplayId () 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)
- Public Member Functions inherited from vtkTDxDevice
bool GetInitialized () const
vtkRenderWindowInteractorGetInteractor () const
void SetInteractor (vtkRenderWindowInteractor *i)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkTDxUnixDeviceNew ()
static int IsTypeOf (const char *type)
static vtkTDxUnixDeviceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTDxUnixDevice ()
virtual ~vtkTDxUnixDevice ()
- Protected Member Functions inherited from vtkTDxDevice
 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkTDxUnixDeviceDisplayDisplayId
vtkTDxUnixDeviceWindow WindowId
double TranslationScale
double RotationScale
- Protected Attributes inherited from vtkTDxDevice
bool Initialized
vtkRenderWindowInteractorInteractor
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.

Member Typedef Documentation

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 ( )
protectedvirtual

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

void vtkTDxUnixDevice::SetSensitivity ( double  sensitivity)

Set the sensitivity of the device for the current application. A neutral value is 1.0.

Precondition
initialized: GetInitialized()

Member Data Documentation

vtkTDxUnixDeviceDisplay* vtkTDxUnixDevice::DisplayId
protected

Definition at line 115 of file vtkTDxUnixDevice.h.

vtkTDxUnixDeviceWindow vtkTDxUnixDevice::WindowId
protected

Definition at line 116 of file vtkTDxUnixDevice.h.

double vtkTDxUnixDevice::TranslationScale
protected

Definition at line 118 of file vtkTDxUnixDevice.h.

double vtkTDxUnixDevice::RotationScale
protected

Definition at line 119 of file vtkTDxUnixDevice.h.


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