Skip to main content

Class: DetectedPlane

Defined in: src/world/planes/DetectedPlane.ts:9

Represents a single detected plane in the XR environment. It's a THREE.Mesh that also holds metadata about the plane's properties. Note: This requires chrome://flags/#openxr-spatial-entities to be enabled.

Extends​

Constructors​

Constructor​

new DetectedPlane(xrPlane, material, simulatorPlane?): DetectedPlane

Defined in: src/world/planes/DetectedPlane.ts:25

Parameters​

xrPlane​

The plane object from the WebXR API.

XRPlane | null

material​

Material

The material for the mesh.

simulatorPlane?​

SimulatorPlane

Returns​

DetectedPlane

Overrides​

THREE.Mesh.constructor

Properties​

label?​

optional label: string

Defined in: src/world/planes/DetectedPlane.ts:14

A semantic label for the plane (e.g., 'floor', 'wall', 'ceiling', 'table'). Since xrPlane.semanticLabel is readonly, this allows user authoring.

orientation?​

optional orientation: XRPlaneOrientation

Defined in: src/world/planes/DetectedPlane.ts:19

The orientation of the plane ('Horizontal' or 'Vertical').

simulatorPlane?​

optional simulatorPlane: SimulatorPlane

Defined in: src/world/planes/DetectedPlane.ts:28

xb?​

optional xb: XBObjectOptions

Defined in: src/interaction/InteractionTypes.ts:34

Inherited from​

THREE.Mesh.xb

xrPlane​

xrPlane: XRPlane | null

Defined in: src/world/planes/DetectedPlane.ts:26

The plane object from the WebXR API.