Class _Story

Implementation of _Story class.

Implements

  • _StoryImpl

Constructors

constructor

Properties

_args _curScene _frameCount _frameCountChanged _height _isRendering _isServerReady _isTeleporting _isVerbose _logLevel _metadata _queueRenders _renderDir _renderFrameCount _renderFrameEnd _renderFramePos _renderPlaySpeed _renderStage _renderTimer _renderTimeStamp _scenes _strictMode _teleporter _virtualAnimatorMap _virtualAnimators? _waitMan _width _wkFlyovers bestPlaySpeed defaultUnit fps hasServer onAfterRenderFrame? onBeforeRenderFrame? onGetVirtualElement? onNextFrame? onRenderFinished? onServerReady? serverFeatures serverName storyAdapter toExitOnRenderFinished

Accessors

args curScene frameCount height isRendering isTeleporting isVerbose logLevel metadata renderDir renderFrameCount renderFrameEnd renderFramePos scenes strictMode virtualAnimators width

Methods

_calcFrameCount _calcRenderFrameOptions _exceptIfRendering _getSceneByHandler _internalGetServerMsg _internalGotoFrame _internalGotoScene _internalRender _renderLoop _sendCmd _setFrameCountChanged _setupTransitions addDefaultScenes addFlyover addScene addStoryAnimations addStoryAnimationsBySceneId addVirtualAnimator clear exit findSceneByName finishRender getElementAdapters getStoryToTeleport getStoryToTeleportAsConfig gotoFrame gotoScene logError logFrmt logMsg logWarn removeScene removeVirtualAnimator render rewind startTeleporting teleport

Constructors

constructor

  • new _Story(cfg, createParams): _Story

  • Sets up the Story and adds the Default Scenes.

    Parameters

    Returns _Story

Properties

_args

_args: BeamToIXArgs = ...

Protected_curScene

_curScene: any = undefined

Protected_frameCount

_frameCount: uint = 0

Protected_frameCountChanged

_frameCountChanged: boolean = false

Protected_height

_height: uint = 0

Protected_isRendering

_isRendering: boolean = false

Protected_isServerReady

_isServerReady: boolean = false

Protected_isTeleporting

_isTeleporting: boolean

_isVerbose

_isVerbose: boolean

_logLevel

_logLevel: uint = 0

Defines the log level. Use LL_VERBOSE for debugging. The server can modify this mode.

Protected_metadata

_metadata: StoryMetadata = {}

Protected_queueRenders

_queueRenders: _RenderFrameOptionsEx[] = []

Protected_renderDir

_renderDir: -1 | 1 = 1

Protected_renderFrameCount

_renderFrameCount: uint = 0

Protected_renderFrameEnd

_renderFrameEnd: uint = 0

Protected_renderFramePos

_renderFramePos: uint = 0

Protected_renderPlaySpeed

_renderPlaySpeed: uint = 0

Protected_renderStage

_renderStage: uint = 0

Protected_renderTimer

_renderTimer: number

Protected_renderTimeStamp

_renderTimeStamp: Date

Protected_scenes

_scenes: _SceneImpl[] = []

_strictMode

_strictMode: boolean = false

If true, the input parameters have strict checks and throw errors if fails. If false, BeamToIX is more relax and bypasses errors. The server can modify this mode on startup.

Default

false

_teleporter

_teleporter: _Teleporter

Protected_virtualAnimatorMap

_virtualAnimatorMap: {
    [selector: number]: VirtualAnimator;
} = {}

Internal map from selectors to VirtualAnimators. Each animator must have a unique selector, but future versions might support different animators have the selector.

Optional_virtualAnimators

_virtualAnimators?: VirtualAnimator[] = []

_waitMan

_waitMan: _WaitMan

Protected_width

_width: uint = 0

Protected_wkFlyovers

_wkFlyovers: _WorkFlyover[] = []

bestPlaySpeed

bestPlaySpeed: (() => uint) = ...

Returns the play speed that best matches the fps.

defaultUnit

defaultUnit: TimeUnit = TimeUnit.f

Default unit used when input time values are used in numeric forms. Supports minutes, seconds, milliseconds and frames. TimeUnit.f = 0; TimeUnit.ms = 1; TimeUnit.s = 2; TimeUnit.m = 3;

