Packagecom.boostworthy.animation.management.types
Classpublic class SizeAnimation
InheritanceSizeAnimation Inheritance Animation

The 'SizeAnimation' class animates the 'width' and 'height' 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.
SizeAnimation
  m_nChangeValueH : Number
Holds the change in value for the 'height' property.
SizeAnimation
  m_nChangeValueW : Number
Holds the change in value for the 'width' property.
SizeAnimation
  m_nDuration : Number
Holds the duration of the animation in milliseconds.
SizeAnimation
  m_nStartTime : Number
Holds the starting time of the animation in milliseconds.
SizeAnimation
  m_nStartValueH : Number
Holds the starting value for the 'height' property.
SizeAnimation
  m_nStartValueW : Number
Holds the starting value for the 'width' property.
SizeAnimation
  m_nTargetValueH : Number
Holds the target value for the 'height' property.
SizeAnimation
  m_nTargetValueW : Number
Holds the target value for the 'width' property.
SizeAnimation
 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
  
SizeAnimation(objTarget:DisplayObject, nTargetValueW:Number, nTargetValueH:Number, nDuration:Number, strTransition:String, uRenderMethod:uint)
Constructor.
SizeAnimation
  
render():Boolean
Renders the animation.
SizeAnimation
Public Constants
 ConstantDefined by
  PROPERTY : String = "width, height"
[static] Meta data for representing the property being animated.
SizeAnimation
Property detail
m_fncTransitionproperty
protected var m_fncTransition:Function

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

m_nChangeValueHproperty 
protected var m_nChangeValueH:Number

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

m_nChangeValueWproperty 
protected var m_nChangeValueW:Number

Holds the change in value for the 'width' 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_nStartValueHproperty 
protected var m_nStartValueH:Number

Holds the starting value for the 'height' property.

m_nStartValueWproperty 
protected var m_nStartValueW:Number

Holds the starting value for the 'width' property.

m_nTargetValueHproperty 
protected var m_nTargetValueH:Number

Holds the target value for the 'height' property.

m_nTargetValueWproperty 
protected var m_nTargetValueW:Number

Holds the target value for the 'width' property.

Constructor detail
SizeAnimation()constructor
public function SizeAnimation(objTarget:DisplayObject, nTargetValueW:Number, nTargetValueH:Number, nDuration:Number, strTransition:String, uRenderMethod:uint)

Constructor.

Parameters
objTarget:DisplayObject — The target object being animated.
 
nTargetValueW:Number — The target value for the 'width' property of the target object.
 
nTargetValueH:Number — The target value for the 'height' 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 = "width, height"

Meta data for representing the property being animated.