Packagecom.boostworthy.animation.management.types
Classpublic class FilterAnimation
InheritanceFilterAnimation Inheritance Animation

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


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.
FilterAnimation
  m_nChangeValue : Number
Holds the change in value for the filter's property.
FilterAnimation
  m_nDuration : Number
Holds the duration of the animation in milliseconds.
FilterAnimation
  m_nStartTime : Number
Holds the starting time of the animation in milliseconds.
FilterAnimation
  m_nStartValue : Number
Holds the starting value for the filter's property.
FilterAnimation
  m_nTargetValue : Number
Holds the target value for the filter's property.
FilterAnimation
  m_objFilter : Class
Holds the filter whose property is being animated.
FilterAnimation
 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
  
FilterAnimation(objTarget:DisplayObject, objFilter:Class, strProperty:String, nTargetValue:Number, nDuration:Number, strTransition:String, uRenderMethod:uint)
Constructor.
FilterAnimation
  
render():Boolean
Renders the animation.
FilterAnimation
Protected Methods
 MethodDefined by
  
getFilters():Array
Gets an array containing all the target object's filters, except for the target filter.
FilterAnimation
  
getTargetFilter():BitmapFilter
Gets a reference to the target filter.
FilterAnimation
  
updateTargetFliter(nValue:Number):void
Updates the target filter by applying the specified value to it's property, then reapplies itself to the target object.
FilterAnimation
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 filter's 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 filter's property.

m_nTargetValueproperty 
protected var m_nTargetValue:Number

Holds the target value for the filter's property.

m_objFilterproperty 
protected var m_objFilter:Class

Holds the filter whose property is being animated.

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

Constructor.

Parameters
objTarget:DisplayObject — The target object being animated.
 
objFilter:Class — The filter class whose property is being animated. The filter must already be applied to the display object prior to being animated.
 
strProperty:String — The property of the target object's filter that is being animated.
 
nTargetValue:Number — The value the property is being animated to.
 
nDuration:Number — The duration of the animation in milliseconds.
 
strTransition:String — The transition to be used for the animation.
 
uRenderMethod:uint — The method being used to render this animation.

See also

Method detail
getFilters()method
protected function getFilters():Array

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

Returns
Array — An array containing filters.
getTargetFilter()method 
protected function getTargetFilter():BitmapFilter

Gets a reference to the target filter.

Returns
BitmapFilter — A reference to the target filter.
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.
updateTargetFliter()method 
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
nValue:Number — The value to apply to the target filter's property.