WebXREnterExitUI

Class WebXREnterExitUI

UI to allow the user to enter/exit XR mode

Hierarchy

WebXREnterExitUI

Implements

IDisposable

Index

Properties

Methods

Properties

activeButtonChangedObservableSearch 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)

optionsSearch playground for options

options: WebXREnterExitUIOptions

version of the options passed to this UI

Readonly overlaySearch playground for overlay

overlay: HTMLDivElement

The HTML Div Element to which buttons are added.

Methods

disposeSearch playground for dispose

dispose(): void

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

Returns void

Static CreateAsyncSearch playground for CreateAsync

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

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