FunctionsAnimation

FunctionsAnimation

The ‘FunctionsAnimation’ class animates any value that is accessed through get and set functions instead of getter/setters.

See Also

com.boostworthy.animation.management.types.abstract.Animation, com.boostworthy.animation.management.types.abstract.IAnimation

Summary
FunctionsAnimationThe ‘FunctionsAnimation’ class animates any value that is accessed through get and set functions instead of getter/setters.
Variables
m_fncSetHolds a reference to the target object’s set function.
m_nStartValueHolds the starting value for the property.
m_nTargetValueHolds the target value for the property.
m_nChangeValueHolds the change in value for the property.
m_nDurationHolds the duration of the animation in milliseconds.
m_nStartTimeHolds the starting time of the animation in milliseconds.
m_fncTransitionHolds a reference to the transition function being used for this animation.
Functions
FunctionsAnimationConstructor.
renderRenders the animation.

Variables

m_fncSet

protected var m_fncSet: Function

Holds a reference to the target object’s set function.

m_nStartValue

protected var m_nStartValue: Number

Holds the starting value for the property.

m_nTargetValue

protected var m_nTargetValue: Number

Holds the target value for the property.

m_nChangeValue

protected var m_nChangeValue: Number

Holds the change in value for the property.

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_fncTransition

protected var m_fncTransition: Function

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

Functions

FunctionsAnimation

public function FunctionsAnimation(objTarget: Object,
strGetFunction: String,
strSetFunction: String,
nTargetValue: Number,
nDuration: Number,
strTransition: String,
uRenderMethod: uint)

Constructor.

Parameters

param objTarget The target object being animated.
param strGetFunction The get function of the target object that is being animated.
param strGetFunction The set function of the target object that is being animated.
param nTargetValue The value the property is getting animated to.
param nDuration The duration of the animation in milliseconds.
param strTransition The transition to be used for the animation.
param uRenderMethod The method being used to render this animation. 

See Also

com.boostworthy.animation.easing.Transitions, 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_fncSet: Function
Holds a reference to the target object’s set function.
protected var m_nStartValue: Number
Holds the starting value for the property.
protected var m_nTargetValue: Number
Holds the target value for the property.
protected var m_nChangeValue: Number
Holds the change in value for the property.
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_fncTransition: Function
Holds a reference to the transition function being used for this animation.
public function FunctionsAnimation(objTarget: Object,
strGetFunction: String,
strSetFunction: String,
nTargetValue: Number,
nDuration: Number,
strTransition: String,
uRenderMethod: uint)
Constructor.
public override function render():Boolean
Renders the animation.
Close