WebXRBackgroundRemover

A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground

Properties

disableAutoAttach

Find examples in Playground
disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed

Find examples in Playground
isDisposed: boolean

Is this feature disposed?

onBackgroundStateChangedObservable

Find examples in Playground
onBackgroundStateChangedObservable: Observable<boolean>

registered observers will be triggered when the background state changes

Readonly options

Find examples in Playground

read-only options to be used in this module

xrNativeFeatureName

Find examples in Playground
xrNativeFeatureName: string

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

Static Readonly Name

Find examples in Playground
Name: string

The module's name

Static Readonly Version

Find examples in Playground
Version: number

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

Find examples in Playground
  • get attached(): boolean

Methods

attach

Find examples in Playground
  • attach(): boolean
  • attach this feature Will usually be called by the features manager

    Returns boolean

    true if successful.

detach

Find examples in Playground
  • detach(): boolean

dispose

Find examples in Playground
  • dispose(): void

isCompatible

Find examples in Playground
  • 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

Generated using TypeDoc