FilterTween

FilterTween

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

See Also

com.boostworthy.animation.sequence.tweens.ITween

Summary
FilterTweenThe ‘FilterTween’ class tweens the property of any object’s filter to a specified target value.
Constants
DEFAULT_TRANSITIONThe default transition to use for the tween.
Variables
m_objToTweenA reference to the display object to be tweened.
m_strPropertyThe property of the display object’s filter that is being animated.
m_uFirstFrameThe first frame of the tween.
m_uLastFrameThe last frame of the tween.
m_nStartValueHolds the starting value for the property being tweened.
m_nTargetValueHolds the target value for the property being tweened.
m_nChangeValueHolds the change in value for the property being tweened.
m_strTransitionThe name of the transition to be used for the tween.
m_fncTransitionA reference to the transition being used for the tween.
m_bIsDirtyDetermines whether or not this tween has changed and needs compared towards it’s target value again.
m_objFilterHolds the filter whose property is being animated.
Functions
FilterTweenConstructor.
cloneCreates a new filter tween object that is a clone of this object.
renderFrameRenders the specified frame.
Properties
firstFrameGets the first frame of the timeline that has a keyframe on it.
lastFrameGets the last frame of the timeline that has a keyframe on it.
targetGets a reference to the target object being tweened.
propertyGets a string of the target property.
Functions
getFiltersGets an array containing all the target object’s filters, except for the target filter.
getTargetFilterGets a reference to the target filter.
updateTargetFilterUpdates the target filter by applying the specified value to it’s property, then reapplies itself to the target object.

Constants

DEFAULT_TRANSITION

protected const DEFAULT_TRANSITION: String

The default transition to use for the tween.

Variables

m_objToTween

protected var m_objToTween: DisplayObject

A reference to the display object to be tweened.

m_strProperty

protected var m_strProperty: String

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

m_uFirstFrame

protected var m_uFirstFrame: uint

The first frame of the tween.

m_uLastFrame

protected var m_uLastFrame: uint

The last frame of the tween.

m_nStartValue

protected var m_nStartValue: Number

Holds the starting value for the property being tweened.

m_nTargetValue

protected var m_nTargetValue: Number

Holds the target value for the property being tweened.

m_nChangeValue

protected var m_nChangeValue: Number

Holds the change in value for the property being tweened.

m_strTransition

protected var m_strTransition: String

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

m_fncTransition

protected var m_fncTransition: Function

A reference to the transition being used for the tween.

m_bIsDirty

protected var m_bIsDirty: Boolean

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

m_objFilter

protected var m_objFilter: Class

Holds the filter whose property is being animated.

Functions

FilterTween

public function FilterTween(objToTween: DisplayObject,  
objFilter: Class,  
strProperty: String,  
nTargetValue: Number,  
uFirstFrame: uint,  
uLastFrame: uint,  
strTransition: String = DEFAULT_TRANSITION)

Constructor.

Parameters

param objToTween The display object to be tweened.
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 display object’s filter that is being animated.
param nTargetValue The value the property is getting tweened to.
param uFirstFrame The first frame of the tween.
param uLastFrame The last frame of the tween.
param strTransition The name of the transition to be used for the tween. 

See Also

com.boostworthy.animation.easing.Transitions

clone

public function clone():ITween

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

Returns

A new filter tween object. 

renderFrame

public function renderFrame(uFrame: uint):void

Renders the specified frame.

Parameters

param uFrame The frame to render. 

Properties

firstFrame

public function get firstFrame():uint

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

Returns

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

lastFrame

public function get lastFrame():uint

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

Returns

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

target

public function get target():Object

Gets a reference to the target object being tweened.

Returns

A reference to the target object being tweened. 

property

public function get property():String

Gets a string of the target property.

Returns

A string of the target property. 

Functions

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. 

updateTargetFilter

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

param nValue The value to apply to the filter’s target property. 
The ‘ITween’ interface defines a common interface for all tween objects.
protected const DEFAULT_TRANSITION: String
The default transition to use for the tween.
protected var m_objToTween: DisplayObject
A reference to the display object to be tweened.
protected var m_strProperty: String
The property of the display object’s filter that is being animated.
protected var m_uFirstFrame: uint
The first frame of the tween.
protected var m_uLastFrame: uint
The last frame of the tween.
protected var m_nStartValue: Number
Holds the starting value for the property being tweened.
protected var m_nTargetValue: Number
Holds the target value for the property being tweened.
protected var m_nChangeValue: Number
Holds the change in value for the property being tweened.
protected var m_strTransition: String
The name of the transition to be used for the tween.
protected var m_fncTransition: Function
A reference to the transition being used for the tween.
protected var m_bIsDirty: Boolean
Determines whether or not this tween has changed and needs compared towards it’s target value again.
protected var m_objFilter: Class
Holds the filter whose property is being animated.
public function FilterTween(objToTween: DisplayObject,  
objFilter: Class,  
strProperty: String,  
nTargetValue: Number,  
uFirstFrame: uint,  
uLastFrame: uint,  
strTransition: String = DEFAULT_TRANSITION)
Constructor.
public function clone():ITween
Creates a new filter tween object that is a clone of this object.
public function renderFrame(uFrame: uint):void
Renders the specified frame.
public function get firstFrame():uint
Gets the first frame of the timeline that has a keyframe on it.
public function get lastFrame():uint
Gets the last frame of the timeline that has a keyframe on it.
public function get target():Object
Gets a reference to the target object being tweened.
public function get property():String
Gets a string of the target property.
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 updateTargetFilter(nValue: Number):void
Updates the target filter by applying the specified value to it’s property, then reapplies itself to the target object.
Close