Packagecom.boostworthy.animation.management.types
Classpublic class ScaleAnimation
InheritanceScaleAnimation Inheritance Animation

The 'ScaleAnimation' class animates the 'scaleX' and 'scaleY' properties of a display object. The advantage to using this animation type over the generic 'PropertyAnimation' is that it results in a smoother animation since the properties are updated very close to the same time. It also generates a single event for the animation rather than one for each property seperately.

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.
ScaleAnimation
  m_nChangeValueX : Number
Holds the change in value for the 'scaleX' property.
ScaleAnimation
  m_nChangeValueY : Number
Holds the change in value for the 'scaleY' property.
ScaleAnimation
  m_nDuration : Number
Holds the duration of the animation in milliseconds.
ScaleAnimation
  m_nStartTime : Number
Holds the starting time of the animation in milliseconds.
ScaleAnimation
  m_nStartValueX : Number
Holds the starting value for the 'scaleX' property.
ScaleAnimation
  m_nStartValueY : Number
Holds the starting value for the 'scaleY' property.
ScaleAnimation
  m_nTargetValueX : Number
Holds the target value for the 'scaleX' property.
ScaleAnimation
  m_nTargetValueY : Number
Holds the target value for the 'scaleY' property.
ScaleAnimation
 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
  
ScaleAnimation(objTarget:DisplayObject, nTargetValueX:Number, nTargetValueY:Number, nDuration:Number, strTransition:String, uRenderMethod:uint)
Constructor.
ScaleAnimation
  
render():Boolean
Renders the animation.
ScaleAnimation
Public Constants
 ConstantDefined by
  PROPERTY : String = "scaleX, scaleY"
[static] Meta data for representing the property being animated.
ScaleAnimation
Property detail
m_fncTransitionproperty
protected var m_fncTransition:Function

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

m_nChangeValueXproperty 
protected var m_nChangeValueX:Number

Holds the change in value for the 'scaleX' property.

m_nChangeValueYproperty 
protected var m_nChangeValueY:Number

Holds the change in value for the 'scaleY' property.

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_nStartValueXproperty 
protected var m_nStartValueX:Number

Holds the starting value for the 'scaleX' property.

m_nStartValueYproperty 
protected var m_nStartValueY:Number

Holds the starting value for the 'scaleY' property.

m_nTargetValueXproperty 
protected var m_nTargetValueX:Number

Holds the target value for the 'scaleX' property.

m_nTargetValueYproperty 
protected var m_nTargetValueY:Number

Holds the target value for the 'scaleY' property.

Constructor detail
ScaleAnimation()constructor
public function ScaleAnimation(objTarget:DisplayObject, nTargetValueX:Number, nTargetValueY:Number, nDuration:Number, strTransition:String, uRenderMethod:uint)

Constructor.

Parameters
objTarget:DisplayObject — The target object being animated.
 
nTargetValueX:Number — The target value for the 'scaleX' property of the target object.
 
nTargetValueY:Number — The target value for the 'scaleY' property 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 = "scaleX, scaleY"

Meta data for representing the property being animated.