ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
spark.effects.interpolation 

RGBInterpolator  - AS3 Flex
Packagespark.effects.interpolation
Classpublic class RGBInterpolator
InheritanceRGBInterpolator Inheritance Object
Implements IInterpolator

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

The RGBInterpolator class provides interpolation between uint start and end values that represent RGB colors. Interpolation is done by treating the start and end values as integers with color channel information in the least-significant 3 bytes, and then interpolating each of the channels separately.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
RGBInterpolator()
Constructor.
RGBInterpolator
  
decrement(baseValue:Object, decrementValue:Object):Object
Returns the result of the two values subtracted on a per-channel basis.
RGBInterpolator
  
getInstance():RGBInterpolator
[static] Returns the singleton of this class.
RGBInterpolator
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
  
increment(baseValue:Object, incrementValue:Object):Object
Returns the result of the two values added together on a per-channel basis.
RGBInterpolator
  
interpolate(fraction:Number, startValue:Object, endValue:Object):Object
Interpolation for the RGBInterpolator class takes the form of parametric calculations on each of the bottom three bytes of startValue and endValue.
RGBInterpolator
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Constructor Detail

RGBInterpolator

()Constructor
public function RGBInterpolator()

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

Returns the result of the two values subtracted on a per-channel basis. Each channel has a minimum value of 0 to avoid underflow problems.

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():RGBInterpolator

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 RGBInterpolators have the same behavior, there is no need for more than one instance.

Returns
RGBInterpolator — The singleton of this class.

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

Returns the result of the two values added together on a per-channel basis. Each channel has a maximum value of 255 to avoid overflow problems.

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 the RGBInterpolator class takes the form of parametric calculations on each of the bottom three bytes of startValue and endValue.

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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy