Skip to end of metadata
Go to start of metadata

Table of Contents


Extends: AnimationBase 

Description

The Animation node class provides animations of renderable nodes, by applying interpolator functions to the values in specified renderable node fields. For an animation to take effect, an Animation node definition must include a child field interpolator node (FloatFieldInterpolator, Vector2DFieldInterpolator, ColorFieldInterpolator) definition for each renderable node field that is animated.

The Animation node class provides a simple linear interpolator function, where the animation takes place smoothly and simply from beginning to end. The Animation node class also provides several more complex interpolator functions to allow custom animation effects. For example, you can move a graphic image around the screen at differing speeds and curved trajectories at different times in the animation by specifying the appropriate function in the easeFunction field (quadratic and exponential are two examples of functions that can be specified). The interpolator functions are divided into two parts: the beginning of the animation (ease-in), and the end of the animation (ease-out). You can apply a specified interpolator function to either or both ease-in and ease-out, or specify no function for either or both (which is the linear function). You can also change the portion of the animation that is ease-in and ease-out to arbitrary fractional values for a quadratic interpolator function applied to both ease-in and ease-out.

Fields

FieldTypeDefaultUse
durationTime0Sets the duration of the animation in seconds.
easeFunctionstring"inOutCubic"

Specifies the interpolator function to be used for the animation.

ValueEase-In/Ease-Out Function
linearNo ease-in or ease-out
inQuadQuadratic ease-in function, no ease-out
inCubicCubic ease-in function, no ease-out
inQuarticQuartic ease-in function, no ease-out
inQuinticQuintic ease-in function, no ease-out
inExpoExponential ease-in function, no ease-out
outQuadQuadratic ease-out function, no ease-in
outCubicCubic ease-out function, no ease-in
outQuarticQuartic ease-out function, no ease-in
outQuinticQuintic ease-out function, no ease-in
outExpoExponential ease-out function, no ease-in
inOutQuadQuadratic ease-in and ease-out function
inOutCubicCubic ease-in and ease-out function
inOutQuarticQuartic ease-in and ease-out function
inOutQuinticQuintic ease-in and ease-out function
inOutExpoExponential ease-in and ease-out function
piecewiseQuadratic ease-in and ease-out function with extra control over the percentage of the duration during which ease-in and ease-out occurs. The extra control is specified using the easeInPercent and easeOutPercent fields.
easeInPercentfloat0.5

If easeFunction is set to piecewise, easeInPercent sets the percentage of the animation duration during which ease-in is applied. Note that the values of easeInPercent plus easeOutPercent must be less than or equal to 1.

For all other values of easeFunction, easeInPercent is ignored.
easeOutPercentfloat0.5

If easeFunction is set to piecewise, easeOutPercent sets the percentage of the animation duration during which ease-out is applied. Note that the values of easeInPercent plus easeOutPercent must be less than or equal to 1.

For all other values of easeFunction, easeOutPercent is ignored.

optionalbooleanfalse

Set to true to skip animations on lower performing Roku devices (Paolo, Giga, Jackson, Tyler, and Sugarland). See Roku Devices for model numbers and code names.

When an Animation has optional set to true, setting the control field to start will cause the state field to change to running and immediately change again to finished. These state changes allow any logic tied to state field observers that run at the start and end of the Animation to be properly called.

Examples

Animation Markup in the SceneGraph Samples provides several simple examples of Animation node definitions that use all of the field interpolator nodes. Other simple examples of using the field interpolators can be found in the FloatFieldInterpolator, Vector2DFieldInterpolator, and ColorFieldInterpolator.

The following example shows how to use some simple animations. It uses two Animation nodes, each with its own Vector2DFieldInterpolator. The first defines a translation animation of the poster image, and the second defines a scale animation. They are both launched in an init() function using BrightScript. When run together, the effect is to "bloom" the poster image on the screen.

Animation BrightScript Example
Animation XML Example
  • No labels