Class SceneSwitcher

Hierarchy (view full)

Properties

preloadConcurrent preloadNext preloadPrevious queryParameterName useHistory useKeyboard useSceneLighting useSceneName useSwipe

Accessors

activeAndEnabled context currentIndex destroyed enabled forward hideFlags isComponent layer name right scene static tag up worldEuler worldPosition worldQuaternion worldRotation

Methods

__internalSwitchScene addEventListener awake destroy dispatchEvent earlyUpdate? lateUpdate? onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? preload removeEventListener resolveGuids? select selectNext selectPrev setWorldPosition setWorldQuaternion setWorldRotation start startCoroutine stopCoroutine switchScene update?

Properties

preloadConcurrent

preloadConcurrent: number = 2

how many scenes can be loaded in parallel

preloadNext

preloadNext: number = 1

how many scenes after the currently active scene should be preloaded

preloadPrevious

preloadPrevious: number = 1

how many scenes before the currently active scene should be preloaded

queryParameterName

queryParameterName: string = "scene"

the url parameter that is set/used to store the currently loaded scene in, set to "" to disable

useHistory

useHistory: boolean = true

when enabled the new scene is pushed to the browser navigation history, only works with a valid query parameter set

useKeyboard

useKeyboard: boolean = true

when enabled you can switch between scenes using keyboard left, right, A and D or number keys

useSceneLighting

useSceneLighting: boolean = true

when enabled will automatically apply the environment scene lights

useSceneName

useSceneName: boolean = true

when enabled the scene name will be used as the query parameter (otherwise the scene index will be used) Needs queryParameterName set

useSwipe

useSwipe: boolean = true

when enabled you can switch between scenes using swipe (mobile only)

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

currentIndex

  • get currentIndex(): number

  • Returns number

destroyed

  • get destroyed(): boolean

  • Returns boolean

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

scene

  • get scene(): Scene

  • Returns Scene

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

up

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    Returns void

Methods

__internalSwitchScene

addEventListener

  • addEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((evt) => any)
        • (evt): any

        • Parameters

          • evt: T

          Returns any

    Returns void

awake

  • awake(): void

  • called once when the component becomes active for the first time

    Returns void

destroy

dispatchEvent

Optional earlyUpdate

Optional lateUpdate

Optional onAfterRender

Optional onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

onDisable

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)

    Returns void

Optional onTriggerEnter

Optional onTriggerExit

Optional onTriggerStay

Optional onValidate

  • onValidate(prop?): void

  • called when you decorate fields with the @validate() decorator

    Parameters

    • Optional prop: string

    Returns void

preload

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((arg) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

Optional resolveGuids

  • resolveGuids(guidsMap): void

  • called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them)

    Parameters

    • guidsMap: GuidsMap

    Returns void

select

  • select(index): Promise<boolean>

  • Parameters

    • index: string | number

    Returns Promise<boolean>

selectNext

selectPrev

setWorldPosition

setWorldQuaternion

  • setWorldQuaternion(x, y, z, w): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns void

setWorldRotation

  • setWorldRotation(x, y, z, degrees?): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • degrees: boolean = true

    Returns void

start

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

    • routine: Generator<unknown, any, unknown>
    • evt: FrameEvent = FrameEvent.Update

    Returns void

switchScene

Optional update

Settings

Member Visibility

Theme

On This Page

preloadConcurrentpreloadNextpreloadPreviousqueryParameterNameuseHistoryuseKeyboarduseSceneLightinguseSceneNameuseSwipeactiveAndEnabledcontextcurrentIndexdestroyedenabledforwardhideFlagsisComponentlayernamerightscenestatictagupworldEulerworldPositionworldQuaternionworldRotation__internalSwitchSceneaddEventListenerawakedestroydispatchEventearlyUpdatelateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonTriggerEnteronTriggerExitonTriggerStayonValidatepreloadremoveEventListenerresolveGuidsselectselectNextselectPrevsetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineswitchSceneupdate

Generated using TypeDoc