A TweenTarget used to tween numeric properties of an object.
currentValue:Number [read-write]
The current value of the property. Using the setter directly sets the value.
Implementation
public function get currentValue():Number
public function set currentValue(value:Number):void
Throws
| |
differenceInValues:Number [read-only]
The total amount of change between the start and end values. (used internally)
Implementation
public function get differenceInValues():Number
protected var _endValue:Number
endValue:Number [read-write]
The value to end on when tweening.
Implementation
public function get endValue():Number
public function set endValue(value:Number):void
protected var _property:String
property:String [read-only]
The string name of the property of the target object that you want to tween.
Note: the property must be a numeric value.
Implementation
public function get property():String
protected var _snapToInteger:Boolean
snapToInteger:Boolean [read-write]
Indicates whether tweened values should snap to whole value numbers or use decimals.
If set to true, the results of the easing functions on the target property will be
rounded to the nearest integer.
Implementation
public function get snapToInteger():Boolean
public function set snapToInteger(value:Boolean):void
See also
org.as3lib.kitchensync.ActionDefaults
protected var _startValue:Number
startValue:Number [read-write]
The value to start from when tweening.
Implementation
public function get startValue():Number
public function set startValue(value:Number):void
protected var _target:Object
target:Object [read-only]
The object containing the property you want to tween.
Implementation
public function get target():Object
public function TargetProperty(target:Object, property:String, startValue:Number, endValue:Number)
Constructor.
Parameters
| target:Object — the object whose property you want to tween
|
| |
| property:String — the name of the numeric property to tween
|
| |
| startValue:Number — the value to start from when tweening
|
| |
| endValue:Number — the value to end on when tweening
|
public function clone():ITweenTarget Create a copy of the tweenTarget object
Returns
protected function isPropertyValid(target:Object, property:String):BooleanParameters
| target:Object |
| |
| property:String |
Returns
public function reset():void Returns the tweenTarget to its pre-tweened state
public function setTargetPropterty(target:Object, property:String):void
Sets the target object and property name that will be tweened.
Parameters
| target:Object — an object that contains the numeric property to tween.
|
| |
| property:String — the name of the numeric property to tween.
|
public function toString():String
Returns
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.
|
protected const NON_NUMERIC_PROPERTY_ERROR:String = "The 'property' of the object 'target' must be a Number, int, or uint."
