vtkOpenXRSceneObserver Class Reference

#include <vtkOpenXRSceneObserver.h>

Inheritance diagram for vtkOpenXRSceneObserver:

Collaboration diagram for vtkOpenXRSceneObserver:

Public Types
enum	SceneFeature { Markers = 1000147000 }
	List of features. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkOpenXRSceneObserver *	NewInstance () const
bool	Initialize ()
	Creates runtime scene observer.
bool	UpdateSceneData ()
	Update scene data by polling the runtime.
virtual double	GetClippingRadius ()
	Finite positive radius of the clipping sphere, expressed in meters.
virtual void	SetClippingRadius (double)
	Finite positive radius of the clipping sphere, expressed in meters.
bool	EnableComputeFeature (SceneFeature feature)
	Enable or disable or check availability of a scene feature.
void	DisableComputeFeature (SceneFeature feature)
	Enable or disable or check availability of a scene feature.
bool	IsComputeFeatureEnabled (SceneFeature feature) const
	Enable or disable or check availability of a scene feature.
bool	IsComputeFeatureSupported (SceneFeature feature) const
	Enable or disable or check availability of a scene feature.
virtual void	SetMinimumInterval (double)
	Set the minimum interval between two runtime queries.
virtual double	GetMinimumInterval ()
	Set the minimum interval between two runtime queries.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkOpenXRSceneObserver *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenXRSceneObserver *	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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenXRSceneObserver ()
	~vtkOpenXRSceneObserver () override
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=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
enum	SceneConsistency { SnapshotComplete = 1 , SnapshotIncompleteFast = 2 , OcclusionOptimized = 3 }
virtual SceneConsistency	GetComputeConsistency ()
virtual void	SetComputeConsistency (SceneConsistency)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Examples

Rendering/OpenXR/vtkOpenXRSceneObserver.h.

Definition at line 56 of file vtkOpenXRSceneObserver.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkOpenXRSceneObserver::Superclass

Definition at line 62 of file vtkOpenXRSceneObserver.h.

Member Enumeration Documentation

SceneConsistency

enum vtkOpenXRSceneObserver::SceneConsistency

• SnapshotComplete: The runtime must return a scene that is a consistent and complete snapshot of the environment, inferring the size and shape of objects as needed where the objects were not directly observed, in order to generate a watertight representation of the scene.
• SnapshotIncompleteFast: The runtime must return a consistent snapshot of the scene with meshes that do not overlap adjacent meshes at their edges, but may skip returning objects with XrSceneObjectTypeMSFT of XR_SCENE_OBJECT_TYPE_INFERRED_MSFT in order to return the scene faster.
• OcclusionOptimized: The runtime may react to this value by computing scenes more quickly and reusing existing mesh buffer IDs more often to minimize app overhead, with potential tradeoffs such as returning meshes that are not watertight, meshes that overlap adjacent meshes at their edges to allow partial updates in the future, or other reductions in mesh quality that are less observable when mesh is used for occlusion only.

Default: SnapshotComplete

Enumerator
SnapshotComplete
SnapshotIncompleteFast
OcclusionOptimized

Definition at line 94 of file vtkOpenXRSceneObserver.h.

SceneFeature

enum vtkOpenXRSceneObserver::SceneFeature

List of features.

Not all features may be supported by the runtime, and not all features have to be queried everytime.

Enumerator
Markers

Definition at line 124 of file vtkOpenXRSceneObserver.h.

Constructor & Destructor Documentation

vtkOpenXRSceneObserver()

vtkOpenXRSceneObserver::vtkOpenXRSceneObserver ( )

protected

~vtkOpenXRSceneObserver()

vtkOpenXRSceneObserver::~vtkOpenXRSceneObserver ( )

overrideprotected

Member Function Documentation

New()

static vtkOpenXRSceneObserver * vtkOpenXRSceneObserver::New ( )

static

IsTypeOf()

static vtkTypeBool vtkOpenXRSceneObserver::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkOpenXRSceneObserver::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 vtkObjectBase.

SafeDownCast()

static vtkOpenXRSceneObserver * vtkOpenXRSceneObserver::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkOpenXRSceneObserver::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkOpenXRSceneObserver * vtkOpenXRSceneObserver::NewInstance

(

)

const

Initialize()

bool vtkOpenXRSceneObserver::Initialize

(

)

Creates runtime scene observer.

UpdateSceneData()

bool vtkOpenXRSceneObserver::UpdateSceneData

