Options
All
  • Public
  • Public/Protected
  • All
Menu

Defining the interface required for a (webxr) feature

Hierarchy

Implemented by

Index

Properties

attached: boolean

Is this feature attached

dependsOn?: string[]

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

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed: boolean

Was this feature disposed;

xrNativeFeatureName?: string

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

Methods

  • attach(force?: boolean): boolean
  • Attach the feature to the session Will usually be called by the features manager

    Parameters

    • Optional force: boolean

      should attachment be forced (even when already attached)

    Returns boolean

    true if successful.

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

    Returns boolean

    true if successful.

  • dispose(): void
  • Releases all held resources

    Returns void

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

    Returns Promise<Partial<XRSessionInit>>

  • 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

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme