WebXRFeaturePointSystem

The feature point system is used to detect feature points from real world geometry. This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser. The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground

Properties

disableAutoAttach

Find examples in Playground
disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed

Find examples in Playground
isDisposed: boolean

Is this feature disposed?

Readonly onFeaturePointsAddedObservable

Find examples in Playground
onFeaturePointsAddedObservable: Observable<number[]>

Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking). Will notify the observers about which feature points have been added.

Readonly onFeaturePointsUpdatedObservable

Find examples in Playground
onFeaturePointsUpdatedObservable: Observable<number[]>

Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking). Will notify the observers about which feature points have been updated.

xrNativeFeatureName

Find examples in Playground
xrNativeFeatureName: string

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

Static Readonly Name

Find examples in Playground
Name: string

The module's name

Static Readonly 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

featurePointCloud

Find examples in Playground
  • The current feature point cloud maintained across frames.

    Returns Array<IWebXRFeaturePoint>

Methods

attach

Find examples in Playground
  • attach(force?: boolean): boolean
  • attach this feature

    Parameters

    • Optional force: boolean

      should attachment be forced (even when already attached)

    Returns boolean

    true if successful, false is failed or already attached

detach

Find examples in Playground
  • detach(): boolean

dispose

Find examples in Playground
  • dispose(): void

isCompatible

Find examples in Playground
  • isCompatible(): boolean
  • This function will be executed during before enabling the feature and can be used to not-allow enabling it. Note that at this point the session has NOT started, so this is purely checking if the browser supports it

    Returns boolean

    whether or not the feature is compatible in this environment

Generated using TypeDoc