(

)

Update scene data by polling the runtime.

This function does nothing if less than MinimumInterval seconds elapsed since last call.

GetComputeConsistency()

virtual SceneConsistency vtkOpenXRSceneObserver::GetComputeConsistency ( )

virtual

• SnapshotComplete: The runtime must return a scene that is a consistent and complete snapshot of the environment, inferring the size and shape of objects as needed where the objects were not directly observed, in order to generate a watertight representation of the scene.
• SnapshotIncompleteFast: The runtime must return a consistent snapshot of the scene with meshes that do not overlap adjacent meshes at their edges, but may skip returning objects with XrSceneObjectTypeMSFT of XR_SCENE_OBJECT_TYPE_INFERRED_MSFT in order to return the scene faster.
• OcclusionOptimized: The runtime may react to this value by computing scenes more quickly and reusing existing mesh buffer IDs more often to minimize app overhead, with potential tradeoffs such as returning meshes that are not watertight, meshes that overlap adjacent meshes at their edges to allow partial updates in the future, or other reductions in mesh quality that are less observable when mesh is used for occlusion only.

Default: SnapshotComplete

SetComputeConsistency()

virtual void vtkOpenXRSceneObserver::SetComputeConsistency ( SceneConsistency  )

virtual

• SnapshotComplete: The runtime must return a scene that is a consistent and complete snapshot of the environment, inferring the size and shape of objects as needed where the objects were not directly observed, in order to generate a watertight representation of the scene.
• SnapshotIncompleteFast: The runtime must return a consistent snapshot of the scene with meshes that do not overlap adjacent meshes at their edges, but may skip returning objects with XrSceneObjectTypeMSFT of XR_SCENE_OBJECT_TYPE_INFERRED_MSFT in order to return the scene faster.
• OcclusionOptimized: The runtime may react to this value by computing scenes more quickly and reusing existing mesh buffer IDs more often to minimize app overhead, with potential tradeoffs such as returning meshes that are not watertight, meshes that overlap adjacent meshes at their edges to allow partial updates in the future, or other reductions in mesh quality that are less observable when mesh is used for occlusion only.

Default: SnapshotComplete

GetClippingRadius()

virtual double vtkOpenXRSceneObserver::GetClippingRadius ( )

virtual

Finite positive radius of the clipping sphere, expressed in meters.

Sphere is centered on the left eye position.

This only filters what is retrieved from the runtime. It has no effect on runtime environment analysis.

Default: 2.0

SetClippingRadius()

virtual void vtkOpenXRSceneObserver::SetClippingRadius ( double  )

virtual

Finite positive radius of the clipping sphere, expressed in meters.

Sphere is centered on the left eye position.

This only filters what is retrieved from the runtime. It has no effect on runtime environment analysis.

Default: 2.0

EnableComputeFeature()

bool vtkOpenXRSceneObserver::EnableComputeFeature

(

SceneFeature

feature

)

Enable or disable or check availability of a scene feature.

EnableComputeFeature returns true if the feature has been (or is already) enabled.

By default, all supported features are enabled.

DisableComputeFeature()

void vtkOpenXRSceneObserver::DisableComputeFeature

(

SceneFeature

feature

)

Enable or disable or check availability of a scene feature.

EnableComputeFeature returns true if the feature has been (or is already) enabled.

By default, all supported features are enabled.

IsComputeFeatureEnabled()

bool vtkOpenXRSceneObserver::IsComputeFeatureEnabled

(

SceneFeature

feature

)

const

Enable or disable or check availability of a scene feature.

EnableComputeFeature returns true if the feature has been (or is already) enabled.

By default, all supported features are enabled.

IsComputeFeatureSupported()

bool vtkOpenXRSceneObserver::IsComputeFeatureSupported

(

SceneFeature

feature

)

const

Enable or disable or check availability of a scene feature.

EnableComputeFeature returns true if the feature has been (or is already) enabled.

By default, all supported features are enabled.

SetMinimumInterval()

virtual void vtkOpenXRSceneObserver::SetMinimumInterval ( double  )

virtual

Set the minimum interval between two runtime queries.

Expressed in seconds.

Default: 2.0

GetMinimumInterval()

virtual double vtkOpenXRSceneObserver::GetMinimumInterval ( )

virtual

Set the minimum interval between two runtime queries.

Expressed in seconds.

Default: 2.0

---

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

• Rendering/OpenXR/vtkOpenXRSceneObserver.h