Index · Object → RefCounted → XRTracker → XRPositionalTracker

XRPositionalTracker

A tracked object.

Inherited by (4): OpenXRSpatialEntityTrackerXRBodyTrackerXRControllerTrackerXRHandTracker
Class 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

var hand: XRPositionalTracker.TrackerHand = 0

Defines which hand this tracker relates to.

var profile: String = ""

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

Inherited from XRTracker (3)
var name: StringName = &"Unknown"

Methods

func get_input(name: StringName) -> Variant

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.

func get_pose(name: StringName) -> XRPose

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

func has_pose(name: StringName) -> bool

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

func invalidate_pose(name: StringName) -> void

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.

func set_input(name: StringName, value: Variant) -> void

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

func set_pose(name: StringName, transform: Transform3D, linear_velocity: Vector3, angular_velocity: Vector3, tracking_confidence: XRPose.TrackingConfidence) -> void

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.

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

signal button_pressed(action_name: String)

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

signal button_released(action_name: String)

Emitted when a button on this tracker is released.

signal input_float_changed(action_name: String, value: float)

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

signal input_vector2_changed(action_name: String, vector: Vector2)

Emitted when a thumbstick or thumbpad on this tracker moves.

signal pose_changed(pose: XRPose)

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

signal pose_lost_tracking(pose: XRPose)

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

signal profile_changed(role: String)

Emitted when the profile of our tracker changes.

Inherited from Object (2)

Enums & Constants

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.

TRACKER_HAND_MAX = 3

Represents the size of the TrackerHand enum.