Readonlyfps

fps: uint

Frames per second. All the time values is converted into frames using this value. Defined during the call to createStory.

#end-user

ReadonlyhasServer

hasServer: boolean = false

True if it's running a supporting server program for frame storage.

#end-user

OptionalonAfterRenderFrame

onAfterRenderFrame?: ((args?: BeamToIXArgs) => void)

Event triggered after a frame is rendered.

OptionalonBeforeRenderFrame

onBeforeRenderFrame?: ((args?: BeamToIXArgs) => void)

Event triggered before a frame is rendered.

OptionalonGetVirtualElement

onGetVirtualElement?: ((id: string, args?: BeamToIXArgs) => VirtualElement)

Maps Ids into Virtual Elements Used only in non-DOM elements such as WebGL elements.

Type declaration

    • (id, args?): VirtualElement

    • Parameters

      • id: string

        virtual element Id without '%'

      • Optionalargs: BeamToIXArgs

      Returns VirtualElement

OptionalonNextFrame

onNextFrame?: ((args?: BeamToIXArgs) => void)

Event triggered during the rendering process after a frame is rendered and is ready to move to following frame.

OptionalonRenderFinished

onRenderFinished?: ((args?: BeamToIXArgs) => void)

Event triggered when render finished the rendering process. EXPERIMENTAL The behavior can changed or be deprecated.

OptionalonServerReady

onServerReady?: ((args?: BeamToIXArgs) => void)

Event triggered by server, stating that it's ready to receive frames. A server is usually a headless capture program such as puppeteer. If the animation is running without server, this event is never fired.

serverFeatures

serverFeatures: ServerFeatures

Provides information about the running server.

ReadonlyserverName

serverName: string

The name of the server. The server will assign this property value.

#end-user

storyAdapter

storyAdapter: SceneAdapter

Allows flyovers to find elements on the document body or in the virtual world.

toExitOnRenderFinished

toExitOnRenderFinished: boolean = true

If true, it terminates the server when the render call finishes or if it's aborted. For a serverless execution, it has no effect.

Default

true

Accessors

args

  • get args(): BeamToIXArgs

  • Returns BeamToIXArgs. This should be used only in specific cases such the access to --var. In most cases, this property is passed as an argument to plugins and callbacks.

    #end-user

    Returns BeamToIXArgs

curScene

  • get curScene(): any

  • Current active and visible scene. Valid both for adding animations and rendering. Use gotoScene to change this value.

    #end-user

    Returns any

frameCount

  • get frameCount(): uint

  • Total number of frames from all the scenes.

    #end-user

    Returns uint

height

  • get height(): uint

  • Numerical value of the frame height in pixels.

    #end-user

    Returns uint

isRendering

  • get isRendering(): boolean

  • True if the rendering has started. Use finishRender to abort the rendering process.

    #end-user

    Returns boolean

isTeleporting

  • get isTeleporting(): boolean

  • True if it's teleporting.

    #end-user

    Returns boolean

isVerbose

  • get isVerbose(): boolean

  • Returns boolean

logLevel

  • get logLevel(): uint

  • Returns uint

  • set logLevel(newLogLevel): void

  • Parameters

    • newLogLevel: uint

    Returns void

metadata

  • get metadata(): StoryMetadata

  • Numerical value of the frame width in pixels.

    #end-user

    Returns StoryMetadata

renderDir

  • get renderDir(): DirectionInt

  • Render direction. 1 for forward, -1 for backwards. Defined during the call to story.render.

    #end-user

    Returns DirectionInt

renderFrameCount

  • get renderFrameCount(): uint

  • The number of the current frame being rendered. Defined during the call to story.render. This value doesn't changes during the rendering process.

    #end-user

    Returns uint

renderFrameEnd

  • get renderFrameEnd(): uint

  • The number of the last frame to be rendered within the story. Defined during the call to story.render. This value doesn't changes during the rendering process.

    #end-user

    Returns uint

renderFramePos

  • get renderFramePos(): uint

  • The number of the current frame being rendered. Defined during the call to story.render. This value changes during the rendering process.

    #end-user

    Returns uint

