Index · Object → RefCounted → XRTracker → XRPositionalTracker → OpenXRSpatialEntityTracker → OpenXRPlaneTracker

OpenXRPlaneTracker

Spatial entity tracker for our spatial entity plane tracking extension.

Class Description

Spatial entity tracker for our OpenXR spatial entity plane tracking extension. These trackers identify entities in our real space such as walls, floors, tables, etc. and map their location to our virtual space.

Properties

var bounds_size: Vector2 = Vector2(0, 0)

The bounding size of the plane. This is a 2D size.

var plane_alignment: OpenXRSpatialComponentPlaneAlignmentList.PlaneAlignment = 0

The main alignment in space of this plane.

var plane_label: String = ""

The semantic label for this plane.

Inherited from OpenXRSpatialEntityTracker (3)
var entity: RID = RID()
Inherited from XRPositionalTracker (2)
var profile: String = ""
Inherited from XRTracker (3)
var name: StringName = &"Unknown"

Methods

func clear_mesh_data() -> void

Clears the mesh data for this tracker. You should only call this if you are handling your own discovery logic.

func get_mesh() -> Mesh

Gets a mesh created from either the mesh data or from our bounding size for this plane.

func get_mesh_offset() -> Transform3D

Gets the transform by which to offset the mesh and collision shape from our pose to display these correctly.

func get_shape(thickness: float = 0.01) -> Shape3D

Gets a collision shape built either from the mesh data or from our bounding size for this plane.

func set_mesh_data(origin: Transform3D, vertices: PackedVector2Array, indices: PackedInt32Array = PackedInt32Array()) -> void

Sets the mesh data for this plane. You should only call this if you are handling your own discovery logic.

Inherited from OpenXRSpatialEntityTracker (5)
func add_next(next: OpenXRStructureBase) -> void
func remove_next(next: OpenXRStructureBase) -> void
func set_spatial_context(spatial_context: RID) -> void
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 mesh_changed()

Emitted when our mesh data has changed the mesh instance and collision needs to be updated.

Inherited from OpenXRSpatialEntityTracker (2)
signal next_changed()
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)