DynamicMatrix

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

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

The DynamicMatrix class calculates and stores a matrix based on given values. This class supports the ColorMatrixFilter and can be extended by the ColorMatrix class.

Related API Elements

fl.motion.ColorMatrix
flash.filters.ColorMatrixFilter

Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

	Method		Defined By
		DynamicMatrix(width:int, height:int) Constructs a matrix with the given number of rows and columns.	DynamicMatrix
		Add(inMatrix:DynamicMatrix):Boolean Adds the current matrix with a specified matrix.	DynamicMatrix
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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

	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

DynamicMatrix

()

Constructor

public function DynamicMatrix(width:int, height:int)

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Constructs a matrix with the given number of rows and columns.

Parameters

	`width:int` — Number of columns.

	`height:int` — Number of rows.

Method Detail

Add

()

method

public function Add(inMatrix:DynamicMatrix):Boolean

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Adds the current matrix with a specified matrix. The current matrix becomes the result of the addition (in other words the DynamicMatrix.Add() method does not create a new matrix to contain the result).

Parameters

inMatrix:DynamicMatrix — The matrix to add to the current matrix.

Returns

Boolean — A Boolean value indicating whether the addition succeeded (true) or failed (false). If the dimensions of the matrices are not the same, DynamicMatrix.Add() returns false.

GetHeight

()

method

public function GetHeight():Number

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Returns the number of rows in the current matrix.

Returns

Number — The number of rows.

GetValue

()

method

public function GetValue(row:int, col:int):Number

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Returns the value at the specified zero-based row and column in the current matrix.

Parameters

	`row:int` — The row containing the value you want.

	`col:int` — The column containing the value you want.

Returns

Number — Number The value at the specified row and column location.

GetWidth

()

method

public function GetWidth():Number

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Returns the number of columns in the current matrix.

Returns

Number — The number of columns.

Related API Elements

GetHeight

LoadIdentity

()

method

public function LoadIdentity():void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Sets the current matrix to an identity matrix.

Related API Elements

flash.geom.Matrix.identity()

LoadZeros

()

method

public function LoadZeros():void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Sets all values in the current matrix to zero.

Multiply

()

method

public function Multiply(inMatrix:DynamicMatrix, order:int):Boolean

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Multiplies the current matrix with a specified matrix; and either appends or prepends the specified matrix. Use the second parameter of the DynamicMatrix.Multiply() method to append or prepend the specified matrix.

Parameters

	`inMatrix:DynamicMatrix` — The matrix to add to the current matrix.

	`order:int` (default = `NaN`) — Specifies whether to append or prepend the matrix from the `inMatrix` parameter; either `MATRIX_ORDER_APPEND` or `MATRIX_ORDER_PREPEND`.

Returns

Boolean — A Boolean value indicating whether the multiplication succeeded (true) or failed (false). The value is false if either the current matrix or specified matrix (the inMatrix parameter) is null, or if the order is to append and the current matrix's width is not the same as the supplied matrix's height; or if the order is to prepend and the current matrix's height is not equal to the supplied matrix's width.

Related API Elements

MATRIX_ORDER_PREPEND
MATRIX_ORDER_APPEND

MultiplyNumber

()

method

public function MultiplyNumber(value:Number):Boolean

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Multiplies a number with each item in the matrix and stores the results in the current matrix.

Parameters

value:Number — A number to multiply by each item in the matrix.

Returns

Boolean — A Boolean value indicating whether the multiplication succeeded (true) or failed (false).

SetValue

()

method

public function SetValue(row:int, col:int, value:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Sets the value at a specified zero-based row and column in the current matrix.

Parameters

	`row:int` — The row containing the value you want to set.

	`col:int` — The column containing the value you want to set.

	`value:Number` — The number to insert into the matrix.

Constant Detail

MATRIX_ORDER_APPEND

Constant

public static const MATRIX_ORDER_APPEND:int = 1

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Specifies that a matrix is appended for concatenation.

MATRIX_ORDER_PREPEND

Constant

public static const MATRIX_ORDER_PREPEND:int = 0

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9, AIR 1.0

Specifies that a matrix is prepended for concatenation.

Legal Notices | Online Privacy Policy

DynamicMatrix - AS3 Flash

Classes x

DynamicMatrix

Add

GetHeight

GetValue

GetWidth

LoadIdentity

LoadZeros

Multiply

MultiplyNumber

SetValue

MATRIX_ORDER_APPEND

MATRIX_ORDER_PREPEND