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.

Methods

Variant

get_input ( StringName name ) const

XRPose

get_pose ( StringName name ) const

bool

has_pose ( StringName name ) const

void

invalidate_pose ( StringName name )

void

set_input ( StringName name, Variant value )

void

set_pose ( StringName name, Transform3D transform, Vector3 linear_velocity, Vector3 angular_velocity )

Signals

  • button_pressed ( String name )

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


  • button_released ( String name )

Emitted when a button on this tracker is released.


Emitted when a thumbstick or thumbpad on this tracker moves.


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


  • pose_changed ( XRPose pose )

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

Enumerations

enum TrackerHand:

  • TRACKER_HAND_UNKNOWN = 0 --- The hand this tracker is held in is unknown or not applicable.

  • TRACKER_HAND_LEFT = 1 --- This tracker is the left hand controller.

  • TRACKER_HAND_RIGHT = 2 --- This tracker is the right hand controller.

Property Descriptions

Default

""

Setter

set_tracker_desc(value)

Getter

get_tracker_desc()

The description of this tracker.


Default

0

Setter

set_tracker_hand(value)

Getter

get_tracker_hand()

Defines which hand this tracker relates to.


Default

&"Unknown"

Setter

set_tracker_name(value)

Getter

get_tracker_name()

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


Default

0.0

Setter

set_rumble(value)

Getter

get_rumble()

The degree to which the tracker rumbles. Ranges from 0.0 to 1.0 with precision .01.


Default

128

Setter

set_tracker_type(value)

Getter

get_tracker_type()

The type of tracker.

Method Descriptions

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.


Returns the current XRPose state object for the bound pose.


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


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 loose tracking or just remain at their last known position.


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


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