Implementation of vtkTDxDevice on Unix. More...

#include <vtkTDxUnixDevice.h>

Inheritance diagram for vtkTDxUnixDevice:

Collaboration diagram for vtkTDxUnixDevice:

Public Types
typedef vtkTDxDevice	Superclass

Public Types inherited from vtkTDxDevice
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...

vtkTDxUnixDevice *	NewInstance () const

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

vtkTDxUnixDeviceDisplay *	GetDisplayId () const
	Get the ID of the X Display. More...

vtkTDxUnixDeviceWindow	GetWindowId () const
	Get the ID of the X Window. More...

void	SetDisplayId (vtkTDxUnixDeviceDisplay *id)
	Set the ID of the X Display. More...

void	SetWindowId (vtkTDxUnixDeviceWindow id)
	Set the ID of the X Window. More...

void	Initialize ()
	Initialize the device with the current display and window ids. More...

virtual void	Close ()
	See description in the superclass. More...

bool	ProcessEvent (const vtkTDxUnixDeviceXEvent *e)
	Translate the X11 event by invoking a VTK event, if the event came from the device. More...

void	SetSensitivity (double sensitivity)
	Set the sensitivity of the device for the current application. More...


virtual double	GetTranslationScale ()
	PROBABLY TRANSFER IT TO THE SUPERCLASS Get/Set Scale factor on the translation motion. More...

virtual void	SetTranslationScale (double)
	PROBABLY TRANSFER IT TO THE SUPERCLASS Get/Set Scale factor on the translation motion. More...


virtual double	GetRotationScale ()
	PROBABLY TRANSFER IT TO THE SUPERCLASS Get/Set Scale factor on the rotation motion. More...

virtual void	SetRotationScale (double)
	PROBABLY TRANSFER IT TO THE SUPERCLASS Get/Set Scale factor on the rotation motion. More...

Public Member Functions inherited from vtkTDxDevice
vtkTDxDevice *	NewInstance () const

bool	GetInitialized () const
	Tell if the device is initialized. 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 vtkTDxUnixDevice *	New ()

static int	IsTypeOf (const char *type)

static vtkTDxUnixDevice *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkTDxDevice
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

	vtkTDxUnixDevice ()
	Default constructor. More...

virtual	~vtkTDxUnixDevice ()
	Destructor. More...

Protected Member Functions inherited from vtkTDxDevice
	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
vtkTDxUnixDeviceDisplay *	DisplayId

vtkTDxUnixDeviceWindow	WindowId

double	TranslationScale

double	RotationScale

Protected Attributes inherited from vtkTDxDevice
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

Implementation of vtkTDxDevice on Unix.

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

See also: vtkTDxDevice, vtkTDxWinDevice

Definition at line 41 of file vtkTDxUnixDevice.h.

Member Typedef Documentation

typedef vtkTDxDevice vtkTDxUnixDevice::Superclass

Definition at line 45 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

static int vtkTDxUnixDevice::IsTypeOf ( const char * type )

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkTDxUnixDevice::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTDxDevice.

vtkTDxUnixDevice* vtkTDxUnixDevice::NewInstance ( ) const

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 146 of file vtkTDxUnixDevice.h.

vtkTDxUnixDeviceWindow vtkTDxUnixDevice::WindowId

protected

Definition at line 147 of file vtkTDxUnixDevice.h.

double vtkTDxUnixDevice::TranslationScale

protected

Definition at line 149 of file vtkTDxUnixDevice.h.

double vtkTDxUnixDevice::RotationScale

protected

Definition at line 150 of file vtkTDxUnixDevice.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkTDxUnixDevice.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