Class WebXRMeshDetector
Hierarchy
-
WebXRAbstractFeature
- WebXRMeshDetector
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Parameters
-
_xrSessionManager: WebXRSessionManager
-
Optional _options: IWebXRMeshDetectorOptions
Returns WebXRMeshDetector
-
Properties
disable Auto AttachSearch playground for disableAutoAttach
Should auto-attach be disabled?
is DisposedSearch playground for isDisposed
Is this feature disposed?
on Mesh Added ObservableSearch playground for onMeshAddedObservable
Observers registered here will be executed when a new mesh was added to the session
on Mesh Removed ObservableSearch playground for onMeshRemovedObservable
Observers registered here will be executed when a mesh is no longer detected in the session
on Mesh Updated ObservableSearch playground for onMeshUpdatedObservable
Observers registered here will be executed when an existing mesh updates
xr Native Feature NameSearch playground for xrNativeFeatureName
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
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
-
Returns boolean
disposeSearch playground for dispose
-
Returns void
is CompatibleSearch playground for isCompatible
-
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 mesh detector is used to detect meshes in the real world when in AR