Packageorg.as3lib.kitchensync.action.tweentarget
Interfacepublic interface ITweenTarget extends INumericController
SubinterfacesIFilterTweenTarget
ImplementorsTargetProperty, TimelineController

A bundle that wraps up a property or other value that can be tweened by a KSTween. Generally speaking, a KSTween will handle the timing of the tween while the ITweenTarget handles the values of the tween.

See also

org.as3lib.kitchensync.action.KSTween

Public Properties
 PropertyDefined by
  currentValue : Number
This is the current value of the tweenTarget.
ITweenTarget
  endValue : Number
The value that the tweenTarget will end on.
ITweenTarget
  startValue : Number
The value that the tweenTarget will begin from.
ITweenTarget
Public Methods
 MethodDefined by
  
clone():ITweenTarget
Create a copy of the tweenTarget object
ITweenTarget
  
reset():void
Reset the value to it's pre-tweened state.
ITweenTarget
  
updateTween(percentComplete:Number):Number
The main function that the Tween uses to update the TweenTarget.
ITweenTarget
Property detail
currentValueproperty
currentValue:Number  [read-write]

This is the current value of the tweenTarget.

Implementation
    public function get currentValue():Number
    public function set currentValue(value:Number):void
endValueproperty 
endValue:Number  [read-write]

The value that the tweenTarget will end on.

Implementation
    public function get endValue():Number
    public function set endValue(value:Number):void
startValueproperty 
startValue:Number  [read-write]

The value that the tweenTarget will begin from.

Implementation
    public function get startValue():Number
    public function set startValue(value:Number):void
Method detail
clone()method
public function clone():ITweenTarget

Create a copy of the tweenTarget object

Returns
ITweenTarget
reset()method 
public function reset():void

Reset the value to it's pre-tweened state. (typically, sets the currentValue equal to the startValue)

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.