Interface VirtualAnimator

Used by plugin creators to allow their content to be animated. A plugin can animate canvas, WebGl, svg or reduce the complexity of a CSS animation. The story uses uid to manage animators.

interface VirtualAnimator {
    selector: string;
    frameRendered?(args?: BeamToIXArgs): void;
    getProp(name: string, args?: BeamToIXArgs): any;
    setProp(name: string, value: any, args?: BeamToIXArgs): void;
    waitFor?(waitFor: WaitFor, onDone: DoneFunc, args?: BeamToIXArgs): void;
}

Hierarchy (view full)

Implemented by

Properties

selector

Methods

frameRendered? getProp setProp waitFor?

Properties

selector

selector: string

Methods

OptionalframeRendered

  • frameRendered(args?): void

  • Called after the frame is rendered, and before moves to the next frame. This method is called even if no property changed. It's an optional method, but future version might require its implementation.

    Parameters

    • Optionalargs: BeamToIXArgs

    Returns void

getProp

  • getProp(name, args?): any

  • Parameters

    • name: string
    • Optionalargs: BeamToIXArgs

    Returns any

setProp

  • setProp(name, value, args?): void

  • Parameters

    • name: string
    • value: any
    • Optionalargs: BeamToIXArgs

    Returns void

OptionalwaitFor

  • waitFor(waitFor, onDone, args?): void

  • Parameters

    • waitFor: WaitFor
    • onDone: DoneFunc
    • Optionalargs: BeamToIXArgs

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods