Open CASCADE Technology  7.4.1.dev
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
Aspect_XRSession Class Referenceabstract

Extended Reality (XR) Session interface. More...

#include <Aspect_XRSession.hxx>

Inheritance diagram for Aspect_XRSession:
Inheritance graph
[legend]

Public Types

enum  TrackingUniverseOrigin { TrackingUniverseOrigin_Seated, TrackingUniverseOrigin_Standing }
 Identifies which style of tracking origin the application wants to use for the poses it is requesting. More...
 
enum  InfoString { InfoString_Vendor, InfoString_Device, InfoString_Tracker, InfoString_SerialNumber }
 Info string enumeration. More...
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Public Member Functions

virtual bool IsOpen () const =0
 Return TRUE if session is opened. More...
 
virtual bool Open ()=0
 Initialize session. More...
 
virtual void Close ()=0
 Release session. More...
 
virtual bool WaitPoses ()=0
 Fetch actual poses of tracked devices. More...
 
virtual NCollection_Vec2< int > RecommendedViewport () const =0
 Return recommended viewport Width x Height for rendering into VR. More...
 
virtual NCollection_Mat4< double > EyeToHeadTransform (Aspect_Eye theEye) const =0
 Return transformation from eye to head. More...
 
NCollection_Mat4< double > HeadToEyeTransform (Aspect_Eye theEye) const
 Return transformation from head to eye. More...
 
virtual NCollection_Mat4< double > ProjectionMatrix (Aspect_Eye theEye, double theZNear, double theZFar) const =0
 Return projection matrix. More...
 
virtual bool HasProjectionFrustums () const =0
 Return FALSE if projection frustums are unsupported and general 4x4 projection matrix should be fetched instead. More...
 
virtual void ProcessEvents ()=0
 Receive XR events. More...
 
virtual bool SubmitEye (void *theTexture, Aspect_GraphicsLibrary theGraphicsLib, Aspect_ColorSpace theColorSpace, Aspect_Eye theEye)=0
 Submit texture eye to XR Composer. More...
 
Standard_Real UnitFactor () const
 Return unit scale factor defined as scale factor for m (meters); 1.0 by default. More...
 
void SetUnitFactor (Standard_Real theFactor)
 Set unit scale factor. More...
 
Standard_Real Aspect () const
 Return aspect ratio. More...
 
Standard_Real FieldOfView () const
 Return field of view. More...
 
