vtkTDxWinDevice Class Reference

Implementation of vtkTDxDevice on Windows. More...

#include <vtkTDxWinDevice.h>

Inheritance diagram for vtkTDxWinDevice:

Collaboration diagram for vtkTDxWinDevice:

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...
vtkTDxWinDevice *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
HWND	GetWindowHandle () const
	Get the Handle of the Window. More...
void	SetWindowHandle (HWND hWnd)
	Set the handle of the 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	GetIsListening () const
	Tells if we are listening events on the device. More...
void	StartListening ()
	Call it when the window has or get the focus. More...
void	StopListening ()
	Call it when the window lose the focus. More...
void	ProcessEvent ()
	Process the 3DConnexion event. 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 vtkTDxWinDevice *	New ()
static int	IsTypeOf (const char *type)
static vtkTDxWinDevice *	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
	vtkTDxWinDevice ()
	Default constructor. More...
virtual	~vtkTDxWinDevice ()
	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
HWND	WindowHandle
vtkTDxWinDevicePrivate *	Private
bool	IsListening
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 Windows.

vtkTDxWinDevice is a concrete implementation of vtkTDxDevice on Windows It uses the COM API.

See also

vtkTDxDevice, vtkTDxWinDevice

Definition at line 41 of file vtkTDxWinDevice.h.

Member Typedef Documentation

typedef vtkTDxDevice vtkTDxWinDevice::Superclass

Definition at line 45 of file vtkTDxWinDevice.h.

Constructor & Destructor Documentation

vtkTDxWinDevice::vtkTDxWinDevice ( )

protected

Default constructor.

virtual vtkTDxWinDevice::~vtkTDxWinDevice ( )

protectedvirtual

Destructor.

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

Member Function Documentation

static vtkTDxWinDevice* vtkTDxWinDevice::New ( )

static

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

static

virtual int vtkTDxWinDevice::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 vtkTDxWinDevice* vtkTDxWinDevice::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkTDxWinDevice::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTDxDevice.

vtkTDxWinDevice* vtkTDxWinDevice::NewInstance

(

)

const

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

HWND vtkTDxWinDevice::GetWindowHandle

(

)

const

Get the Handle of the Window.

Initial value is 0.

void vtkTDxWinDevice::SetWindowHandle

(

HWND

hWnd

)

Set the handle of the Window.

Precondition

not_yet_initialized: !GetInitialized()

void vtkTDxWinDevice::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. If the case initialization is successful, GetIsListening() is false.

Precondition

not_yet_initialized: !GetInitialized()

virtual void vtkTDxWinDevice::Close ( )

virtual

See description in the superclass.

Implementation for Windows.

Implements vtkTDxDevice.

bool vtkTDxWinDevice::GetIsListening

(

)

const

Tells if we are listening events on the device.

void vtkTDxWinDevice::StartListening

(

)

Call it when the window has or get the focus.

Precondition

initialized: GetInitialized()

not_yet: !GetIsListening()

void vtkTDxWinDevice::StopListening

(

)

Call it when the window lose the focus.

Precondition

initialized: GetInitialized()

is_listening: GetIsListening()

void vtkTDxWinDevice::ProcessEvent

(

)

Process the 3DConnexion event.

Called internally by the timer.

Member Data Documentation

HWND vtkTDxWinDevice::WindowHandle

protected

Definition at line 112 of file vtkTDxWinDevice.h.

vtkTDxWinDevicePrivate* vtkTDxWinDevice::Private

protected

Definition at line 114 of file vtkTDxWinDevice.h.

bool vtkTDxWinDevice::IsListening

protected

Definition at line 115 of file vtkTDxWinDevice.h.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkTDxWinDevice.h