unreal.HMDTrackingOrigin

class unreal.HMDTrackingOrigin

Bases: EnumBase

Specifies the type of tracking space origin we should use. Be aware that not all devices support all Tracking Origin types. https://registry.khronos.org/OpenXR/specs/1.0/html/xrspec.html#reference-spaces

C++ Source:

  • Module: HeadMountedDisplay

  • File: HeadMountedDisplayTypes.h

CUSTOM_OPEN_XR: HMDTrackingOrigin

Custom OpenXR tracking space of some kind. You cannot set this space explictly, it is automatically used by some platform plugin extensions.

Type:

4

LOCAL: HMDTrackingOrigin

For seated experiences. Always Supported. Typically centered around the HMDs initial position either at app startup or device startup. Useful for seated experiences. Previously called Eye Space.

Type:

2

LOCAL_FLOOR: HMDTrackingOrigin

For standing stationary experiences. Typically centered around HMDs initial position either at app startup or device startup, with Z 0 set to match the floor as in the Stage Space. Falls back to local.

Type:

1

STAGE: HMDTrackingOrigin

For walking-around experiences. The origin will be at floor level and typically within a defined play areas who’s bounds will be available. Falls back to local.

Type:

3

VIEW: HMDTrackingOrigin

Previously sometimes used Eye space to query for the view transform, this space is fixed to the HMD, meaning that as the hmd moves this space moves relative to other spaces. This isn’t used as a tracking origin.

Type:

0