Babylon.js API documentation|

WebXREnterExitUI

Class WebXREnterExitUI

UI to allow the user to enter/exit XR mode

Hierarchy

WebXREnterExitUI

Implements

IDisposable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebXREnterExitUI(_scene: Scene, options: WebXREnterExitUIOptions): WebXREnterExitUI

- Defined in .temp/docdirectory/doc.d.ts:110763
Construct a new EnterExit UI class

Parameters
- _scene: Scene
  
  babylon scene object to use
- options: WebXREnterExitUIOptions
  
  (read-only) version of the options passed to this UI
Returns WebXREnterExitUI

Properties

activeButtonChangedObservable Search playground for activeButtonChangedObservable

activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>

Fired every time the active button is changed.

When xr is entered via a button that launches xr that button will be the callback parameter

When exiting xr the callback parameter will be null)

options Search playground for options

options: WebXREnterExitUIOptions

version of the options passed to this UI

Readonly overlay Search playground for overlay

overlay: HTMLDivElement

The HTML Div Element to which buttons are added.

Methods

dispose Search playground for dispose

dispose(): void

Implementation of IDisposable.dispose
- Defined in .temp/docdirectory/doc.d.ts:110787
Disposes of the XR UI component

Returns void

setHelperAsync Search playground for setHelperAsync

setHelperAsync(helper: WebXRExperienceHelper, renderTarget?: WebXRRenderTarget): Promise<void>

- Defined in .temp/docdirectory/doc.d.ts:110774
Set the helper to be used with this UI component. The UI is bound to an experience helper. If not provided the UI can still be used but the events should be registered by the developer.

Parameters
- helper: WebXRExperienceHelper
  
  the experience helper to attach
- Optional renderTarget: WebXRRenderTarget
  
  an optional render target (in case it is created outside of the helper scope)
Returns Promise<void>
a promise that resolves when the ui is ready

Static CreateAsync Search playground for CreateAsync

CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>

- Defined in .temp/docdirectory/doc.d.ts:110782
Creates UI to allow the user to enter/exit XR mode

Parameters
- scene: Scene
  
  the scene to add the ui to
- helper: WebXRExperienceHelper
  
  the xr experience helper to enter/exit xr with
- options: WebXREnterExitUIOptions
  
  options to configure the UI
Returns Promise<WebXREnterExitUI>
the created ui