WebXRAbstractFeature | Babylon.js API documentation

Class WebXRAbstractFeature`Abstract`

This is the base class for all WebXR features. Since most features require almost the same resources and callbacks, this class can be used to simplify the development Note that since the features manager is using the IWebXRFeature you are in no way obligated to use this class

Implements

IWebXRFeature

Index

Constructors

constructor

new WebXRAbstractFeature(
_xrSessionManager: WebXRSessionManager,
): WebXRAbstractFeature
Construct a new (abstract) WebXR feature
Parameters
- _xrSessionManager: WebXRSessionManager
  the xr session manager for this feature
Returns WebXRAbstractFeature
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10877

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

Accessors

attached

get attached(): boolean
Is this feature attached

Returns boolean
Implementation of IWebXRFeature.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
Implementation of IWebXRFeature.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
Implementation of IWebXRFeature.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
Implementation of IWebXRFeature.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
Implementation of IWebXRFeature.detach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10894

dispose

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

Returns void
Implementation of IWebXRFeature.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10898

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
Implementation of IWebXRFeature.isCompatible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10905

Class WebXRAbstractFeature`Abstract`

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRAbstractFeature

Properties

`Optional`dependsOn

disableAutoAttach

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

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

Class WebXRAbstractFeatureAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRAbstractFeature

Properties

OptionaldependsOn

disableAutoAttach

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

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

Class WebXRAbstractFeature`Abstract`

`Optional`dependsOn