WebXRMeshDetector | Babylon.js API documentation

Class WebXRMeshDetector

The mesh detector is used to detect meshes in the real world when in AR

Hierarchy (View Summary)

WebXRAbstractFeature
- WebXRMeshDetector

Index

Constructors

Constructors

constructor

new WebXRMeshDetector(
_xrSessionManager: WebXRSessionManager,
_options?: IWebXRMeshDetectorOptions,
): WebXRMeshDetector
Parameters
- _xrSessionManager: WebXRSessionManager
- Optional_options: IWebXRMeshDetectorOptions
Returns WebXRMeshDetector
Overrides WebXRAbstractFeature.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8310

Properties

`Optional`dependsOn

dependsOn?: string[]

The dependencies of this feature, if any

disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed

isDisposed: boolean

Is this feature disposed?

onFeatureAttachObservable

onFeatureAttachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is attached

onFeatureDetachObservable

onFeatureDetachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is detached

onMeshAddedObservable

onMeshAddedObservable: Observable<IWebXRVertexData>

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

onMeshRemovedObservable

onMeshRemovedObservable: Observable<IWebXRVertexData>

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

onMeshUpdatedObservable

onMeshUpdatedObservable: Observable<IWebXRVertexData>

Observers registered here will be executed when an existing mesh updates

`Static` `Readonly`Name

Name: "xr-mesh-detection"

The module's name

`Static` `Readonly`Version

Version: 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

Accessors

attached

get attached(): boolean
Is this feature attached

Returns boolean
Inherited from WebXRAbstractFeature.attached
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10881

xrNativeFeatureName

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

Returns string
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10859
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
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10860

Methods

attach

attach(force?: boolean): boolean
attach this feature
Parameters
- Optionalforce: boolean
  should attachment be forced (even when already attached)
Returns boolean
true if successful, false is failed or already attached
Inherited from WebXRAbstractFeature.attach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10888

detach

detach(): boolean
detach this feature.

Returns boolean
true if successful, false if failed or already detached
Overrides WebXRAbstractFeature.detach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8311

dispose

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

Returns void
Overrides WebXRAbstractFeature.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:8312

isCompatible

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
Inherited from WebXRAbstractFeature.isCompatible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10905

Class WebXRMeshDetector

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRMeshDetector

Properties

OptionaldependsOn

disableAutoAttach

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

onMeshAddedObservable

onMeshRemovedObservable

onMeshUpdatedObservable

Static ReadonlyName

Static ReadonlyVersion

Accessors

attached

Returns boolean

xrNativeFeatureName

Returns string

Parameters

Returns void

Methods

attach

Parameters

Returns boolean

detach

Returns boolean

dispose

Returns void

isCompatible

Returns boolean

Settings

On This Page

`Optional`dependsOn

`Static` `Readonly`Name

`Static` `Readonly`Version