ColorAnimation

ColorAnimation

The ‘ColorAnimation’ class animates the color of a display object.

See Also

com.boostworthy.animation.management.types.abstract.Animation, com.boostworthy.animation.management.types.abstract.IAnimation

Summary
ColorAnimationThe ‘ColorAnimation’ class animates the color of a display object.
Constants
PROPERTYMeta data for representing the property being animated.
Variables
m_nStartValueRHolds the starting value for the ‘red’ portion of the color.
m_nTargetValueRHolds the target value for the ‘red’ portion of the color.
m_nChangeValueRHolds the change in value for the ‘red’ portion of the color.
m_nStartValueGHolds the starting value for the ‘green’ portion of the color.
m_nTargetValueGHolds the target value for the ‘green’ portion of the color.
m_nChangeValueGHolds the change in value for the ‘green’ portion of the color.
m_nStartValueBHolds the starting value for the ‘blue’ portion of the color.
m_nTargetValueBHolds the target value for the ‘blue’ portion of the color.
m_nChangeValueBHolds the change in value for the ‘blue’ portion of the color.
m_nDurationHolds the duration of the animation in milliseconds.
m_nStartTimeHolds the starting time of the animation in milliseconds.
m_fncTransitionHolds a reference to the transition function being used for this animation.
Functions
ColorAnimationConstructor.
renderRenders the animation.

Constants

PROPERTY

public static const PROPERTY: String

Meta data for representing the property being animated.

Variables

m_nStartValueR

protected var m_nStartValueR: Number

Holds the starting value for the ‘red’ portion of the color.

m_nTargetValueR

protected var m_nTargetValueR: Number

Holds the target value for the ‘red’ portion of the color.

m_nChangeValueR

protected var m_nChangeValueR: Number

Holds the change in value for the ‘red’ portion of the color.

m_nStartValueG

protected var m_nStartValueG: Number

Holds the starting value for the ‘green’ portion of the color.

m_nTargetValueG

protected var m_nTargetValueG: Number

Holds the target value for the ‘green’ portion of the color.

m_nChangeValueG

protected var m_nChangeValueG: Number

Holds the change in value for the ‘green’ portion of the color.

m_nStartValueB

protected var m_nStartValueB: Number

Holds the starting value for the ‘blue’ portion of the color.

m_nTargetValueB

protected var m_nTargetValueB: Number

Holds the target value for the ‘blue’ portion of the color.

m_nChangeValueB

protected var m_nChangeValueB: Number

Holds the change in value for the ‘blue’ portion of the color.

m_nDuration

protected var m_nDuration: Number

Holds the duration of the animation in milliseconds.

m_nStartTime

protected var m_nStartTime: Number

Holds the starting time of the animation in milliseconds.

m_fncTransition

protected var m_fncTransition: Function

Holds a reference to the transition function being used for this animation.

Functions

ColorAnimation

public function ColorAnimation(objTarget: DisplayObject,
nTargetValue: Number,
nDuration: Number,
strTransition: String,
uRenderMethod: uint)

Constructor.

Parameters

param objTarget The target object being animated.
param nTargetValue The target color value of the target object.
param nDuration The duration of the animation in milliseconds.
param strTransition The transition to be used for the animation.
param uRenderMethod The method being used to render this animation. 

See Also

com.boostworthy.animation.easing.Transitions, com.boostworthy.animation.rendering.RenderMethod

render

public override function render():Boolean

Renders the animation.

Returns

A boolean value that is ‘true’ if the animation was updated successfully, ‘false’ if it was not. 

The ‘Animation’ class is the base class for all animation objects.
public static const PROPERTY: String
Meta data for representing the property being animated.
protected var m_nStartValueR: Number
Holds the starting value for the ‘red’ portion of the color.
protected var m_nTargetValueR: Number
Holds the target value for the ‘red’ portion of the color.
protected var m_nChangeValueR: Number
Holds the change in value for the ‘red’ portion of the color.
protected var m_nStartValueG: Number
Holds the starting value for the ‘green’ portion of the color.
protected var m_nTargetValueG: Number
Holds the target value for the ‘green’ portion of the color.
protected var m_nChangeValueG: Number
Holds the change in value for the ‘green’ portion of the color.
protected var m_nStartValueB: Number
Holds the starting value for the ‘blue’ portion of the color.
protected var m_nTargetValueB: Number
Holds the target value for the ‘blue’ portion of the color.
protected var m_nChangeValueB: Number
Holds the change in value for the ‘blue’ portion of the color.
protected var m_nDuration: Number
Holds the duration of the animation in milliseconds.
protected var m_nStartTime: Number
Holds the starting time of the animation in milliseconds.
protected var m_fncTransition: Function
Holds a reference to the transition function being used for this animation.
public function ColorAnimation(objTarget: DisplayObject,
nTargetValue: Number,
nDuration: Number,
strTransition: String,
uRenderMethod: uint)
Constructor.
public override function render():Boolean
Renders the animation.
Close