Index · Object → RefCounted → XRTracker → XRPositionalTracker → OpenXRSpatialEntityTracker

OpenXRSpatialEntityTracker

Base class for Positional trackers managed by OpenXR's spatial entity extensions.

Inherited by (3): OpenXRAnchorTrackerOpenXRMarkerTrackerOpenXRPlaneTracker
Class Description

These are trackers created and managed by OpenXR's spatial entity extensions that give access to specific data related to OpenXR's spatial entities. They will always be of type TRACKER_ANCHOR.

Properties

var entity: RID = RID()

The spatial entity associated with this tracker.

var spatial_tracking_state: OpenXRSpatialEntityTracker.EntityTrackingState = 2

The spatial tracking state for this tracker.

var type: XRServer.TrackerType = 8
Inherited from XRPositionalTracker (2)
var profile: String = ""
Inherited from XRTracker (3)
var name: StringName = &"Unknown"

Methods

func add_next(next: OpenXRStructureBase) -> void

Adds a new OpenXRStructureBase to the next-chain.

get_next() will return this next until either add_next() is called again or it's removed in remove_next().

func get_next() -> OpenXRStructureBase

Gets the head OpenXRStructureBase in the next-chain.

See also add_next() and remove_next().

func get_spatial_context() -> RID

Gets the spatial context used to create this OpenXRSpatialEntityTracker.

func remove_next(next: OpenXRStructureBase) -> void

Removes a next object previously added in add_next() from the next-chain.

func set_spatial_context(spatial_context: RID) -> void

Sets the spatial context used to create this tracker.

Inherited from XRPositionalTracker (6)
func get_pose(name: StringName) -> XRPose
func has_pose(name: StringName) -> bool
func invalidate_pose(name: StringName) -> void
func set_input(name: StringName, value: Variant) -> void
func set_pose(name: StringName, transform: Transform3D, linear_velocity: Vector3, angular_velocity: Vector3, tracking_confidence: XRPose.TrackingConfidence) -> void
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 next_changed()

Emitted when the next-chain changes, from either add_next() or remove_next().

signal spatial_tracking_state_changed(spatial_tracking_state: int)
Inherited from XRPositionalTracker (7)
signal button_pressed(action_name: String)
signal button_released(action_name: String)
signal input_float_changed(action_name: String, value: float)
signal input_vector2_changed(action_name: String, vector: Vector2)
signal pose_changed(pose: XRPose)
signal profile_changed(role: String)
Inherited from Object (2)

Enums & Constants

enum EntityTrackingState
ENTITY_TRACKING_STATE_STOPPED = 1

This anchor has stopped tracking.

ENTITY_TRACKING_STATE_PAUSED = 2

Tracking is currently paused.

ENTITY_TRACKING_STATE_TRACKING = 3

This anchor is currently being tracked.