Index · Object → RefCounted → XRPose

XRPose

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

Class Description

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.

Properties

var angular_velocity: Vector3 = Vector3(0, 0, 0)

The angular velocity for this pose.

var has_tracking_data: bool = false

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.

var linear_velocity: Vector3 = Vector3(0, 0, 0)

The linear velocity of this pose.

var 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.

var tracking_confidence: XRPose.TrackingConfidence = 0

The tracking confidence for this pose, provides insight on how accurate the spatial positioning of this record is.

var transform: Transform3D = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)

The transform containing the original and transform as reported by the XR runtime.

Methods

func get_adjusted_transform() -> Transform3D

Returns the transform with world scale and our reference frame applied. This is the transform used to position XRNode3D objects.

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

Inherited from Object (2)

Enums & Constants

enum TrackingConfidence
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.