Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
spark.effects.interpolation 
NumberInterpolator 
Packagespark.effects.interpolation
Classpublic class NumberInterpolator
InheritanceNumberInterpolator Inheritance Object
Implements IInterpolator

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The NumberInterpolator class provides interpolation between start and end values represented as Number instances.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
Constructor.
NumberInterpolator
  
decrement(baseValue:Object, decrementValue:Object):Object
Given a base value and a value to subtract from it, return the result of that decrement operation.
NumberInterpolator
  
[static] Returns the singleton of this class.
NumberInterpolator
 Inherited
Indicates whether an object has a specified property defined.
Object
  
increment(baseValue:Object, incrementValue:Object):Object
Given a base value and a value to add to it, return the result of that operation.
NumberInterpolator
  
interpolate(fraction:Number, startValue:Object, endValue:Object):Object
Interpolation for NumberInterpolator consists of a simple parametric calculation between startValue and endValue, using fraction as the fraction of the elapsed time from start to end: return startValue + fraction (endValue - startValue);
NumberInterpolator
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Constructor Detail

NumberInterpolator

()Constructor
public function NumberInterpolator()

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Method Detail

decrement

()method
public function decrement(baseValue:Object, decrementValue:Object):Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Given a base value and a value to subtract from it, return the result of that decrement operation. For example, if the objects are simple Numbers, the result would be Number(baseValue) - Number(incrementValue). This function is called by the animation system when it needs to dynamically calculate a value given some ending value and a 'by' value that should be subtracted from it. Both of the arguments are of type Object and cannot simply be added together.

Parameters

baseValue:Object — The start value of the interpolation.
 
decrementValue:Object — The change to apply to the baseValue.

Returns
Object — The interpolated value.

getInstance

()method 
public static function getInstance():NumberInterpolator

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the singleton of this class. Since all NumberInterpolators have the same behavior, there is no need for more than one instance.

Returns
NumberInterpolator

increment

()method 
public function increment(baseValue:Object, incrementValue:Object):Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Given a base value and a value to add to it, return the result of that operation. For example, if the objects are simple Numbers, the result is a Number(baseValue) + Number(incrementValue). This method is called by the animation system when it needs to dynamically calculate a value given some starting value and a 'by' value that should be added to it. Both of the arguments are of type Object and cannot simply be added together.

Parameters

baseValue:Object — The start value of the interpolation.
 
incrementValue:Object — The change to apply to the baseValue.

Returns
Object — The interpolated value.

interpolate

()method 
public function interpolate(fraction:Number, startValue:Object, endValue:Object):Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Interpolation for NumberInterpolator consists of a simple parametric calculation between startValue and endValue, using fraction as the fraction of the elapsed time from start to end:

return startValue + fraction (endValue - startValue);

Parameters

fraction:Number — The fraction elapsed of the animation, between 0.0 and 1.0.
 
startValue:Object — The start value of the interpolation.
 
endValue:Object — The end value of the interpolation.

Returns
Object — The interpolated value.