A vtkClientServerStream serializable container intended to expose the api and information presented by vtkDisplayConfiguration. More...

#include <vtkPVCAVEConfigInformation.h>

Inheritance diagram for vtkPVCAVEConfigInformation:

[legend]

Collaboration diagram for vtkPVCAVEConfigInformation:

[legend]

Public Types
typedef vtkPVInformation	Superclass

Public Types inherited from vtkPVInformation
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	CopyFromObject (vtkObject *) override
	Transfer information about a single object into this object. More...

void	AddInformation (vtkPVInformation *) override
	Merge another information object. More...

virtual bool	GetUseOffAxisProjection ()
	Return the use of off axis projection. More...


void	CopyToStream (vtkClientServerStream *) override
	Manage a serialized version of the information. More...

void	CopyFromStream (const vtkClientServerStream *) override
	Manage a serialized version of the information. More...


virtual bool	GetIsInCAVE ()
	Return the whether the system is in CAVE mode. More...


virtual double	GetEyeSeparation ()
	Return the eye separation. More...


virtual int	GetNumberOfDisplays ()
	Return the number of displays. More...


virtual bool	GetShowBorders ()
	Return whether or not borders are shown. More...


virtual bool	GetFullScreen ()
	Return whether or not displays are fullscreen. More...


virtual const char *	GetName (int index)
	Return the (optional) name of the indexed display, or nullptr if none was set. More...

virtual bool	GetShow2DOverlays (int index)
	Return whether or not the indexed display was configured to show 2D overlays. More...


virtual vtkTuple< int, 4 >	GetGeometry (int index)
	Return the geometry of the indexed display. More...


virtual bool	GetHasCorners (int index)
	Return whether or not the indexed display has screen corners. More...


virtual vtkTuple< double, 3 >	GetLowerLeft (int index)
	Return the lower left corner of the indexed display. More...


virtual vtkTuple< double, 3 >	GetLowerRight (int index)
	Return the lower right corner of the indexed display. More...


virtual vtkTuple< double, 3 >	GetUpperRight (int index)
	Return the upper right corner of the indexed display. More...


virtual bool	GetStereoEnabled (int index)
	Return whether or not the indexed display has stereo enabled. More...


virtual int	GetStereoType (int index)
	Return configured stereo type for the indexed display. More...


int	GetViewerId (int index)
	Return the viewer id of the given display index, or -1 if none was set. More...


int	GetNumberOfViewers ()
	Return the number of configured independent viewers. More...


int	GetId (int viewerIndex)
	Return the id attribute of the indexed independent viewer. More...


double	GetEyeSeparation (int viewerIndex)
	Return the eye separation attribute of the indexed independent viewer. More...

Public Member Functions inherited from vtkPVInformation
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	CopyParametersToStream (vtkMultiProcessStream &)
	Serialize/Deserialize the parameters that control how/what information is gathered. More...

virtual void	CopyParametersFromStream (vtkMultiProcessStream &)
	Serialize/Deserialize the parameters that control how/what information is gathered. More...

virtual int	GetRootOnly ()
	Set/get whether to gather information only from the root. 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 vtkPVCAVEConfigInformation *	New ()

static int	IsTypeOf (const char *type)

static vtkPVCAVEConfigInformation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPVInformation
static int	IsTypeOf (const char *type)

static vtkPVInformation *	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
	vtkPVCAVEConfigInformation ()

	~vtkPVCAVEConfigInformation () override

Protected Member Functions inherited from vtkPVInformation
	vtkPVInformation ()

	~vtkPVInformation () override

virtual void	SetRootOnly (int)

	vtkPVInformation (const vtkPVInformation &)=delete

void	operator= (const vtkPVInformation &)=delete

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 vtkPVInformation
int	RootOnly

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

A vtkClientServerStream serializable container intended to expose the api and information presented by vtkDisplayConfiguration.

The same pvx file is read on all server processes, so merging info from other servers is simply a matter of overwriting the current state with the one read from the stream or other object.

Definition at line 23 of file vtkPVCAVEConfigInformation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVInformation vtkPVCAVEConfigInformation::Superclass

Definition at line 27 of file vtkPVCAVEConfigInformation.h.

Constructor & Destructor Documentation

◆ vtkPVCAVEConfigInformation()

vtkPVCAVEConfigInformation::vtkPVCAVEConfigInformation ( )

protected

◆ ~vtkPVCAVEConfigInformation()

vtkPVCAVEConfigInformation::~vtkPVCAVEConfigInformation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVCAVEConfigInformation* vtkPVCAVEConfigInformation::New ( )

static

◆ GetClassName()

virtual const char* vtkPVCAVEConfigInformation::GetClassName ( )

