Skip to main content

Class: DetectedPlane

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

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 experimental flag for Chrome.

Extends​

Constructors​

Constructor​

new DetectedPlane(xrPlane, material): DetectedPlane

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

Parameters​

xrPlane​

XRPlane

The plane object from the WebXR API.

material​

Material

The material for the mesh.

Returns​

DetectedPlane

Overrides​

THREE.Mesh.constructor

Properties​

label​

label: string

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

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

orientation​

orientation: XRPlaneOrientation

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

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

xrPlane​

xrPlane: XRPlane

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

The underlying XRPlane object from the WebXR API.

See​

https://immersive-web.github.io/real-world-geometry/plane-detection.html#xrplane