Packagecom.boostworthy.animation.management.types
Classpublic class PulseAnimation
InheritancePulseAnimation Inheritance Animation

The 'PulseAnimation' class animates any object's property back and forth between a minimum and maximum value using a sine wave.

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_nDuration : Number
Holds the duration of the animation in milliseconds.
PulseAnimation
  m_nMax : Number
Holds the maximum value output by the pulse.
PulseAnimation
  m_nMedian : Number
The median value of the min/max.
PulseAnimation
  m_nMin : Number
Holds the minimum value output by the pulse.
PulseAnimation
  m_nStartTime : Number
Holds the starting time of the animation in milliseconds.
PulseAnimation
  m_nValue : Number
Holds the distance between the min/max and the median.
PulseAnimation
 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
  
PulseAnimation(objTarget:Object, strProperty:String, nMin:Number, nMax:Number, nDuration:Number, uRenderMethod:uint)
Constructor.
PulseAnimation
  
render():Boolean
Renders the animation.
PulseAnimation
Property detail
m_nDurationproperty
protected var m_nDuration:Number

Holds the duration of the animation in milliseconds.

m_nMaxproperty 
protected var m_nMax:Number

Holds the maximum value output by the pulse.

m_nMedianproperty 
protected var m_nMedian:Number

The median value of the min/max.

m_nMinproperty 
protected var m_nMin:Number

Holds the minimum value output by the pulse.

m_nStartTimeproperty 
protected var m_nStartTime:Number

Holds the starting time of the animation in milliseconds.

m_nValueproperty 
protected var m_nValue:Number

Holds the distance between the min/max and the median.

Constructor detail
PulseAnimation()constructor
public function PulseAnimation(objTarget:Object, strProperty:String, nMin:Number, nMax:Number, nDuration:Number, uRenderMethod:uint)

Constructor.

Parameters
objTarget:Object — The target object being animated.
 
strProperty:String — The property of the target object that is being animated.
 
nMin:Number — The minimum value output by the pulse.
 
nMax:Number — The maximum value output by the pulse.
 
nDuration:Number — The duration of the animation in milliseconds.
 
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.