Packagecom.boostworthy.animation.sequence.tweens
Classpublic class FilterTween
ImplementsITween

The 'FilterTween' class tweens the property of any object's filter to a specified target value.

See also

com.boostworthy.animation.sequence.tweens.ITween


Public Properties
 PropertyDefined by
  firstFrame : uint
[read-only] Gets the first frame of the timeline that has a keyframe on it.
FilterTween
  lastFrame : uint
[read-only] Gets the last frame of the timeline that has a keyframe on it.
FilterTween
  property : String
[read-only] Gets a string of the target property.
FilterTween
  target : Object
[read-only] Gets a reference to the target object being tweened.
FilterTween
Protected Properties
 PropertyDefined by
  m_bIsDirty : Boolean
Determines whether or not this tween has changed and needs compared towards it's target value again.
FilterTween
  m_fncTransition : Function
A reference to the transition being used for the tween.
FilterTween
  m_nChangeValue : Number
Holds the change in value for the property being tweened.
FilterTween
  m_nStartValue : Number
Holds the starting value for the property being tweened.
FilterTween
  m_nTargetValue : Number
Holds the target value for the property being tweened.
FilterTween
  m_objFilter : Class
Holds the filter whose property is being animated.
FilterTween
  m_objToTween : DisplayObject
A reference to the display object to be tweened.
FilterTween
  m_strProperty : String
The property of the display object's filter that is being animated.
FilterTween
  m_strTransition : String
The name of the transition to be used for the tween.
FilterTween
  m_uFirstFrame : uint
The first frame of the tween.
FilterTween
  m_uLastFrame : uint
The last frame of the tween.
FilterTween
Public Methods
 MethodDefined by
  
FilterTween(objToTween:DisplayObject, objFilter:Class, strProperty:String, nTargetValue:Number, uFirstFrame:uint, uLastFrame:uint, strTransition:String)
Constructor.
FilterTween
  
Creates a new filter tween object that is a clone of this object.
FilterTween
  
renderFrame(uFrame:uint):void
Renders the specified frame.
FilterTween
Protected Methods
 MethodDefined by
  
getFilters():Array
Gets an array containing all the target object's filters, except for the target filter.
FilterTween
  
getTargetFilter():BitmapFilter
Gets a reference to the target filter.
FilterTween
  
updateTargetFilter(nValue:Number):void
Updates the target filter by applying the specified value to it's property, then reapplies itself to the target object.
FilterTween
Protected Constants
 ConstantDefined by
  DEFAULT_TRANSITION : String = "linear"
The default transition to use for the tween.
FilterTween
Property detail
firstFrameproperty
firstFrame:uint  [read-only]

Gets the first frame of the timeline that has a keyframe on it.

Implementation
    public function get firstFrame():uint
lastFrameproperty 
lastFrame:uint  [read-only]

Gets the last frame of the timeline that has a keyframe on it.

Implementation
    public function get lastFrame():uint
m_bIsDirtyproperty 
protected var m_bIsDirty:Boolean

Determines whether or not this tween has changed and needs compared towards it's target value again.

m_fncTransitionproperty 
protected var m_fncTransition:Function

A reference to the transition being used for the tween.

m_nChangeValueproperty 
protected var m_nChangeValue:Number

Holds the change in value for the property being tweened.

m_nStartValueproperty 
protected var m_nStartValue:Number

Holds the starting value for the property being tweened.

m_nTargetValueproperty 
protected var m_nTargetValue:Number

Holds the target value for the property being tweened.

m_objFilterproperty 
protected var m_objFilter:Class

Holds the filter whose property is being animated.

m_objToTweenproperty 
protected var m_objToTween:DisplayObject

A reference to the display object to be tweened.

m_strPropertyproperty 
protected var m_strProperty:String

The property of the display object's filter that is being animated.

m_strTransitionproperty 
protected var m_strTransition:String

The name of the transition to be used for the tween.

m_uFirstFrameproperty 
protected var m_uFirstFrame:uint

The first frame of the tween.

m_uLastFrameproperty 
protected var m_uLastFrame:uint

The last frame of the tween.

propertyproperty 
property:String  [read-only]

Gets a string of the target property.

Implementation
    public function get property():String
targetproperty 
target:Object  [read-only]

Gets a reference to the target object being tweened.

Implementation
    public function get target():Object
Constructor detail
FilterTween()constructor
public function FilterTween(objToTween:DisplayObject, objFilter:Class, strProperty:String, nTargetValue:Number, uFirstFrame:uint, uLastFrame:uint, strTransition:String)

Constructor.

Parameters
objToTween:DisplayObject — The display object to be tweened.
 
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 display object's filter that is being animated.
 
nTargetValue:Number — The value the property is getting tweened to.
 
uFirstFrame:uint — The first frame of the tween.
 
uLastFrame:uint — The last frame of the tween.
 
strTransition:String — The name of the transition to be used for the tween.

See also

Method detail
clone()method
public function clone():ITween

Creates a new filter tween object that is a clone of this object.

Returns
ITween — A new filter tween object.
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.
renderFrame()method 
public function renderFrame(uFrame:uint):void

Renders the specified frame.

Parameters
uFrame:uint — The frame to render.
updateTargetFilter()method 
protected function updateTargetFilter(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 filter's target property.
Constant detail
DEFAULT_TRANSITIONconstant
protected const DEFAULT_TRANSITION:String = "linear"

The default transition to use for the tween.