Class WebXRFeaturePointSystem
Hierarchy
-
WebXRAbstractFeature
- WebXRFeaturePointSystem
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
construct the feature point system
Parameters
-
_xrSessionManager: WebXRSessionManager
an instance of xr Session manager
Returns WebXRFeaturePointSystem
-
Properties
disable
Should auto-attach be disabled?
is
Is this feature disposed?
Readonly on
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 on
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.
xr
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
Static Readonly NameSearch playground for Name
The module's name
Static Readonly VersionSearch playground for Version
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
-
Is this feature attached
Returns boolean
feature
-
The current feature point cloud maintained across frames.
Returns Array<IWebXRFeaturePoint>
Methods
attachSearch playground for attach
-
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
-
detachSearch playground for detach
-
Detach this feature. Will usually be called by the features manager
Returns boolean
true if successful.
disposeSearch playground for dispose
-
Dispose this feature and all of the resources attached
Returns void
is
-
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
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.