scenes

  • get scenes(): Scene[]

  • List of the scenes.

    #end-user

    Returns Scene[]

strictMode

  • get strictMode(): boolean

  • Returns boolean

  • set strictMode(newStrictMode): void

  • Parameters

    • newStrictMode: boolean

    Returns void

virtualAnimators

  • get virtualAnimators(): VirtualAnimator[]

  • Returns VirtualAnimator[]

    Deprecated

    Use addVirtualAnimator instead. The direct access to virtualAnimators in future versions will likely be disabled

width

  • get width(): uint

  • Numerical value of the frame width in pixels.

    #end-user

    Returns uint

Methods

_calcFrameCount

  • _calcFrameCount(): void

  • Recomputes the total number of frames as well as other scene parameters associated with frames.

    Returns void

Protected_calcRenderFrameOptions

  • _calcRenderFrameOptions(frameOpts): boolean

  • Computes the render properties from the user frame params.

    Parameters

    Returns boolean

_exceptIfRendering

  • _exceptIfRendering(): void

  • Throws exception if is rendering.

    Returns void

Protected_getSceneByHandler

  • _getSceneByHandler(scene): _SceneImpl

  • Parameters

    • scene: any

    Returns _SceneImpl

_internalGetServerMsg

  • _internalGetServerMsg(cmd, _value): void

  • This method is called by the server to communicate with the client.

    Parameters

    • cmd: string
    • _value: string

    Returns void

Protected_internalGotoFrame

  • _internalGotoFrame(framePos): void

  • Parameters

    • framePos: int

    Returns void

_internalGotoScene

  • _internalGotoScene(scene): void

  • Internal and faster version of gotoScene.

    Parameters

    • scene: any

    Returns void

Protected_internalRender

  • _internalRender(playSpeedMs?, frameOpts?): void

  • Parameters

    Returns void

Protected_renderLoop

  • _renderLoop(): void

  • Renders each frame at a pre-defined speed.

    Returns void

Protected_sendCmd

  • _sendCmd(cmd, value?): void

  • Parameters

    • cmd: string
    • Optionalvalue: string

    Returns void

_setFrameCountChanged

  • _setFrameCountChanged(): void

  • Signals that there was a change in the number of frames. Usually used by addAnimations.

    Returns void

Protected_setupTransitions

  • _setupTransitions(): void

  • Returns void

addDefaultScenes

  • addDefaultScenes(): void

  • Adds scenes defined in the html by .beamtoix-scene class. These classes are added automatically during Story constructor. Add only after a story.reset().

    Returns void

addFlyover

  • addFlyover(handler, params?): void

  • Adds a flyover, which is a function executed on every render step.

    Parameters

    • handler: FlyoverHandler
    • Optionalparams: FlyoverParams

    Returns void

    See

    flyovers

addScene

  • addScene(sceneSelector): Scene

  • Adds a scene to the story. HTML elements with beamtoix-scene class are added automatically.

    Parameters

    • sceneSelector: SceneSelector

      DOM selector, JQuery object or Virtual Scene

    Returns Scene

    A pointer to newly created scene

addStoryAnimations

  • addStoryAnimations(sceneSerialAnimes): void

  • Adds a list scene/serial/parallel animations. In essence, it represents the complete storyline. Use this method to load the whole storyline from an external file. Otherwise is preferable to add animation scene by scene.

    Parameters

    • sceneSerialAnimes: Animations[][]

    Returns void

addStoryAnimationsBySceneId

  • addStoryAnimationsBySceneId(sceneSerialAnimes): void

  • Adds a list of serial/parallel animations per scene Id. It requires that each scene has defined the id (DOM attribute). It bypasses invalid scene ids.

    Parameters

    • sceneSerialAnimes: {
          [sceneId: string]: Animation[][];
      }
      • [sceneId: string]: Animation[][]

    Returns void

addVirtualAnimator

  • addVirtualAnimator(animator): void

  • Adds a to the story. Use story.removeVirtualAnimator to take it from the story.

    Parameters

    • animator: VirtualAnimator

    Returns void

clear

  • clear(): void

  • Rewinds the animation to the start. Deletes all the scenes and frames from the story. The DOM is left untouched.

    Returns void

