Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

OpenXRPlaneTracker

Experimental: This class may be changed or removed in future versions.

Inherits: OpenXRSpatialEntityTracker < XRPositionalTracker < XRTracker < RefCounted < Object

Spatial entity tracker for our spatial entity plane tracking extension.

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

Vector2	bounds_size	`Vector2(0, 0)`
PlaneAlignment	plane_alignment	`0`
String	plane_label	`""`

Methods

void	clear_mesh_data()
Mesh	get_mesh()
Transform3D	get_mesh_offset() const
Shape3D	get_shape(thickness: float = 0.01)
void	set_mesh_data(origin: Transform3D, vertices: PackedVector2Array, indices: PackedInt32Array = PackedInt32Array())

Signals

mesh_changed() 🔗

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

Property Descriptions

Vector2 bounds_size = Vector2(0, 0) 🔗

void set_bounds_size(value: Vector2)
Vector2 get_bounds_size()

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

PlaneAlignment plane_alignment = 0 🔗

void set_plane_alignment(value: PlaneAlignment)
PlaneAlignment get_plane_alignment()

The main alignment in space of this plane.

String plane_label = "" 🔗

void set_plane_label(value: String)
String get_plane_label()

The semantic label for this plane.

Method Descriptions

void clear_mesh_data() 🔗

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

Mesh get_mesh() 🔗

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

Transform3D get_mesh_offset() const 🔗

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

Shape3D get_shape(thickness: float = 0.01) 🔗

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

void set_mesh_data(origin: Transform3D, vertices: PackedVector2Array, indices: PackedInt32Array = PackedInt32Array()) 🔗

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