fl.motion.ColorMatrix - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	fl.motion
Class	public class ColorMatrix
Inheritance	ColorMatrix DynamicMatrix Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

The ColorMatrix class calculates and stores color matrixes based on given values. This class extends the DynamicMatrix class and also supports the ColorMatrixFilter class.

Related API Elements

fl.motion.DynamicMatrix
flash.filters.ColorMatrixFilter

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
		ColorMatrix() Calculates and stores color matrixes based on given values.	ColorMatrix
		Add(inMatrix:DynamicMatrix):Boolean Adds the current matrix with a specified matrix.	DynamicMatrix
		GetFlatArray():Array Calculates and returns a flat array of 20 numerical values representing the four matrixes set in this object.	ColorMatrix
		GetHeight():Number Returns the number of rows in the current matrix.	DynamicMatrix
		GetValue(row:int, col:int):Number Returns the value at the specified zero-based row and column in the current matrix.	DynamicMatrix
		GetWidth():Number Returns the number of columns in the current matrix.	DynamicMatrix
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		LoadIdentity():void Sets the current matrix to an identity matrix.	DynamicMatrix
		LoadZeros():void Sets all values in the current matrix to zero.	DynamicMatrix
		Multiply(inMatrix:DynamicMatrix, order:int):Boolean Multiplies the current matrix with a specified matrix; and either appends or prepends the specified matrix.	DynamicMatrix
		MultiplyNumber(value:Number):Boolean Multiplies a number with each item in the matrix and stores the results in the current matrix.	DynamicMatrix
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		SetBrightnessMatrix(value:Number):void Calculates and stores a brightness matrix based on the given value.	ColorMatrix
		SetContrastMatrix(value:Number):void Calculates and stores a contrast matrix based on the given value.	ColorMatrix
		SetHueMatrix(angle:Number):void Calculates and stores a hue matrix based on the given value.	ColorMatrix
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		SetSaturationMatrix(value:Number):void Calculates and stores a saturation matrix based on the given value.	ColorMatrix
		SetValue(row:int, col:int, value:Number):void Sets the value at a specified zero-based row and column in the current matrix.	DynamicMatrix
		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

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		MATRIX_ORDER_APPEND : int = 1 [static] Specifies that a matrix is appended for concatenation.	DynamicMatrix
		MATRIX_ORDER_PREPEND : int = 0 [static] Specifies that a matrix is prepended for concatenation.	DynamicMatrix

Constructor Detail

ColorMatrix

()

Constructor

public function ColorMatrix()

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Calculates and stores color matrixes based on given values.

Related API Elements

DynamicMatrix

Method Detail

GetFlatArray

()

method

public function GetFlatArray():Array

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Calculates and returns a flat array of 20 numerical values representing the four matrixes set in this object.

Returns

Array — An array of 20 items.

SetBrightnessMatrix

()

method

public function SetBrightnessMatrix(value:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Calculates and stores a brightness matrix based on the given value.

Parameters

value:Number — 0-255

SetContrastMatrix

()

method

public function SetContrastMatrix(value:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Calculates and stores a contrast matrix based on the given value.

Parameters

value:Number — 0-255

SetHueMatrix

()

method

public function SetHueMatrix(angle:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Calculates and stores a hue matrix based on the given value.

Parameters

angle:Number — 0-255

SetSaturationMatrix

()

method

public function SetSaturationMatrix(value:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Calculates and stores a saturation matrix based on the given value.

Parameters

value:Number — 0-255

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

ColorMatrix

GetFlatArray

SetBrightnessMatrix

SetContrastMatrix

SetHueMatrix

SetSaturationMatrix