Transition animator

TransitionAnimator

2024.7.10

yisky

Hierarchy

  • EngineObject
    • TransitionAnimator

Constructors

  • Parameters

    • engine: Engine
    • sourceScene: Scene
    • sourceCamera: Camera
    • targetScene: Scene
    • targetCamera: Camera
    • options: TransitionOptions = {}

    Returns TransitionAnimator

Properties

autoSwap: boolean

Whether auto swap source scene and target scene when transition finish.

TransitionAnimator

easing: EasingMethod

Trasition easing type.

TransitionAnimator

engine: Engine
totalTime: number

Transition total time in seconds.

TransitionAnimator

Accessors

  • get isPlaying(): boolean
  • Specifies whether is playing transition animation.

    Returns boolean

    TransitionAnimator

Methods

  • Dispose

    Returns void

    TransitionAnimator

  • Emit event

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    EventDispatcher

  • Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

    Parameters

    • type: string
    • Optionalcallback: SubscriberCallbackFn

      subscriber callback

    Returns void

    EventDispatcher

  • Subscribe a event

    Parameters

    • type: string

      event type

    • callback: SubscriberCallbackFn

      callback functions

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }

      options

      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    EventDispatcher

  • Subscribe a event, just emit once

    Parameters

    • type: string
    • callback: SubscriberCallbackFn

      subscriber callback

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }
      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    EventDispatcher

  • Pasue transition animation

    Returns void

    TransitionAnimator

  • Play transition animation

    Returns void

    TransitionAnimator

  • Stop transition animation

    Returns void

    TransitionAnimator