1. Epic GamesDeveloper
  3. FXRTrackingSystemBase

FXRTrackingSystemBase

Base utility class for implementations of the [IXRTrackingSystem](API\Runtime\HeadMountedDisplay\IXRTrackingSystem) interface Contains helpers and default implementation of most abstract methods, so final implementations only need to override features that they support.

API > API/Plugins > API/Plugins/XRBase

Inheritance Hierarchy

References

   
Module XRBase
Header /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h
Include #include "XRTrackingSystemBase.h"

Syntax

class FXRTrackingSystemBase : public IXRTrackingSystem

Remarks

Base utility class for implementations of the IXRTrackingSystem interface Contains helpers and default implementation of most abstract methods, so final implementations only need to override features that they support.

Variables

  Type Name Description
Protected variable FTransform CachedTrackingToWorld  
Protected variable FTransform CalibratedOffset If the tracker is trying to lock itself to an external tracking source for drift control, this stores the calibrated offset between the external tracking system and the internal tracking system (e.g. a location from a mocap system tracker to the HMD's internal IMU).
Protected variable IXRLoadingScreen * LoadingScreen  
Protected variable TSharedPtr< class FDefaultXRCamera, ESPMode::ThreadSafe > XRCamera  

Constructors

  Type Name Description
Public function  

FXRTrackingSystemBase ( IARSystemSupport* InARImplementation
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Const FTransform  
Protected function Virtual IXRLoadingScreen * Override this method if you need to customize the IXRLoadingScreen implementation.
Protected function Virtual void Meant to be called by sub-classes whenever the interaction profile is altered.
Protected function Virtual void  
Protected function Virtual void Meant to be called by sub-classes whenever the tracking origin is altered.
Protected function FTransform Computes the project's tracking-to-world transform based off how the user has set up their camera system (assumes the camera is parented to the XR origin, and in turn uses that transform).

Overridden from IXRTrackingSystem

  Type Name Description
Public function Virtual void

CalibrateExternalTrackingSource ( const FTransform& ExternalTrackingTransform
)

 Called to calibrate the offset transform between an external tracking source and the internal tracking source (e.g. mocap tracker to and HMD tracker).
Public function Virtual uint32

CountTrackedDevices ( EXRTrackedDeviceType Type
)

 Get the count of tracked devices.
Public function Virtual Const bool Whether or not the system supports positional tracking (either via sensor or other means).
Public function Virtual TSharedPtr< FARSupportInterface, ESPMode::ThreadSafe > Access optionsal ARCompositionComponent
Public function Virtual Const const TSharedPtr< const FARSupportInterface, ESPMode::ThreadSafe >  
Public function Virtual bool

GetCurrentInteractionProfile ( const EControllerHand Hand,
FString& InteractionProfile
)

  
Public function Virtual Const bool

GetFloorToEyeTrackingTransform ( FTransform& OutFloorToEye
)

 Returns a transform for converting from 'Floor' origin space to 'Eye' origin space.
Public function Virtual IXRLoadingScreen * Access the loading screen interface associated with this tracking system, if any.
Public function Virtual void

GetMotionControllerData ( UObject* WorldContext,
const EControllerHand Hand,
FXRMotionControllerData& MotionControllerData
)

 Platform Agnostic Query about MotionControllers details
Public function Virtual bool

GetRelativeEyePose ( int32 DeviceId,
int32 ViewIndex,
FQuat& OutOrientation,
FVector& OutPosition
)

 If the device id represents a head mounted display, fetches the relative position of the given eye relative to the eye.
Public function Virtual FString If the device id represents a tracking sensor, reports the serial number as a string if the device supports it.
Public function Virtual Const EXRTrackedDeviceType

GetTrackedDeviceType ( int32 DeviceId
)

 If the device id represents a tracking sensor, reports the device type.
Public function Virtual Const EHMDTrackingOrigin::Type Returns current tracking origin.The default implementation always reports 'eye'-level tracking.
Public function Virtual bool

GetTrackingSensorProperties ( int32 DeviceId,
FQuat& OutOrientation,
FVector& OutPosition,
FXRSensorProperties& OutSensorProperties
)

 If the device id represents a tracking sensor, reports the frustum properties in game-world space of the sensor.
Public function Virtual Const FTransform Returns the system's latest known tracking-to-world transform.
Public function Virtual Const FString Returns version string.
Public function Virtual TSharedPtr< class IXRCamera, ESPMode::ThreadSafe >

GetXRCamera ( int32 DeviceId
)

 Get the IXCamera instance for the given device.
Public function Virtual bool If the system currently has valid tracking positions.
Public function Virtual bool

IsTracking ( int32 DeviceId
)

 Check current tracking status of a device.
Public function Virtual void Sets tracking origin (either 'eye'-level or 'floor'-level).
Public function Virtual void

UpdateExternalTrackingPosition ( const FTransform& ExternalTrackingTransform
)

 Called after calibration to attempt to pull the internal tracker (e.g. HMD tracking) in line with the external tracker (e.g. mocap tracker).
Public function Virtual void

UpdateTrackingToWorldTransform ( const FTransform& TrackingToWorldOverride
)

 Refreshes the system's known tracking-to-world transform.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page