Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

XRPositionalTracker

Inherits: RefCounted < Object

A tracked object.

Description

An instance of this object represents a device that is tracked, such as a controller or anchor point. HMDs aren't represented here as they are handled internally.

As controllers are turned on and the XRInterface detects them, instances of this object are automatically added to this list of active tracking objects accessible through the XRServer.

The XRController3D and XRAnchor3D both consume objects of this type and should be used in your project. The positional trackers are just under-the-hood objects that make this all work. These are mostly exposed so that GDExtension-based interfaces can interact with them.

Tutorials

Properties

String

description

""

TrackerHand

hand

0

StringName

name

&"Unknown"

String

profile

""

TrackerType

type

128

Methods

Variant

get_input(name: StringName) const

XRPose

get_pose(name: StringName) const

bool

has_pose(name: StringName) const

void

invalidate_pose(name: StringName)

void

set_input(name: StringName, value: Variant)

void

set_pose(name: StringName, transform: Transform3D, linear_velocity: Vector3, angular_velocity: Vector3, tracking_confidence: TrackingConfidence)

Signals

button_pressed(name: String)

Emitted when a button on this tracker is pressed. Note that many XR runtimes allow other inputs to be mapped to buttons.

button_released(name: String)

Emitted when a button on this tracker is released.

input_float_changed(name: String, value: float)

Emitted when a trigger or similar input on this tracker changes value.

input_vector2_changed(name: String, vector: Vector2)

Emitted when a thumbstick or thumbpad on this tracker moves.

pose_changed(pose: XRPose)

Emitted when the state of a pose tracked by this tracker changes.

pose_lost_tracking(pose: XRPose)

Emitted when a pose tracked by this tracker stops getting updated tracking data.

profile_changed(role: String)

Emitted when the profile of our tracker changes.

Enumerations

enum TrackerHand:

TrackerHand TRACKER_HAND_UNKNOWN = 0

The hand this tracker is held in is unknown or not applicable.

TrackerHand TRACKER_HAND_LEFT = 1

This tracker is the left hand controller.

TrackerHand TRACKER_HAND_RIGHT = 2

This tracker is the right hand controller.

Property Descriptions

String description = ""

  • void set_tracker_desc(value: String)

  • String get_tracker_desc()

The description of this tracker.

TrackerHand hand = 0

Defines which hand this tracker relates to.

StringName name = &"Unknown"

The unique name of this tracker. The trackers that are available differ between various XR runtimes and can often be configured by the user. Godot maintains a number of reserved names that it expects the XRInterface to implement if applicable:

  • left_hand identifies the controller held in the players left hand

  • right_hand identifies the controller held in the players right hand

String profile = ""

  • void set_tracker_profile(value: String)

  • String get_tracker_profile()

The profile associated with this tracker, interface dependent but will indicate the type of controller being tracked.

TrackerType type = 128

The type of tracker.

Method Descriptions

Variant get_input(name: StringName) const

Returns an input for this tracker. It can return a boolean, float or Vector2 value depending on whether the input is a button, trigger or thumbstick/thumbpad.

XRPose get_pose(name: StringName) const

Returns the current XRPose state object for the bound name pose.

bool has_pose(name: StringName) const

Returns true if the tracker is available and is currently tracking the bound name pose.

void invalidate_pose(name: StringName)

Marks this pose as invalid, we don't clear the last reported state but it allows users to decide if trackers need to be hidden if we lose tracking or just remain at their last known position.

void set_input(name: StringName, value: Variant)

Changes the value for the given input. This method is called by a XRInterface implementation and should not be used directly.

void set_pose(name: StringName, transform: Transform3D, linear_velocity: Vector3, angular_velocity: Vector3, tracking_confidence: TrackingConfidence)

Sets the transform, linear velocity, angular velocity and tracking confidence for the given pose. This method is called by a XRInterface implementation and should not be used directly.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.