Packagecom.boostworthy.animation.management.types
Classpublic class RotationAnimation
InheritanceRotationAnimation Inheritance Animation

Animates the 'rotation' property of a display object to the desired target value.

The advantage of using this method over the generic 'Property' method is that you can specify the amount of times the animation occurs using the 'number of repeats' parameter. If the number of repeats is set to '1', the animation will occur one time and animate the rotation property to the specified target value. If a value other than '1' is used, the animation will occur the set number of times, but instead of animating the rotation property to the target value, the target value will be added to the current rotation value each time the animation occurs. A value of '0' for the number of repeats will cause the animation to continue until it is manually removed.

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.
RotationAnimation
  m_nChangeValue : Number
Holds the change in value for the 'rotation' property.
RotationAnimation
  m_nDuration : Number
Holds the duration of the animation in milliseconds.
RotationAnimation
  m_nStartTime : Number
Holds the starting time of the animation in milliseconds.
RotationAnimation
  m_nStartValue : Number
Holds the starting value for the 'rotation' property.
RotationAnimation
  m_nTargetValue : Number
Holds the target value for the 'rotation' property.
RotationAnimation
 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
  m_uNumRepeats : uint
Holds the number of times this animation should repeat itself.
RotationAnimation
 Inheritedm_uRenderMethod : uint
Holds the method being used to render this animation.
Animation
  m_uRepeatCount : uint
Holds the current number of repeats that have taken place for this animation.
RotationAnimation
Public Methods
 MethodDefined by
  
RotationAnimation(objTarget:DisplayObject, nTargetValue:Number, nDuration:Number, uNumRepeats:uint, strTransition:String, uRenderMethod:uint)
Constructor.
RotationAnimation
  
render():Boolean
Renders the animation.
RotationAnimation
Public Constants
 ConstantDefined by
  PROPERTY : String = "rotation"
[static] Meta data for representing the property being animated.
RotationAnimation
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 'rotation' 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_nStartValueproperty 
protected var m_nStartValue:Number

Holds the starting value for the 'rotation' property.

m_nTargetValueproperty 
protected var m_nTargetValue:Number

Holds the target value for the 'rotation' property.

m_uNumRepeatsproperty 
protected var m_uNumRepeats:uint

Holds the number of times this animation should repeat itself.

m_uRepeatCountproperty 
protected var m_uRepeatCount:uint

Holds the current number of repeats that have taken place for this animation.

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

Constructor.

Parameters
objTarget:DisplayObject — The target object being animated.
 
nTargetValue:Number — The value to animate the target object's rotation property to.
 
nDuration:Number — The duration of the animation in milliseconds.
 
uNumRepeats:uint — The number of times the animation should repeat itself. A value of '0' will cause the animation to go on until manually stopped.
 
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 = "rotation"

Meta data for representing the property being animated.