Class reference
XRPositionalTracker
Inherits XRTracker
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 XRNode3D 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.
Properties
Methods
Variant get_input(StringName name) const
Variant get_input(StringName name) constUse through XRControllerTracker.
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(StringName name) const
XRPose get_pose(StringName name) constReturns the current XRPose state object for the bound name pose.
bool has_pose(StringName name) const
bool has_pose(StringName name) constReturns true if the tracker is available and is currently tracking the bound name pose.
void invalidate_pose(StringName name)
StringName name)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(StringName name, Variant value)
StringName name, Variant value)Use through XRControllerTracker.
Changes the value for the given input. This method is called by an XRInterface implementation and should not be used directly.
void set_pose(StringName name, Transform3D transform, Vector3 linear_velocity, Vector3 angular_velocity, int tracking_confidence)
StringName name, Transform3D transform, Vector3 linear_velocity, Vector3 angular_velocity, int tracking_confidence)Sets the transform, linear velocity, angular velocity and tracking confidence for the given pose. This method is called by an XRInterface implementation and should not be used directly.
Signals
button_pressed(String name)
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)
String name)Emitted when a button on this tracker is released.
input_float_changed(String name, float value)
String name, float value)Emitted when a trigger or similar input on this tracker changes value.
input_vector2_changed(String name, Vector2 vector)
String name, Vector2 vector)Emitted when a thumbstick or thumbpad on this tracker moves.
pose_changed(XRPose pose)
XRPose pose)Emitted when the state of a pose tracked by this tracker changes.
pose_lost_tracking(XRPose pose)
XRPose pose)Emitted when a pose tracked by this tracker stops getting updated tracking data.
profile_changed(String role)
String role)Emitted when the profile of our tracker changes.
Constants
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.
TRACKER_HAND_MAX = 3
Represents the size of the TrackerHand enum.