Packageorg.as3lib.kitchensync.action.tweentarget
Classpublic class FilterTargetProperty
ImplementsIFilterTweenTarget



Public Properties
 PropertyDefined by
  currentValue : Number
FilterTargetProperty
  differenceInValues : Number
[read-only] The total amount of change between the start and end values.
FilterTargetProperty
  endValue : Number
The value to end on when tweening.
FilterTargetProperty
  filterType : Class
[read-only]
FilterTargetProperty
  property : String
[read-only] The string name of the property of the target object that you want to tween.
FilterTargetProperty
  startValue : Number
The value to start from when tweening.
FilterTargetProperty
  target : DisplayObject
[read-only] The object containing the filter property you want to tween.
FilterTargetProperty
Protected Properties
 PropertyDefined by
  _endValue : Number
FilterTargetProperty
  filters : Array
FilterTargetProperty
  _filterType : Class
FilterTargetProperty
  _previousFilter : BitmapFilter = null
FilterTargetProperty
  _property : String
FilterTargetProperty
  _startValue : Number
FilterTargetProperty
  _target : DisplayObject
FilterTargetProperty
Public Methods
 MethodDefined by
  
FilterTargetProperty(target:DisplayObject, filterType:Class, property:String, startValue:Number, endValue:Number)
Constructor.
FilterTargetProperty
  
FilterTargetProperty
  
reset():void
FilterTargetProperty
  
updateTween(percentComplete:Number):Number
The main function that the Tween uses to update the TweenTarget.
FilterTargetProperty
Protected Methods
 MethodDefined by
  
getDefaultFilter(filterType:Class):BitmapFilter
FilterTargetProperty
Property detail
currentValueproperty
currentValue:Number  [read-write]Implementation
    public function get currentValue():Number
    public function set currentValue(value:Number):void
differenceInValuesproperty 
differenceInValues:Number  [read-only]

The total amount of change between the start and end values. (used internally)

Implementation
    public function get differenceInValues():Number
_endValueproperty 
protected var _endValue:Number
endValueproperty 
endValue:Number  [read-write]

The value to end on when tweening.

Implementation
    public function get endValue():Number
    public function set endValue(value:Number):void
filtersproperty 
filters:Array  [read-write]Implementation
    protected function get filters():Array
    protected function set filters(value:Array):void
_filterTypeproperty 
protected var _filterType:Class
filterTypeproperty 
filterType:Class  [read-only]Implementation
    public function get filterType():Class
_previousFilterproperty 
protected var _previousFilter:BitmapFilter = null
_propertyproperty 
protected var _property:String
propertyproperty 
property:String  [read-only]

The string name of the property of the target object that you want to tween.

Implementation
    public function get property():String
_startValueproperty 
protected var _startValue:Number
startValueproperty 
startValue:Number  [read-write]

The value to start from when tweening.

Implementation
    public function get startValue():Number
    public function set startValue(value:Number):void
_targetproperty 
protected var _target:DisplayObject
targetproperty 
target:DisplayObject  [read-only]

The object containing the filter property you want to tween.

Implementation
    public function get target():DisplayObject
Constructor detail
FilterTargetProperty()constructor
public function FilterTargetProperty(target:DisplayObject, filterType:Class, property:String, startValue:Number, endValue:Number)

Constructor.

Parameters
target:DisplayObject — the object whose property you want to tween
 
filterType:Class — the name of the numeric property to tween
 
property:String — the value to start from when tweening
 
startValue:Number — the value to end on when tweening
 
endValue:Number
Method detail
clone()method
public function clone():ITweenTarget

Returns
ITweenTarget
getDefaultFilter()method 
protected function getDefaultFilter(filterType:Class):BitmapFilter

Parameters
filterType:Class

Returns
BitmapFilter
reset()method 
public function reset():void
updateTween()method 
public function updateTween(percentComplete:Number):Number

The main function that the Tween uses to update the TweenTarget. Sets the percentage complete.

Parameters
percentComplete:Number — a number between 0 and 1 (but sometimes more or less) that represents the percentage of the tween that has been completed. This should update

Returns
Number — Number the new current value of the tween.