XRTracking

XRTracking

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Break Key

Breaks an XR key apart into the interaction profile, handedness, motion source, indentifier and component.

Target is Head Mounted Display Function Library

Clear XRTimed Input Action Delegate

/ Clear a delegate to get an OpenXR action event with action time.

Target is Head Mounted Display Function Library

Configure Gestures

Specify which gestures to capture.

Target is Head Mounted Display Function Library

Enumerate Tracked Devices

Cross XR-System query that will list all XR devices currently being tracked.

Target is Head Mounted Display Function Library

Get Controller Transform for Time

Get the transform and potentially velocity data at a specified time near the current frame in unreal world space. This is intended for use with sub-frame input action timing data from SetXRTimedInputActionDelegate, or future support for timestamps in the core input system. The valid time window is platform dependent, but the intention per OpenXR is to fetch transforms for times from, at most, the previous few frames in the past or future. The OpenXR spec suggests that 50ms in the past should return an accurate result. There is no guarantee for the future, but the underlying system is likely to have been designed to predict out to about 50ms as well. On some platforms this will always just return a cached position and rotation, ignoring time. bTimeWasUsed will be false in that case. AngularVelocityRadPerSec is a vector whose direction is the axis of rotation and whoes length is the speed of rotation in radians per second.

Target is Head Mounted Display Function Library

Get Device Pose

Cross XR-System query that returns a specific device's tracked position and orientation (in tracking space).

Target is Head Mounted Display Function Library

Get Device World Pose

Cross XR-System query that returns a specific device's position and orientation in world space.

Target is Head Mounted Display Function Library

Get HMDData

Cross XR-System query that returns critical information about the HMD display (position, orientation, device name)

Target is Head Mounted Display Function Library

Get Motion Controller Data

Cross XR-System query that returns critical information about the motion controller (position, orientation, hand/finger position)

Target is Head Mounted Display Function Library

Get Play Area Bounds

Get the bounds of the area where the user can freely move while remaining tracked centered around the specified origin

Target is Head Mounted Display Function Library

Is Device Tracking

Cross XR-System query that returns whether the specified device is tracked or not.

Target is Head Mounted Display Function Library

Render HMD

Renders HMD Visualization on a system that might not have that HMD as native

Target is XRVisualization Function Library

Render Motion Controller

Renders Motion Controller Visualization on a system that might not have that HMD as native

Target is XRVisualization Function Library

Set XRTimed Input Action Delegate

Hook up a delegate to get an OpenXR action event with action time. For a boolean input the the 'value' parameter of the delegate will be 1.0 for a press and 0.0 for a release. For an analog input the value's range is action and platform specific. Use in combination with GetControllerTransformForTime for potentially improved temporal transform precision and velocity data. "Left Grip" is an example of a valid ActionName. Note: this is likely to be replaced by native support for event times in the core input system at some time in the future.

Target is Head Mounted Display Function Library