PulseAnimation

PulseAnimation

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

Summary
PulseAnimationThe ‘PulseAnimation’ class animates any object’s property back and forth between a minimum and maximum value using a sine wave.
Variables
m_nMinHolds the minimum value output by the pulse.
m_nMaxHolds the maximum value output by the pulse.
m_nDurationHolds the duration of the animation in milliseconds.
m_nStartTimeHolds the starting time of the animation in milliseconds.
m_nValueHolds the distance between the min/max and the median.
m_nMedianThe median value of the min/max.
Functions
PulseAnimationConstructor.
renderRenders the animation.

Variables

m_nMin

protected var m_nMin: Number

Holds the minimum value output by the pulse.

m_nMax

protected var m_nMax: Number

Holds the maximum value output by the pulse.

m_nDuration

protected var m_nDuration: Number

Holds the duration of the animation in milliseconds.

m_nStartTime

protected var m_nStartTime: Number

Holds the starting time of the animation in milliseconds.

m_nValue

protected var m_nValue: Number

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

m_nMedian

protected var m_nMedian: Number

The median value of the min/max.

Functions

PulseAnimation

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

Constructor.

Parameters

param objTarget The target object being animated.
param strProperty The property of the target object that is being animated.
param nMin The minimum value output by the pulse.
param nMax The maximum value output by the pulse.
param nDuration The duration of the animation in milliseconds.
param uRenderMethod The method being used to render this animation. 

See Also

com.boostworthy.animation.rendering.RenderMethod

render

public override function render():Boolean

Renders the animation.

Returns

A boolean value that is ‘true’ if the animation was updated successfully, ‘false’ if it was not. 

The ‘Animation’ class is the base class for all animation objects.
protected var m_nMin: Number
Holds the minimum value output by the pulse.
protected var m_nMax: Number
Holds the maximum value output by the pulse.
protected var m_nDuration: Number
Holds the duration of the animation in milliseconds.
protected var m_nStartTime: Number
Holds the starting time of the animation in milliseconds.
protected var m_nValue: Number
Holds the distance between the min/max and the median.
protected var m_nMedian: Number
The median value of the min/max.
public function PulseAnimation(objTarget: Object,
strProperty: String,
nMin: Number,
nMax: Number,
nDuration: Number,
uRenderMethod: uint)
Constructor.
public override function render():Boolean
Renders the animation.
Close