• Public
  • Public/Protected
  • All

Class 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/







disableAutoAttachSearch playground for disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposedSearch playground for isDisposed

isDisposed: boolean

Is this feature disposed?

onPlaneAddedObservableSearch playground for onPlaneAddedObservable

onPlaneAddedObservable: Observable<IWebXRPlane>

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

onPlaneRemovedObservableSearch playground for onPlaneRemovedObservable

onPlaneRemovedObservable: Observable<IWebXRPlane>

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

onPlaneUpdatedObservableSearch playground for onPlaneUpdatedObservable

onPlaneUpdatedObservable: Observable<IWebXRPlane>

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

xrNativeFeatureNameSearch playground for xrNativeFeatureName

xrNativeFeatureName: string

The name of the native xr feature name (like anchor, hit-test, or hand-tracking)

Static Readonly NameSearch playground for Name

Name: "xr-plane-detection" = "xr-plane-detection"

The module's name

Static Readonly VersionSearch playground for Version

Version: 1 = 1

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



  • get attached(): boolean


attachSearch playground for attach

  • attach(force?: boolean): boolean
  • attach this feature


    • Optional force: boolean

      should attachment be forced (even when already attached)

    Returns boolean

    true if successful, false is failed or already attached

detachSearch playground for detach

  • detach(): boolean
  • detach this feature. Will usually be called by the features manager

    Returns boolean

    true if successful.

disposeSearch playground for dispose

  • dispose(): void

isCompatibleSearch playground for isCompatible

  • isCompatible(): boolean
  • Check if the needed objects are defined. This does not mean that the feature is enabled, but that the objects needed are well defined.

    Returns boolean


  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method