exit

  • exit(): void

  • Terminates the server in case is a headless webpage capture program. In other cases, it has no effect.

    Returns void

findSceneByName

  • findSceneByName(sceneName): Scene

  • Returns the Scene Object which has sceneName, undefined otherwise

    Parameters

    • sceneName: string

    Returns Scene

finishRender

  • finishRender(): void

  • Aborts the rendering process.

    Returns void

getElementAdapters

  • getElementAdapters(selector): ElementAdapter[]

  • Parameters

    • selector: ElSelectorHandler

    Returns ElementAdapter[]

getStoryToTeleport

  • getStoryToTeleport(frameOpts?, isPretty?): string

  • Returns the animations, html, CSS as an object. Use only if isTeleporting = true. Send this information via Ajax to the remote server. Due CORS, it requires a live server to access CSS information. Set frameOpts, if you need segment rendering. Set isPretty = true, to test only, since this mode will return a formatted output but bigger in size.

    Parameters

    Returns string

getStoryToTeleportAsConfig

  • getStoryToTeleportAsConfig(frameOpts?): StoryConfig

  • Same as getStoryToTeleport() but it returns as StoryConfig object. Use this function instead of getStoryToTeleport, if you need to add extra fields. Modifying the content of config.beamtoix is forbidden for 3rd-party remote server rendering.

    Parameters

    Returns StoryConfig

gotoFrame

  • gotoFrame(framePos): void

  • Moves the current render Position when is not rendering by consuming the pipeline. Use this only if you need to compute parameters at certain position. When render starts

    Parameters

    • framePos: int

    Returns void

gotoScene

  • gotoScene(scene): void

  • Changes the active and visible to a different scene.

    Parameters

    • scene: Scene

    Returns void

logError

  • logError(msg): void

  • If a server is present and supports logging, it sends a error message to server otherwise it sends to the browser console.

    Parameters

    • msg: string

    Returns void

logFrmt

  • logFrmt(tag, params, logType?): void

  • Formats a log using a format supported by exact test framework. This is mostly used internally for testing, but it's publicly available.

    Parameters

    • tag: string
    • params: (string | number)[][]

      list of [name, value]

    • OptionallogType: LogType

    Returns void

logMsg

  • logMsg(msg): void

  • If a server is present and supports logging, it sends a log message to server otherwise it sends to the browser console.

    Parameters

    • msg: string

    Returns void

logWarn

  • logWarn(msg): void

  • If a server is present and supports logging, it sends a warn message to server otherwise it sends to the browser console.

    Parameters

    • msg: string

    Returns void

removeScene

  • removeScene(scene): void

  • Removes a frame from scene list and removes the its rendering pipeline but its DOM elements aren't removed.

    Parameters

    • scene: Scene

    Returns void

removeVirtualAnimator

  • removeVirtualAnimator(animator): void

  • Removes a to the story. Use story.addVirtualAnimator to add it to the story.

    Parameters

    • animator: VirtualAnimator

    Returns void

render

  • render(playSpeedMs?, frameOpts?): void

  • Starts the Rendering process. It can render the whole storyline or just a segment. Forward and backward rending is supported. If it has a server, such as headless webpage capture program, it will render a frame, and send a message to the server to store it on the disk. If it's running on the browser, it will render and wait playSpeedMs time.

    Parameters

    • OptionalplaySpeedMs: any

      Play speed in milliseconds, ignored on server mode. BeamToIX doesn't guarantee the exact timing. If it's undefined, it will play at full speed.

    • OptionalframeOpts: RenderFrameOptions

    Returns void

rewind

  • rewind(): void

  • Rewinds the animation to the start.

    Returns void

startTeleporting

  • startTeleporting(): void

  • Use this method only if you have created the story with toTeleport = true and toStartTeleporting = false, because you need to inject html/css code into the page before the teleporting process starts. Otherwise, you won't need to call this method since it's called automatically if teleporting a story.

    Returns void

teleport

  • teleport(frameOpts?, isPretty?): void

  • Stores the complete story on a file in the disk. Use this method only for testing. This method requires that:

    1. Is on teleporting mode isTeleporting === true
    2. The render server agent. beamtoix render ...

    Use this method instead of getStoryToTeleport.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods