Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Application

Namespace for managing view modes (e.g. 3D, VR, AR) and Scene states.

Index

Variables

Const isMobile

isMobile: boolean

Returns true if this Scene is run on a mobile device (including tablet.)

Const isTablet

isTablet: boolean

Returns true if this Scene is run on a tablet.

Functions

onSceneExit

  • Defines the onExit handler which triggers before this Scene is ended.

    Note: Unlike other event-handlers, this method can be called multiple times to add additional functions to be called on scene exit.

    Parameters

    • onExit: function

      function to call when Scene ends.

        • (): void
        • Returns void

    Returns Disposable

onSceneSwitch

  • Defines the onSceneSwitch handler which triggers before this Scene changes to another.

    Note: Unlike other event-handlers, this method can be called multiple times to add additional functions to be called on scene switch.

    Parameters

    • handler: function

      function to call when Scene switches. Provides an index parameter for the target Scene.

        • (t: number): void
        • Parameters

          • t: number

          Returns void

    Returns Disposable

quit

  • quit(): void
  • quit(imageId: string): void
  • Quits this Space and returns the user to the previous screen.

    Returns void

  • Quits this Space and returns the user to the previous screen.

    Parameters

    • imageId: string

      image shown on play screen.

    Returns void

Generated using TypeDoc