vtkDisplayConfiguration Class Reference

display configuration container More...

#include <vtkDisplayConfiguration.h>

Inheritance diagram for vtkDisplayConfiguration:

Collaboration diagram for vtkDisplayConfiguration:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual bool	GetShowBorders ()
	Get whether to use window borders / frames are to be shown. More...
virtual bool	GetFullScreen ()
	Returns true of each display should simply be full-screen. More...
virtual double	GetEyeSeparation ()
	Get eye separation. More...
int	GetNumberOfDisplays () const
	Returns the count for display specified. More...
bool	LoadPVX (const char *fname)
	Parses a PVX file to load display configuration information. More...
const char *	GetEnvironment (int index) const
	Returns information about each display specified. More...
vtkTuple< int, 4 >	GetGeometry (int index) const
	Returns information about each display specified. More...
vtkTuple< double, 3 >	GetLowerLeft (int index) const
	Returns information about each display specified. More...
vtkTuple< double, 3 >	GetLowerRight (int index) const
	Returns information about each display specified. More...
vtkTuple< double, 3 >	GetUpperRight (int index) const
	Returns information about each display specified. More...
bool	GetHasCorners (int index) const
	Returns information about each display specified. More...
bool	GetCoverable (int index) const
	Returns information about each display specified. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual vtkMTimeType	GetMTime ()
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)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (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 *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (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 *)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
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)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkDisplayConfiguration *	New ()
static int	IsTypeOf (const char *type)
static vtkDisplayConfiguration *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkDisplayConfiguration ()
	~vtkDisplayConfiguration () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

display configuration container

vtkDisplayConfiguration is a container used by vtkRemotingCoreConfiguration to manage display configurations which are needed for CAVE and other immersive displays.

Definition at line 20 of file vtkDisplayConfiguration.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkDisplayConfiguration::Superclass

Definition at line 24 of file vtkDisplayConfiguration.h.

Constructor & Destructor Documentation

vtkDisplayConfiguration()

vtkDisplayConfiguration::vtkDisplayConfiguration ( )

protected

~vtkDisplayConfiguration()

vtkDisplayConfiguration::~vtkDisplayConfiguration ( )

overrideprotected

Member Function Documentation

New()

static vtkDisplayConfiguration* vtkDisplayConfiguration::New ( )

static

GetClassName()

virtual const char* vtkDisplayConfiguration::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

virtual int vtkDisplayConfiguration::IsA ( const char *  type )

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

static vtkDisplayConfiguration* vtkDisplayConfiguration::SafeDownCast ( vtkObject *  o )

static

PrintSelf()

void vtkDisplayConfiguration::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Reimplemented from vtkObject.

GetShowBorders()

virtual bool vtkDisplayConfiguration::GetShowBorders ( )

virtual

Get whether to use window borders / frames are to be shown.

GetFullScreen()

virtual bool vtkDisplayConfiguration::GetFullScreen ( )

virtual

Returns true of each display should simply be full-screen.

If so, display geometry is ignored.

GetEyeSeparation()

virtual double vtkDisplayConfiguration::GetEyeSeparation ( )

virtual

Get eye separation.

GetNumberOfDisplays()

int vtkDisplayConfiguration::GetNumberOfDisplays

(

)

const

Returns the count for display specified.

GetEnvironment()

const char* vtkDisplayConfiguration::GetEnvironment

(

int

index

)

const

Returns information about each display specified.

The Coverable field is only used on X windows systems, and indicates that the window should be manageable by the window manager. This means it can be covered by other windows, and a taskbar item is available to bring it back to the front.

GetGeometry()

vtkTuple<int, 4> vtkDisplayConfiguration::GetGeometry

(

int

index

)

const

Returns information about each display specified.

The Coverable field is only used on X windows systems, and indicates that the window should be manageable by the window manager. This means it can be covered by other windows, and a taskbar item is available to bring it back to the front.

GetLowerLeft()

vtkTuple<double, 3> vtkDisplayConfiguration::GetLowerLeft

(

int

index

)

const

Returns information about each display specified.

The Coverable field is only used on X windows systems, and indicates that the window should be manageable by the window manager. This means it can be covered by other windows, and a taskbar item is available to bring it back to the front.

GetLowerRight()

vtkTuple<double, 3> vtkDisplayConfiguration::GetLowerRight

(

int

index

)

const

Returns information about each display specified.

The Coverable field is only used on X windows systems, and indicates that the window should be manageable by the window manager. This means it can be covered by other windows, and a taskbar item is available to bring it back to the front.

GetUpperRight()

vtkTuple<double, 3> vtkDisplayConfiguration::GetUpperRight

(

int

index

)

const

Returns information about each display specified.

The Coverable field is only used on X windows systems, and indicates that the window should be manageable by the window manager. This means it can be covered by other windows, and a taskbar item is available to bring it back to the front.

GetHasCorners()

bool vtkDisplayConfiguration::GetHasCorners

(

int

index

)

const

Returns information about each display specified.

The Coverable field is only used on X windows systems, and indicates that the window should be manageable by the window manager. This means it can be covered by other windows, and a taskbar item is available to bring it back to the front.

GetCoverable()

bool vtkDisplayConfiguration::GetCoverable

(

int

index

)

const

Returns information about each display specified.

The Coverable field is only used on X windows systems, and indicates that the window should be manageable by the window manager. This means it can be covered by other windows, and a taskbar item is available to bring it back to the front.

LoadPVX()

bool vtkDisplayConfiguration::LoadPVX

(

const char *

fname

)

Parses a PVX file to load display configuration information.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkDisplayConfiguration.h