Packagecom.boostworthy.animation.management.types
Classpublic class ColorAnimation
InheritanceColorAnimation Inheritance Animation

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


Public Properties
 PropertyDefined by
 Inheritedmethod : uint
Gets the method being used to render the animation.
Animation
 Inheritedproperty : String
Gets the property of the target object being animated.
Animation
 Inheritedtarget : Object
Gets a reference to the target object being animated.
Animation
Protected Properties
 PropertyDefined by
  m_fncTransition : Function
Holds a reference to the transition function being used for this animation.
ColorAnimation
  m_nChangeValueB : Number
Holds the change in value for the 'blue' portion of the color.
ColorAnimation
  m_nChangeValueG : Number
Holds the change in value for the 'green' portion of the color.
ColorAnimation
  m_nChangeValueR : Number
Holds the change in value for the 'red' portion of the color.
ColorAnimation
  m_nDuration : Number
Holds the duration of the animation in milliseconds.
ColorAnimation
  m_nStartTime : Number
Holds the starting time of the animation in milliseconds.
ColorAnimation
  m_nStartValueB : Number
Holds the starting value for the 'blue' portion of the color.
ColorAnimation
  m_nStartValueG : Number
Holds the starting value for the 'green' portion of the color.
ColorAnimation
  m_nStartValueR : Number
Holds the starting value for the 'red' portion of the color.
ColorAnimation
  m_nTargetValueB : Number
Holds the target value for the 'blue' portion of the color.
ColorAnimation
  m_nTargetValueG : Number
Holds the target value for the 'green' portion of the color.
ColorAnimation
  m_nTargetValueR : Number
Holds the target value for the 'red' portion of the color.
ColorAnimation
 Inheritedm_objTarget : Object
Holds a reference to the target object being animated.
Animation
 Inheritedm_strProperty : String
Holds the property of the target object that is being animated.
Animation
 Inheritedm_uRenderMethod : uint
Holds the method being used to render this animation.
Animation
Public Methods
 MethodDefined by
  
ColorAnimation(objTarget:DisplayObject, nTargetValue:Number, nDuration:Number, strTransition:String, uRenderMethod:uint)
Constructor.
ColorAnimation
  
render():Boolean
Renders the animation.
ColorAnimation
Public Constants
 ConstantDefined by
  PROPERTY : String = "transform.colorTransform.redOffset, transform.colorTransform.greenOffset, transform.colorTransform.blueOffset"
[static] Meta data for representing the property being animated.
ColorAnimation
Property detail
m_fncTransitionproperty
protected var m_fncTransition:Function

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

m_nChangeValueBproperty 
protected var m_nChangeValueB:Number

Holds the change in value for the 'blue' portion of the color.

m_nChangeValueGproperty 
protected var m_nChangeValueG:Number

Holds the change in value for the 'green' portion of the color.

m_nChangeValueRproperty 
protected var m_nChangeValueR:Number

Holds the change in value for the 'red' portion of the color.

m_nDurationproperty 
protected var m_nDuration:Number

Holds the duration of the animation in milliseconds.

m_nStartTimeproperty 
protected var m_nStartTime:Number

Holds the starting time of the animation in milliseconds.

m_nStartValueBproperty 
protected var m_nStartValueB:Number

Holds the starting value for the 'blue' portion of the color.

m_nStartValueGproperty 
protected var m_nStartValueG:Number

Holds the starting value for the 'green' portion of the color.

m_nStartValueRproperty 
protected var m_nStartValueR:Number

Holds the starting value for the 'red' portion of the color.

m_nTargetValueBproperty 
protected var m_nTargetValueB:Number

Holds the target value for the 'blue' portion of the color.

m_nTargetValueGproperty 
protected var m_nTargetValueG:Number

Holds the target value for the 'green' portion of the color.

m_nTargetValueRproperty 
protected var m_nTargetValueR:Number

Holds the target value for the 'red' portion of the color.

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

Constructor.

Parameters
objTarget:DisplayObject — The target object being animated.
 
nTargetValue:Number — The target color value of the target object.
 
nDuration:Number — The duration of the animation in milliseconds.
 
strTransition:String — The transition to be used for the animation.
 
uRenderMethod:uint — The method being used to render this animation.

See also

Method detail
render()method
public override function render():Boolean

Renders the animation.

Returns
Boolean — A boolean value that is 'true' if the animation was updated successfully, 'false' if it was not.
Constant detail
PROPERTYconstant
public static const PROPERTY:String = "transform.colorTransform.redOffset, transform.colorTransform.greenOffset, transform.colorTransform.blueOffset"

Meta data for representing the property being animated.