Class SimpleVirtualAnimator

It simplifies the usage of by plugins. In many cases plugins just need to receive the changing property, in order to modify its state. Override animateProp to receive the changing property. animateProp isn't called if the property is uid.

Implements

Constructors

constructor

Properties

onAnimateProp onAnimateProps props propsChanged selector

Methods

animateProp animateProps frameRendered getProp setProp

Constructors

constructor

Properties

onAnimateProp

onAnimateProp: ((name: string, value: any) => void)

onAnimateProps

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

props

props: AnyParams = {}

propsChanged

propsChanged: boolean = false

selector

selector: string

Methods

animateProp

  • animateProp(name, value): void

  • Called after property value changed. Use this method instead animateProps, if the rendering should be right after each property is updated, otherwise use animateProps.

    Parameters

    • name: string
    • value: any

    Returns void

animateProps

  • animateProps(args?): void

  • Called after actions from the frame are rendered, and if at least one property changed. Use this method instead animateProp, if the animation has multiple virtual properties and each animation can be done after all are updated.

    Parameters

    • Optionalargs: BeamToIXArgs

    Returns void

frameRendered

  • 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): any

  • Parameters

    • name: string

    Returns any

setProp

  • setProp(name, value): void

  • Parameters

    • name: string
    • value: any

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods