• Public
  • Public/Protected
  • All

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/





disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed: boolean

Is this feature disposed?

onPlaneAddedObservable: Observable<IWebXRPlane>

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

onPlaneRemovedObservable: Observable<IWebXRPlane>

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

onPlaneUpdatedObservable: Observable<IWebXRPlane>

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

xrNativeFeatureName: string

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

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

The module's name

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
  • Is this feature attached

    Returns boolean


  • 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

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

    Returns boolean

    true if successful.

  • dispose(): void
  • Dispose this feature and all of the resources attached

    Returns void

  • initiateRoomCapture(): Promise<void>
  • 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
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static property
  • Static method