XRPose | Godot Docs 4.4 | ROKOJORI Labs

class-description

NEWS

COMMUNITY

STORE

TUTORIALS

LOGOUT

LOGOUT

Object

XRPose

This object contains all data related to a pose on a tracked object.

XR runtimes often identify multiple locations on devices such as controllers that are spatially tracked.

Orientation, location, linear velocity and angular velocity are all provided for each pose by the XR runtime. This object contains this state of a pose.

Enum

TrackingConfidence

()

:Enum

XR_TRACKING_CONFIDENCE_NONE = 0

No tracking information is available for this pose.

XR_TRACKING_CONFIDENCE_LOW = 1

Tracking information may be inaccurate or estimated. For example, with inside out tracking this would indicate a controller may be (partially) obscured.

XR_TRACKING_CONFIDENCE_HIGH = 2

Tracking information is considered accurate and up to date.

Vector3

angular_velocity

()

:Vector3

The angular velocity for this pose.

bool

has_tracking_data

()

:bool

If true our tracking data is up to date. If false we're no longer receiving new tracking data and our state is whatever that last valid state was.

Vector3

linear_velocity

()

:Vector3

The linear velocity of this pose.

StringName

name

()

:StringName

The name of this pose. Usually, this name is derived from an action map set up by the user. Godot also suggests some pose names that XRInterface objects are expected to implement:

root is the root location, often used for tracked objects that do not have further nodes.
aim is the tip of a controller with its orientation pointing outwards, often used for raycasts.
grip is the location where the user grips the controller.
skeleton is the root location for a hand mesh, when using hand tracking and an animated skeleton is supplied by the XR runtime.