IWebXRFeature | Babylon.js API documentation

Interface IWebXRFeature

Defining the interface required for a (webxr) feature

interface IWebXRFeature {
    attached: boolean;
    dependsOn?: string[];
    disableAutoAttach: boolean;
    getXRSessionInitExtension?: () => Promise<Partial<XRSessionInit>>;
    isDisposed: boolean;
    onFeatureAttachObservable: Observable<IWebXRFeature>;
    onFeatureDetachObservable: Observable<IWebXRFeature>;
    xrNativeFeatureName?: string;
    attach(force?: boolean): boolean;
    detach(): boolean;
    dispose(): void;
    isCompatible(): boolean;
}

Hierarchy (View Summary)

IDisposable
- IWebXRFeature
  - IWebXRHitTestFeature

Implemented by

WebXRAbstractFeature

Index

Properties

attached dependsOn? disableAutoAttach getXRSessionInitExtension? isDisposed onFeatureAttachObservable onFeatureDetachObservable xrNativeFeatureName?

Methods

attach detach dispose isCompatible

Properties

attached

attached: boolean

Is this feature attached

`Optional`dependsOn

dependsOn?: string[]

A list of (Babylon WebXR) features this feature depends on

disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

`Optional`getXRSessionInitExtension

getXRSessionInitExtension?: () => Promise<Partial<XRSessionInit>>

If this feature requires to extend the XRSessionInit object, this function will return the partial XR session init object

isDisposed

isDisposed: boolean

Was this feature disposed;

onFeatureAttachObservable

onFeatureAttachObservable: Observable<IWebXRFeature>

Triggered when the feature is attached

onFeatureDetachObservable

onFeatureDetachObservable: Observable<IWebXRFeature>

Triggered when the feature is detached

`Optional`xrNativeFeatureName

xrNativeFeatureName?: string

The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)

Methods

attach

attach(force?: boolean): boolean
Attach the feature to the session Will usually be called by the features manager
Parameters
- Optionalforce: boolean
  should attachment be forced (even when already attached)
Returns boolean
true if successful.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5973

detach

detach(): boolean
Detach the feature from the session Will usually be called by the features manager

Returns boolean
true if successful.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5980

dispose

dispose(): void
Releases all held resources

Returns void
Inherited from IDisposable.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:1928

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5987

Interface IWebXRFeature

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

attached

`Optional`dependsOn

disableAutoAttach

`Optional`getXRSessionInitExtension

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

`Optional`xrNativeFeatureName

Methods

attach

Parameters

Returns boolean

detach

Returns boolean

dispose

Returns void

isCompatible

Returns boolean

Settings

On This Page

Interface IWebXRFeature

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

attached

OptionaldependsOn

disableAutoAttach

OptionalgetXRSessionInitExtension

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

OptionalxrNativeFeatureName

Methods

attach

Parameters

Returns boolean

detach

Returns boolean

dispose

Returns void

isCompatible

Returns boolean

Settings

On This Page

`Optional`dependsOn

`Optional`getXRSessionInitExtension

`Optional`xrNativeFeatureName