Standard_Real IOD () const
 Return Intra-ocular Distance (IOD); also known as Interpupillary Distance (IPD). Defined in meters by default (. More...
 
Standard_ShortReal DisplayFrequency () const
 Return display frequency or 0 if unknown. More...
 
const Aspect_FrustumLRBT< double > & ProjectionFrustum (Aspect_Eye theEye) const
 Return projection frustum. More...
 
const gp_TrsfHeadPose () const
 Return head orientation in right-handed system: +y is up +x is to the right -z is forward Distance unit is meters by default (. More...
 
gp_Trsf LeftHandPose () const
 Return left hand orientation. More...
 
gp_Trsf RightHandPose () const
 Return right hand orientation. More...
 
const Aspect_TrackedDevicePoseArrayTrackedPoses () const
 Return number of tracked poses array. More...
 
bool HasTrackedPose (Standard_Integer theDevice) const
 Return TRUE if device orientation is defined. More...
 
virtual Standard_Integer NamedTrackedDevice (Aspect_XRTrackedDeviceRole theDevice) const =0
 Return index of tracked device of known role, or -1 if undefined. More...
 
Handle< Graphic3d_ArrayOfTrianglesLoadRenderModel (Standard_Integer theDevice, Handle< Image_Texture > &theTexture)
 Load model for displaying device. More...
 
Handle< Graphic3d_ArrayOfTrianglesLoadRenderModel (Standard_Integer theDevice, Standard_Boolean theToApplyUnitFactor, Handle< Image_Texture > &theTexture)
 Load model for displaying device. More...
 
virtual Aspect_XRDigitalActionData GetDigitalActionData (const Handle< Aspect_XRAction > &theAction) const =0
 Fetch data for digital input action (like button). More...
 
virtual Aspect_XRAnalogActionData GetAnalogActionData (const Handle< Aspect_XRAction > &theAction) const =0
 Fetch data for digital input action (like axis). More...
 
virtual Aspect_XRPoseActionData GetPoseActionDataForNextFrame (const Handle< Aspect_XRAction > &theAction) const =0
 Fetch data for pose input action (like fingertip position). The returned values will match the values returned by the last call to WaitPoses(). More...
 
void TriggerHapticVibrationAction (const Handle< Aspect_XRAction > &theAction, const Aspect_XRHapticActionData &theParams)
 Trigger vibration. More...
 
void AbortHapticVibrationAction (const Handle< Aspect_XRAction > &theAction)
 Abort vibration. More...
 
TrackingUniverseOrigin TrackingOrigin () const
 Return tracking origin. More...
 
virtual void SetTrackingOrigin (TrackingUniverseOrigin theOrigin)
 Set tracking origin. More...
 
const Handle< Aspect_XRAction > & GenericAction (Aspect_XRTrackedDeviceRole theDevice, Aspect_XRGenericAction theAction) const
 Return generic action for specific hand or NULL if undefined. More...
 
virtual TCollection_AsciiString GetString (InfoString theInfo) const =0
 Query information. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

 Aspect_XRSession ()
 Empty constructor. More...
 
virtual Handle< Graphic3d_ArrayOfTrianglesloadRenderModel (Standard_Integer theDevice, Standard_Boolean theToApplyUnitFactor, Handle< Image_Texture > &theTexture)=0
 Load model for displaying device. More...
 
virtual void triggerHapticVibrationAction (const Handle< Aspect_XRAction > &theAction, const Aspect_XRHapticActionData &theParams)=0
 Trigger vibration. More...
 

Protected Attributes

NCollection_Array1< Handle< Aspect_XRAction > > myRoleActions [Aspect_XRTrackedDeviceRole_NB]
 generic actions More...
 
Aspect_XRActionSetMap myActionSets
 actions sets More...
 
TrackingUniverseOrigin myTrackOrigin
 tracking origin More...
 
Aspect_TrackedDevicePoseArray myTrackedPoses
 array of tracked poses More...
 
gp_Trsf myHeadPose
 head orientation More...
 
NCollection_Vec2< int > myRendSize
 viewport Width x Height for rendering into VR More...
 
Aspect_FrustumLRBT< double > myFrustumL
 left eye projection frustum More...
 
Aspect_FrustumLRBT< double > myFrustumR
 right eye projection frustum More...
 
Standard_Real myUnitFactor
 unit scale factor defined as scale factor for m (meters) More...
 
Standard_Real myAspect
 aspect ratio More...
 
Standard_Real myFieldOfView
 field of view More...
 
Standard_Real myIod
 intra-ocular distance in meters More...
 
Standard_ShortReal myDispFreq
 display frequency More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Extended Reality (XR) Session interface.

Member Enumeration Documentation

◆ InfoString

Info string enumeration.

Enumerator
InfoString_Vendor 
InfoString_Device 
InfoString_Tracker 
InfoString_SerialNumber 

◆ TrackingUniverseOrigin

Identifies which style of tracking origin the application wants to use for the poses it is requesting.

Enumerator
TrackingUniverseOrigin_Seated 
TrackingUniverseOrigin_Standing 

poses are provided relative to the seated zero pose

Constructor & Destructor Documentation

◆ Aspect_XRSession()

Aspect_XRSession::Aspect_XRSession ( )
protected

Empty constructor.

Member Function Documentation

◆ AbortHapticVibrationAction()

void Aspect_XRSession::AbortHapticVibrationAction ( const Handle< Aspect_XRAction > &  theAction)

Abort vibration.

◆ Aspect()

Standard_Real Aspect_XRSession::Aspect ( ) const
inline

Return aspect ratio.

◆ Close()

virtual void Aspect_XRSession::Close ( )
pure virtual

Release session.

Implemented in Aspect_OpenVRSession.

◆ DisplayFrequency()

Standard_ShortReal Aspect_XRSession::DisplayFrequency ( ) const
inline

Return display frequency or 0 if unknown.

◆ EyeToHeadTransform()

virtual NCollection_Mat4<double> Aspect_XRSession::EyeToHeadTransform ( Aspect_Eye  theEye) const
pure virtual

Return transformation from eye to head.

Implemented in Aspect_OpenVRSession.

◆ FieldOfView()

Standard_Real Aspect_XRSession::FieldOfView ( ) const
inline

Return field of view.

◆ GenericAction()

const Handle< Aspect_XRAction >& Aspect_XRSession::GenericAction ( Aspect_XRTrackedDeviceRole  theDevice,
Aspect_XRGenericAction  theAction 
) const
inline

Return generic action for specific hand or NULL if undefined.

◆ GetAnalogActionData()

virtual Aspect_XRAnalogActionData Aspect_XRSession::GetAnalogActionData ( const Handle< Aspect_XRAction > &  theAction) const
pure virtual

Fetch data for digital input action (like axis).

Parameters
theAction[in] action of Aspect_XRActionType_InputAnalog type

Implemented in Aspect_OpenVRSession.

◆ GetDigitalActionData()

virtual Aspect_XRDigitalActionData Aspect_XRSession::GetDigitalActionData ( const Handle< Aspect_XRAction > &  theAction) const
pure virtual

Fetch data for digital input action (like button).

Parameters
theAction[in] action of Aspect_XRActionType_InputDigital type

Implemented in Aspect_OpenVRSession.

◆ GetPoseActionDataForNextFrame()

virtual Aspect_XRPoseActionData Aspect_XRSession::GetPoseActionDataForNextFrame ( const Handle< Aspect_XRAction > &  theAction) const
pure virtual

Fetch data for pose input action (like fingertip position). The returned values will match the values returned by the last call to WaitPoses().

Parameters
theAction[in] action of Aspect_XRActionType_InputPose type

Implemented in Aspect_OpenVRSession.

◆ GetString()

virtual TCollection_AsciiString Aspect_XRSession::GetString ( InfoString  theInfo) const
pure virtual

Query information.

Implemented in Aspect_OpenVRSession.

◆ HasProjectionFrustums()

virtual bool Aspect_XRSession::HasProjectionFrustums ( ) const
pure virtual

Return FALSE if projection frustums are unsupported and general 4x4 projection matrix should be fetched instead.

Implemented in Aspect_OpenVRSession.

◆ HasTrackedPose()

bool Aspect_XRSession::HasTrackedPose ( Standard_Integer  theDevice) const
inline

Return TRUE if device orientation is defined.

◆ HeadPose()

const gp_Trsf& Aspect_XRSession::HeadPose ( ) const
inline

Return head orientation in right-handed system: +y is up +x is to the right -z is forward Distance unit is meters by default (.

See also
UnitFactor()).

◆ HeadToEyeTransform()

NCollection_Mat4<double> Aspect_XRSession::HeadToEyeTransform ( Aspect_Eye  theEye) const
inline

Return transformation from head to eye.

◆ IOD()

Standard_Real Aspect_XRSession::IOD ( ) const
inline

Return Intra-ocular Distance (IOD); also known as Interpupillary Distance (IPD). Defined in meters by default (.

See also
UnitFactor()).

◆ IsOpen()

virtual bool Aspect_XRSession::IsOpen ( ) const
pure virtual

Return TRUE if session is opened.

Implemented in Aspect_OpenVRSession.

◆ LeftHandPose()

gp_Trsf Aspect_XRSession::LeftHandPose ( ) const
inline

Return left hand orientation.

◆ LoadRenderModel() [1/2]

Handle< Graphic3d_ArrayOfTriangles > Aspect_XRSession::LoadRenderModel ( Standard_Integer  theDevice,
Handle< Image_Texture > &  theTexture 
)
inline

Load model for displaying device.

Parameters
theDevice[in] device index
theTexture[out] texture source
Returns
model triangulation or NULL if not found

◆ LoadRenderModel() [2/2]

Handle< Graphic3d_ArrayOfTriangles > Aspect_XRSession::LoadRenderModel ( Standard_Integer  theDevice,
Standard_Boolean  theToApplyUnitFactor,
Handle< Image_Texture > &  theTexture 
)
inline

Load model for displaying device.

Parameters
theDevice[in] device index
theToApplyUnitFactor[in] flag to apply unit scale factor
theTexture[out] texture source
Returns
model triangulation or NULL if not found

◆ loadRenderModel()

virtual Handle< Graphic3d_ArrayOfTriangles > Aspect_XRSession::loadRenderModel ( Standard_Integer  theDevice,
Standard_Boolean  theToApplyUnitFactor,
Handle< Image_Texture > &  theTexture 
)
protectedpure virtual

Load model for displaying device.

Parameters
theDevice[in] device index
theToApplyUnitFactor[in] flag to apply unit scale factor
theTexture[out] texture source
Returns
model triangulation or NULL if not found

Implemented in Aspect_OpenVRSession.

◆ NamedTrackedDevice()

virtual Standard_Integer Aspect_XRSession::NamedTrackedDevice ( Aspect_XRTrackedDeviceRole  theDevice) const
pure virtual

Return index of tracked device of known role, or -1 if undefined.

Implemented in Aspect_OpenVRSession.

◆ Open()

virtual bool Aspect_XRSession::Open ( )
pure virtual

Initialize session.

Implemented in Aspect_OpenVRSession.

◆ ProcessEvents()

virtual void Aspect_XRSession::ProcessEvents ( )
pure virtual

Receive XR events.

Implemented in Aspect_OpenVRSession.

◆ ProjectionFrustum()

const Aspect_FrustumLRBT<double>& Aspect_XRSession::ProjectionFrustum ( Aspect_Eye  theEye) const
inline

Return projection frustum.

See also
HasProjectionFrustums().

◆ ProjectionMatrix()

virtual NCollection_Mat4<double> Aspect_XRSession::ProjectionMatrix ( Aspect_Eye  theEye,
double  theZNear,
double  theZFar 
) const
pure virtual

Return projection matrix.

Implemented in Aspect_OpenVRSession.

◆ RecommendedViewport()

virtual NCollection_Vec2<int> Aspect_XRSession::RecommendedViewport ( ) const
pure virtual

Return recommended viewport Width x Height for rendering into VR.

Implemented in Aspect_OpenVRSession.

◆ RightHandPose()

gp_Trsf Aspect_XRSession::RightHandPose ( ) const
inline

Return right hand orientation.

◆ SetTrackingOrigin()

virtual void Aspect_XRSession::SetTrackingOrigin ( TrackingUniverseOrigin  theOrigin)
inlinevirtual

Set tracking origin.

Reimplemented in Aspect_OpenVRSession.

◆ SetUnitFactor()

void Aspect_XRSession::SetUnitFactor ( Standard_Real  theFactor)
inline

Set unit scale factor.

◆ SubmitEye()

virtual bool Aspect_XRSession::SubmitEye ( void *  theTexture,
Aspect_GraphicsLibrary  theGraphicsLib,
Aspect_ColorSpace  theColorSpace,
Aspect_Eye  theEye 
)
pure virtual

Submit texture eye to XR Composer.

Parameters
theTexture[in] texture handle
theGraphicsLib[in] graphics library in which texture handle is defined
theColorSpace[in] texture color space; sRGB means no color conversion by composer; Linear means to sRGB color conversion by composer
theEye[in] eye to display
Returns
FALSE on error

Implemented in Aspect_OpenVRSession.

◆ TrackedPoses()

const Aspect_TrackedDevicePoseArray& Aspect_XRSession::TrackedPoses ( ) const
inline

Return number of tracked poses array.

◆ TrackingOrigin()

TrackingUniverseOrigin Aspect_XRSession::TrackingOrigin ( ) const
inline

Return tracking origin.

◆ TriggerHapticVibrationAction()

void Aspect_XRSession::TriggerHapticVibrationAction ( const Handle< Aspect_XRAction > &  theAction,
const Aspect_XRHapticActionData theParams 
)

Trigger vibration.

◆ triggerHapticVibrationAction()

virtual void Aspect_XRSession::triggerHapticVibrationAction ( const Handle< Aspect_XRAction > &  theAction,
const Aspect_XRHapticActionData theParams 
)
protectedpure virtual

Trigger vibration.

Implemented in Aspect_OpenVRSession.

◆ UnitFactor()

Standard_Real Aspect_XRSession::UnitFactor ( ) const
inline

Return unit scale factor defined as scale factor for m (meters); 1.0 by default.

◆ WaitPoses()

virtual bool Aspect_XRSession::WaitPoses ( )
pure virtual

Fetch actual poses of tracked devices.

Implemented in Aspect_OpenVRSession.

Field Documentation

◆ myActionSets

Aspect_XRActionSetMap Aspect_XRSession::myActionSets
protected

actions sets

◆ myAspect

Standard_Real Aspect_XRSession::myAspect
protected

aspect ratio

◆ myDispFreq

Standard_ShortReal Aspect_XRSession::myDispFreq
protected

display frequency

◆ myFieldOfView

Standard_Real Aspect_XRSession::myFieldOfView
protected

field of view

◆ myFrustumL

Aspect_FrustumLRBT<double> Aspect_XRSession::myFrustumL
protected

left eye projection frustum

◆ myFrustumR

Aspect_FrustumLRBT<double> Aspect_XRSession::myFrustumR
protected

right eye projection frustum

◆ myHeadPose

gp_Trsf Aspect_XRSession::myHeadPose
protected

head orientation

◆ myIod

Standard_Real Aspect_XRSession::myIod
protected

intra-ocular distance in meters

◆ myRendSize

NCollection_Vec2<int> Aspect_XRSession::myRendSize
protected

viewport Width x Height for rendering into VR

◆ myRoleActions

NCollection_Array1<Handle< Aspect_XRAction > > Aspect_XRSession::myRoleActions[Aspect_XRTrackedDeviceRole_NB]
protected

generic actions

◆ myTrackedPoses

Aspect_TrackedDevicePoseArray Aspect_XRSession::myTrackedPoses
protected

array of tracked poses

◆ myTrackOrigin

TrackingUniverseOrigin Aspect_XRSession::myTrackOrigin
protected

tracking origin

◆ myUnitFactor

Standard_Real Aspect_XRSession::myUnitFactor
protected

unit scale factor defined as scale factor for m (meters)


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