Packagecom.boostworthy.animation.management.types
Classpublic class AlphaAnimation
InheritanceAlphaAnimation Inheritance Animation

The 'AlphaAnimation' class animates the 'alpha' property of a display object. The benefit of using this animation type over the generic 'PropertyAnimation' is that the display object's 'visible' property will be set to 'false' if it's alpha is animated to '0'. This is much more efficient than simply letting the display object be rendered with no alpha because the Flash Player will actually stop rendering the display object.

See also

com.boostworthy.animation.management.types.PropertyAnimation
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.
AlphaAnimation
  m_nChangeValue : Number
Holds the change in value for the property being animated.
AlphaAnimation
  m_nDuration : Number
Holds the duration of the animation in milliseconds.
AlphaAnimation
  m_nStartTime : Number
Holds the starting time of the animation in milliseconds.
AlphaAnimation
  m_nStartValue : Number
Holds the starting value for the property being animated.
AlphaAnimation
  m_nTargetValue : Number
Holds the target value for the property being animated.
AlphaAnimation
 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
  
AlphaAnimation(objTarget:DisplayObject, nTargetValue:Number, nDuration:Number, strTransition:String, uRenderMethod:uint)
Constructor.
AlphaAnimation
  
render():Boolean
Renders the animation.
AlphaAnimation
Public Constants
 ConstantDefined by
  PROPERTY : String = "alpha"
[static] Meta data for representing the property being animated.
AlphaAnimation
Property detail
m_fncTransitionproperty
protected var m_fncTransition:Function

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

m_nChangeValueproperty 
protected var m_nChangeValue:Number

Holds the change in value for the property being animated.

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_nStartValueproperty 
protected var m_nStartValue:Number

Holds the starting value for the property being animated.

m_nTargetValueproperty 
protected var m_nTargetValue:Number

Holds the target value for the property being animated.

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

Constructor.

Parameters
objTarget:DisplayObject — The target object being animated.
 
nTargetValue:Number — The value the property is getting animated to.
 
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 = "alpha"

Meta data for representing the property being animated.