virtual

Reimplemented from vtkPVInformation.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPVInformation.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ CopyFromObject()

void vtkPVCAVEConfigInformation::CopyFromObject ( vtkObject * )

overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

◆ AddInformation()

void vtkPVCAVEConfigInformation::AddInformation ( vtkPVInformation * )

overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

◆ CopyToStream()

void vtkPVCAVEConfigInformation::CopyToStream ( vtkClientServerStream * )

overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVCAVEConfigInformation::CopyFromStream ( const vtkClientServerStream * )

overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ GetIsInCAVE()

virtual bool vtkPVCAVEConfigInformation::GetIsInCAVE ( )

virtual

Return the whether the system is in CAVE mode.

◆ GetEyeSeparation() [1/2]

virtual double vtkPVCAVEConfigInformation::GetEyeSeparation ( )

virtual

Return the eye separation.

◆ GetUseOffAxisProjection()

virtual bool vtkPVCAVEConfigInformation::GetUseOffAxisProjection ( )

virtual

Return the use of off axis projection.

◆ GetNumberOfDisplays()

virtual int vtkPVCAVEConfigInformation::GetNumberOfDisplays ( )

virtual

Return the number of displays.

◆ GetShowBorders()

virtual bool vtkPVCAVEConfigInformation::GetShowBorders ( )

virtual

Return whether or not borders are shown.

◆ GetFullScreen()

virtual bool vtkPVCAVEConfigInformation::GetFullScreen ( )

virtual

Return whether or not displays are fullscreen.

◆ GetName()

virtual const char* vtkPVCAVEConfigInformation::GetName ( int index )

virtual

Return the (optional) name of the indexed display, or nullptr if none was set.

◆ GetShow2DOverlays()

virtual bool vtkPVCAVEConfigInformation::GetShow2DOverlays ( int index )

virtual

Return whether or not the indexed display was configured to show 2D overlays.

◆ GetGeometry()

virtual vtkTuple<int, 4> vtkPVCAVEConfigInformation::GetGeometry ( int index )

virtual

Return the geometry of the indexed display.

◆ GetHasCorners()

virtual bool vtkPVCAVEConfigInformation::GetHasCorners ( int index )

virtual

Return whether or not the indexed display has screen corners.

◆ GetLowerLeft()

virtual vtkTuple<double, 3> vtkPVCAVEConfigInformation::GetLowerLeft ( int index )

virtual

Return the lower left corner of the indexed display.

◆ GetLowerRight()

virtual vtkTuple<double, 3> vtkPVCAVEConfigInformation::GetLowerRight ( int index )

virtual

Return the lower right corner of the indexed display.

◆ GetUpperRight()

virtual vtkTuple<double, 3> vtkPVCAVEConfigInformation::GetUpperRight ( int index )

virtual

Return the upper right corner of the indexed display.

◆ GetStereoEnabled()

virtual bool vtkPVCAVEConfigInformation::GetStereoEnabled ( int index )

virtual

Return whether or not the indexed display has stereo enabled.

◆ GetStereoType()

virtual int vtkPVCAVEConfigInformation::GetStereoType ( int index )

virtual

Return configured stereo type for the indexed display.

◆ GetViewerId()

int vtkPVCAVEConfigInformation::GetViewerId ( int index )

Return the viewer id of the given display index, or -1 if none was set.

◆ GetNumberOfViewers()

int vtkPVCAVEConfigInformation::GetNumberOfViewers ( )

Return the number of configured independent viewers.

◆ GetId()

int vtkPVCAVEConfigInformation::GetId ( int viewerIndex )

Return the id attribute of the indexed independent viewer.

◆ GetEyeSeparation() [2/2]

double vtkPVCAVEConfigInformation::GetEyeSeparation ( int viewerIndex )

Return the eye separation attribute of the indexed independent viewer.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVCAVEConfigInformation.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

◆ vtkPVCAVEConfigInformation()

◆ ~vtkPVCAVEConfigInformation()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ CopyFromObject()

◆ AddInformation()

◆ CopyToStream()

◆ CopyFromStream()

◆ GetIsInCAVE()

◆ GetEyeSeparation() [1/2]

◆ GetUseOffAxisProjection()

◆ GetNumberOfDisplays()

◆ GetShowBorders()

◆ GetFullScreen()

◆ GetName()

◆ GetShow2DOverlays()

◆ GetGeometry()

◆ GetHasCorners()

◆ GetLowerLeft()

◆ GetLowerRight()

◆ GetUpperRight()

◆ GetStereoEnabled()

◆ GetStereoType()

◆ GetViewerId()

◆ GetNumberOfViewers()

◆ GetId()

◆ GetEyeSeparation() [2/2]