FilterAnimation

FilterAnimation

The ‘FilterAnimation’ class animates the property of any object’s filter to a specified target value.  The filter must already be applied to the display object; one will not be added for you if it is not present.

See Also

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

Summary
FilterAnimationThe ‘FilterAnimation’ class animates the property of any object’s filter to a specified target value.
Variables
m_nStartValueHolds the starting value for the filter’s property.
m_nTargetValueHolds the target value for the filter’s property.
m_nChangeValueHolds the change in value for the filter’s 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.
m_objFilterHolds the filter whose property is being animated.
Functions
FilterAnimationConstructor.
renderRenders the animation.
getFiltersGets an array containing all the target object’s filters, except for the target filter.
getTargetFilterGets a reference to the target filter.
updateTargetFliterUpdates the target filter by applying the specified value to it’s property, then reapplies itself to the target object.

Variables

m_nStartValue

protected var m_nStartValue: Number

Holds the starting value for the filter’s property.

m_nTargetValue

protected var m_nTargetValue: Number

Holds the target value for the filter’s property.

m_nChangeValue

protected var m_nChangeValue: Number

Holds the change in value for the filter’s 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.

m_objFilter

protected var m_objFilter: Class

Holds the filter whose property is being animated.

Functions

FilterAnimation

public function FilterAnimation(objTarget: DisplayObject,
objFilter: Class,
strProperty: String,
nTargetValue: Number,
nDuration: Number,
strTransition: String,
uRenderMethod: uint)

Constructor.

Parameters

param objTarget The target object being animated.
param objFilter The filter class whose property is being animated.  The filter must already be applied to the display object prior to being animated.
param strProperty The property of the target object’s filter that is being animated.
param nTargetValue The value the property is being 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. 

getFilters

protected function getFilters():Array

Gets an array containing all the target object’s filters, except for the target filter.

Returns

An array containing filters. 

getTargetFilter

protected function getTargetFilter():BitmapFilter

Gets a reference to the target filter.

Returns

A reference to the target filter. 

updateTargetFliter

protected function updateTargetFliter(nValue: Number):void

Updates the target filter by applying the specified value to it’s property, then reapplies itself to the target object.

Parameters

param nValue The value to apply to the target filter’s property. 
The ‘Animation’ class is the base class for all animation objects.
protected var m_nStartValue: Number
Holds the starting value for the filter’s property.
protected var m_nTargetValue: Number
Holds the target value for the filter’s property.
protected var m_nChangeValue: Number
Holds the change in value for the filter’s 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.
protected var m_objFilter: Class
Holds the filter whose property is being animated.
public function FilterAnimation(objTarget: DisplayObject,
objFilter: Class,
strProperty: String,
nTargetValue: Number,
nDuration: Number,
strTransition: String,
uRenderMethod: uint)
Constructor.
public override function render():Boolean
Renders the animation.
protected function getFilters():Array
Gets an array containing all the target object’s filters, except for the target filter.
protected function getTargetFilter():BitmapFilter
Gets a reference to the target filter.
protected function updateTargetFliter(nValue: Number):void
Updates the target filter by applying the specified value to it’s property, then reapplies itself to the target object.
Close