Options
All
  • Public
  • Public/Protected
  • All
Menu

UI to allow the user to enter/exit XR mode

Hierarchy

  • WebXREnterExitUI

Implements

Index

Constructors

  • Construct a new EnterExit UI class

    Parameters

    Returns WebXREnterExitUI

Properties

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)

version of the options passed to this UI

overlay: HTMLDivElement

The HTML Div Element to which buttons are added.

Methods

  • dispose(): void
  • Disposes of the XR UI component

    Returns void

  • 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

    Returns Promise<void>

    a promise that resolves when the ui is ready

  • Creates UI to allow the user to enter/exit XR mode

    Parameters

    Returns Promise<WebXREnterExitUI>

    the created ui

Legend

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

Settings

Theme