WebXRPlaneDetector

The plane detector is used to detect planes in the real world when in AR For more information see https://github.com/immersive-web/real-world-geometry/

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground

Properties

onPlaneAddedObservable

Find examples in Playground
onPlaneAddedObservable: Observable<IWebXRPlane>

Observers registered here will be executed when a new plane was added to the session

onPlaneRemovedObservable

Find examples in Playground
onPlaneRemovedObservable: Observable<IWebXRPlane>

Observers registered here will be executed when a plane is no longer detected in the session

onPlaneUpdatedObservable

Find examples in Playground
onPlaneUpdatedObservable: Observable<IWebXRPlane>

Observers registered here will be executed when an existing plane updates (for example - expanded) This can execute N times every frame

Static Name

Find examples in Playground
Name: string

The module's name

Static Version

Find examples in Playground
Version: number

The (Babylon) version of this module. This is an integer representing the implementation version. This number does not correspond to the webxr specs version

Accessors

attached

Find examples in Playground
  • get attached(): boolean

Methods

attach

Find examples in Playground
  • attach(): boolean

detach

Find examples in Playground
  • detach(): boolean

dispose

Find examples in Playground
  • dispose(): void

Generated using TypeDoc