Implements

  • _SceneImpl

Constructors

  • Parameters

    • story: _StoryImpl
    • sceneSelector: SceneSelector
    • prevScene: any

    Returns _Scene

Properties

_actionRgMaps: _ActionRgMaps = []

_actionRgMaps are 'maps' between the input animations and the output action for every frame. _actionRgMaps allow for a new animation to have access to the last modified value of a property of an element of the previous animation. And in a backward motion allows to retrieve the original value.

_addAnimationCallCount: uint = 0

Increases inside an addAnimation. It used to avoid multiple calls during teleporting.

_frameCount: int = 0
_frameInNr: uint = 0
_frames: _Frame[] = []

Internal list of all the scene frames.

_nextScene: _Scene

Pointer to next scene. Used by scene transitions.

_prevScene: _Scene

Pointer to previous scene. Used by scene transitions.

_renderFramePos: int = 0

Internal position of where the render pipeline was consumed.

_sceneAdpt: _SceneAdapter
_story: _StoryImpl
_storyFrameStart: int = 0
_storySceneIndex: int = -1
_transitionInterpolator: any = ...
name?: string

Name assigned by the user, and can be used to find the scene by name.

Accessors

  • get frameCount(): uint
  • Total number of frames contained the scene.

    #end-user

    Returns uint

  • get frameInNr(): uint
  • Defines the end of the scene pipeline. Usually this value is the same as frameCount but for off-sync animations frameInNr can have less value than frameCount.

    #end-user

    Returns uint

  • get id(): string
  • Scene id from the DOM element.

    #end-user

    Returns string

  • get storyFrameStart(): uint
  • Sum of all the frames from the previous scenes.

    #end-user

    Returns uint

  • get storySceneIndex(): uint
  • Zero-based Index of this scene within the list of scenes.

    #end-user

    Returns uint

  • get transition(): Transition
  • Returns scene transition information.

    Returns Transition

    transitions

  • set transition(transition): void
  • Defines the scene transition selector (name or function) and duration.

    Parameters

    • transition: Transition

    Returns void

    transitions

Methods

  • Parameters

    • storyFramePos: int

    Returns boolean

  • Parameters

    • framePos: int

    Returns void

  • Returns void

  • Creates the interpolator animations for Scene.addAnimations.

    Parameters

    • animes: Animations

    Returns _ElWorkAnimation[]

  • Parameters

    • storyFramePos: int

    Returns boolean

  • Parameters

    • framePos: int

    Returns void

  • Parameters

    • framePos: int
    • dir: DirectionInt
    • isVerbose: boolean
    • bypassMode: boolean

    Returns void

  • Removes it self from the story. Used internally.

    Returns void

  • Parameters

    • pos: uint
    • elementAdpt: _ElementAdapter
    • pi: _PropInterpolator
    • action: _Action
    • v: ActionValue

    Returns void

  • Parameters

    • storyFramePos: int
    • storySceneIndex: int

    Returns int

  • Prepares the transitions when the rendering process starts

    Returns void

  • Returns void

  • Adds a list of parallel animations to the render pipeline. The animations can start off-sync from each other via Position parameter.

    Parameters

    • animes: Animations

    Returns Scene

    animations

  • Adds a list of serial animations to the render pipeline. This is the same as: serialAnimes.forEach(anime => addAnimations(anime)) Use this if you want to load all animations from an external file.

    Parameters

    • serialAnimes: Animations[]

    Returns Scene

  • Adds a series of motionless frames defined by duration. This method changes the end of the pipeline (frameInNr).

    Parameters

    • duration: TimeHandler

    Returns Scene

  • Used only task plugin creators.

    Parameters

    • selector: ElSelectorHandler

    Returns ElementAdapter[]

  • Creates a pEls from the selectors.

    Parameters

    • selector: ElSelector

    Returns pEls

  • Wrapper for addAnimation with visible = false, followed by opacity moving to 1.

    Parameters

    • selector: ElSelector
    • Optionalduration: TimeHandler

    Returns pEls

  • Wrapper for addAnimation with opacity moving to 0, followed by visible = false

    Parameters

    • selector: ElSelector
    • Optionalduration: TimeHandler

    Returns pEls

  • Adds visible = false to the pipeline.

    Parameters

    • selector: ElSelector

    Returns pEls

  • Adds visible = true to the pipeline.

    Parameters

    • selector: ElSelector

    Returns pEls