Class WebXRMeshDetector
Hierarchy (View Summary)
- WebXRAbstractFeature
- WebXRMeshDetector
Index
Constructors
constructor
-
new WebXRMeshDetector(
_xrSessionManager: WebXRSessionManager,
_options?: IWebXRMeshDetectorOptions,
): WebXRMeshDetectorParameters
- _xrSessionManager: WebXRSessionManager
- _options: IWebXRMeshDetectorOptions = {}
Returns WebXRMeshDetector
Properties
Optionaldepends
The dependencies of this feature, if any
disable
Should auto-attach be disabled?
is
Is this feature disposed?
on
Observers registered here will be executed when the feature is attached
on
Observers registered here will be executed when the feature is detached
on
Observers registered here will be executed when a new mesh was added to the session
on
Observers registered here will be executed when a mesh is no longer detected in the session
on
Observers registered here will be executed when an existing mesh updates
Static ReadonlyName
The module's name
Static ReadonlyVersion
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
-
get attached(): boolean
Is this feature attached
Returns boolean
xr
-
get xrNativeFeatureName(): string
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
Returns string
-
set xrNativeFeatureName(name: string): void
The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
Parameters
- name: string
Returns void
Methods
attach
-
attach this feature
Parameters
Optionalforce: booleanshould attachment be forced (even when already attached)
Returns boolean
true if successful, false is failed or already attached
detach
-
detach this feature.
Returns boolean
true if successful, false if failed or already detached
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 mesh detector is used to detect meshes in the real world when in AR