spark.effects.interpolation.RGBInterpolator - Adobe® Flex® 4 Language Reference (Flex 4)

Package	spark.effects.interpolation
Class	public class RGBInterpolator
Inheritance	RGBInterpolator 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined 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
		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
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		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

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.