display configuration container More...

#include <vtkDisplayConfiguration.h>

Inheritance diagram for vtkDisplayConfiguration:

Collaboration diagram for vtkDisplayConfiguration:

[legend]

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...

virtual bool	GetUseOffAxisProjection ()
	Get use of off axis projection. 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 *	GetName (int index) const
	Returns optional name string for the given display index, or nullptr if the Machine element has no Name attribute. More...


const char *	GetEnvironment (int index) const
	Returns environment string for the given display index, or nullptr if the Machine element has no Environment attribute. More...


vtkTuple< int, 4 >	GetGeometry (int index) const
	Returns geometry (screen space size and position) for the given display index. More...


vtkTuple< double, 3 >	GetLowerLeft (int index) const
	Returns positions of screen corners (in physical coordinates) for the given display. More...

vtkTuple< double, 3 >	GetLowerRight (int index) const
	Returns positions of screen corners (in physical coordinates) for the given display. More...

vtkTuple< double, 3 >	GetUpperRight (int index) const
	Returns positions of screen corners (in physical coordinates) for the given display. More...


bool	GetHasCorners (int index) const
	Returns whether given display index has lower left, lower right, and upper right screen corners defined. More...


bool	GetCoverable (int index) const
	Only used on X windows systems. More...


bool	GetShow2DOverlays (int index) const
	Allows user to select which displays show/hide things like scalar bar, annotation, etc. More...


int	GetViewerId (int index) const
	Returns the configured viewer id for the given display index. More...


int	GetStereoType (int index) const
	Returns the stereo type for the given display index. More...


int	GetNumberOfViewers () const
	Returns the number of child elements under the optional IndependentViewers element. More...


int	GetId (int viewerIndex) const
	Returns the Id attribute of the given independent viewer index. More...


double	GetEyeSeparation (int viewerIndex) const
	Returns the EyeSeparation attribute of the given independent viewer index. 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 int	ParseStereoType (const std::string &value)
	Return an integer stereo type corresponding to the given string value, or -1 if the string value is not recognized as a stereo type. More...


static const char *	GetStereoTypeAsString (int stereoType)
	Returns the string representation of the given stereo type. More...

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 21 of file vtkDisplayConfiguration.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkDisplayConfiguration::Superclass

Definition at line 25 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() [1/2]

virtual double vtkDisplayConfiguration::GetEyeSeparation ( )

virtual

Get eye separation.

◆ GetUseOffAxisProjection()

virtual bool vtkDisplayConfiguration::GetUseOffAxisProjection ( )

virtual

Get use of off axis projection.

◆ GetNumberOfDisplays()

int vtkDisplayConfiguration::GetNumberOfDisplays ( ) const

Returns the count for display specified.

◆ GetName()

const char* vtkDisplayConfiguration::GetName ( int index ) const

Returns optional name string for the given display index, or nullptr if the Machine element has no Name attribute.

◆ GetEnvironment()

const char* vtkDisplayConfiguration::GetEnvironment ( int index ) const

Returns environment string for the given display index, or nullptr if the Machine element has no Environment attribute.

◆ GetGeometry()

vtkTuple<int, 4> vtkDisplayConfiguration::GetGeometry ( int index ) const

Returns geometry (screen space size and position) for the given display index.

◆ GetLowerLeft()

vtkTuple<double, 3> vtkDisplayConfiguration::GetLowerLeft ( int index ) const

Returns positions of screen corners (in physical coordinates) for the given display.

◆ GetLowerRight()

vtkTuple<double, 3> vtkDisplayConfiguration::GetLowerRight ( int index ) const

Returns positions of screen corners (in physical coordinates) for the given display.

◆ GetUpperRight()

vtkTuple<double, 3> vtkDisplayConfiguration::GetUpperRight ( int index ) const

Returns positions of screen corners (in physical coordinates) for the given display.

◆ GetHasCorners()

bool vtkDisplayConfiguration::GetHasCorners ( int index ) const

Returns whether given display index has lower left, lower right, and upper right screen corners defined.

◆ GetCoverable()

bool vtkDisplayConfiguration::GetCoverable ( int index ) const

Only used on X windows systems.

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.

◆ GetShow2DOverlays()

bool vtkDisplayConfiguration::GetShow2DOverlays ( int index ) const

Allows user to select which displays show/hide things like scalar bar, annotation, etc.

◆ GetViewerId()

int vtkDisplayConfiguration::GetViewerId ( int index ) const

Returns the configured viewer id for the given display index.

If not configured, all displays are associated with a viewer id of 0 by default.

◆ GetStereoType()

int vtkDisplayConfiguration::GetStereoType ( int index ) const

Returns the stereo type for the given display index.

Returns -1 if no stereo type attribute was present on the element, or if the attribute could not be parsed as one of the understood types

◆ GetNumberOfViewers()

int vtkDisplayConfiguration::GetNumberOfViewers ( ) const

Returns the number of child elements under the optional IndependentViewers element.

If provided, these are used to set default EyeSeparation for each of the independent viewers listed in the Machine elements.

◆ GetId()

int vtkDisplayConfiguration::GetId ( int viewerIndex ) const

Returns the Id attribute of the given independent viewer index.

In order to be used, this should match the ViewerId attribute of one or more Machine elements.

◆ GetEyeSeparation() [2/2]

double vtkDisplayConfiguration::GetEyeSeparation ( int viewerIndex ) const

Returns the EyeSeparation attribute of the given independent viewer index.

In order to be used, there should be a sibling "Id" element that matches the ViewerId attribute of one or more Machine elements.

◆ LoadPVX()

bool vtkDisplayConfiguration::LoadPVX ( const char * fname )

Parses a PVX file to load display configuration information.

◆ ParseStereoType()

static int vtkDisplayConfiguration::ParseStereoType ( const std::string & value )

static

Return an integer stereo type corresponding to the given string value, or -1 if the string value is not recognized as a stereo type.

◆ GetStereoTypeAsString()

static const char* vtkDisplayConfiguration::GetStereoTypeAsString ( int stereoType )

static

Returns the string representation of the given stereo type.

Returns the empty string if no stereo type attribute was present on the element, or if the attribute could not be parsed as one of the understood types.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDisplayConfiguration()

◆ ~vtkDisplayConfiguration()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetShowBorders()

◆ GetFullScreen()

◆ GetEyeSeparation() [1/2]

◆ GetUseOffAxisProjection()

◆ GetNumberOfDisplays()

◆ GetName()

◆ GetEnvironment()

◆ GetGeometry()

◆ GetLowerLeft()

◆ GetLowerRight()

◆ GetUpperRight()

◆ GetHasCorners()

◆ GetCoverable()

◆ GetShow2DOverlays()

◆ GetViewerId()

◆ GetStereoType()

◆ GetNumberOfViewers()

◆ GetId()

◆ GetEyeSeparation() [2/2]

◆ LoadPVX()

◆ ParseStereoType()

◆ GetStereoTypeAsString()