Matrix2

Members

staticMatrix2.COLUMN0ROW0

The index into Matrix2 for column 0, row 0.

Example:

var matrix = new Cesium.Matrix2();
matrix[Matrix2.COLUMN0ROW0] = 5.0; //set column 0, row 0 to 5.0

Source: Core/Matrix2.js, line 731

staticMatrix2.COLUMN0ROW1

The index into Matrix2 for column 0, row 1.

Example:

var matrix = new Cesium.Matrix2();
matrix[Matrix2.COLUMN0ROW1] = 5.0; //set column 0, row 1 to 5.0

Source: Core/Matrix2.js, line 741

staticMatrix2.COLUMN1ROW0

The index into Matrix2 for column 1, row 0.

Example:

var matrix = new Cesium.Matrix2();
matrix[Matrix2.COLUMN1ROW0] = 5.0; //set column 1, row 0 to 5.0

Source: Core/Matrix2.js, line 751

staticMatrix2.COLUMN1ROW1

The index into Matrix2 for column 1, row 1.

Example:

var matrix = new Cesium.Matrix2();
matrix[Matrix2.COLUMN1ROW1] = 5.0; //set column 1, row 1 to 5.0

Source: Core/Matrix2.js, line 761

staticMatrix2.IDENTITY

An immutable Matrix2 instance initialized to the identity matrix.

Source: Core/Matrix2.js, line 720

Methods

clone(result) → Matrix2

Duplicates the provided Matrix2 instance.

Name	Type	Description
result	Matrix2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided.

Source: Core/Matrix2.js, line 770

equals(right) → Boolean

Compares this matrix to the provided matrix componentwise and returns true if they are equal, false otherwise.

Name	Type	Description
right	Matrix2	optional The right hand side matrix.

Returns:

true if they are equal, false otherwise.

Source: Core/Matrix2.js, line 782

equalsEpsilon(right, epsilon) → Boolean

Compares this matrix to the provided matrix componentwise and returns true if they are within the provided epsilon, false otherwise.

Name	Type	Description
right	Matrix2	optional The right hand side matrix.
epsilon	Number	The epsilon to use for equality testing.

Returns:

true if they are within the provided epsilon, false otherwise.

Source: Core/Matrix2.js, line 796

toString() → String

Creates a string representing this Matrix with each row being on a separate line and in the format '(column0, column1)'.

Returns:

A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1)'.

Source: Core/Matrix2.js, line 807

staticMatrix2.abs(matrix, result) → Matrix2

Computes a matrix, which contains the absolute (unsigned) values of the provided matrix's elements.

Name	Type	Description
matrix	Matrix2	The matrix with signed elements.
result	Matrix2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided.

Source: Core/Matrix2.js, line 651

staticMatrix2.clone(matrix, result) → Matrix2

Duplicates a Matrix2 instance.

Name	Type	Description
matrix	Matrix2	The matrix to duplicate.
result	Matrix2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided. (Returns undefined if matrix is undefined)

Source: Core/Matrix2.js, line 49

staticMatrix2.equals(left, right) → Boolean

Compares the provided matrices componentwise and returns true if they are equal, false otherwise.

Name	Type	Description
left	Matrix2	optional The first matrix.
right	Matrix2	optional The second matrix.

Returns:

true if left and right are equal, false otherwise.

Source: Core/Matrix2.js, line 679

staticMatrix2.equalsEpsilon(left, right, epsilon) → Boolean

Compares the provided matrices componentwise and returns true if they are within the provided epsilon, false otherwise.

Name	Type	Description
left	Matrix2	optional The first matrix.
right	Matrix2	optional The second matrix.
epsilon	Number	The epsilon to use for equality testing.

Returns:

true if left and right are within the provided epsilon, false otherwise.

Source: Core/Matrix2.js, line 700

staticMatrix2.fromArray(array, startingIndex, result) → Matrix2

Creates a Matrix2 from 4 consecutive elements in an array.

Name	Type	Default	Description
array	Number[]		The array whose 4 consecutive elements correspond to the positions of the matrix. Assumes column-major order.
startingIndex	Number	0	optional The offset into the array of the first element, which corresponds to first column first row position in the matrix.
result	Matrix2		optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided.

Example:

// Create the Matrix2:
// [1.0, 2.0]
// [1.0, 2.0]

var v = [1.0, 1.0, 2.0, 2.0];
var m = Cesium.Matrix2.fromArray(v);

// Create same Matrix2 with using an offset into an array
var v2 = [0.0, 0.0, 1.0, 1.0, 2.0, 2.0];
var m2 = Cesium.Matrix2.fromArray(v2, 2);

Source: Core/Matrix2.js, line 86

staticMatrix2.fromColumnMajorArray(values, result)

Creates a Matrix2 instance from a column-major order array.

Name	Type	Description
values	Number[]	The column-major order array.
result	Matrix2	optional The object in which the result will be stored, if undefined a new instance will be created.

Returns:

The modified result parameter, or a new Matrix2 instance if one was not provided.

Source: Core/Matrix2.js, line 115

staticMatrix2.fromRotation(angle, result)

Creates a rotation matrix.

Name	Type	Description
angle	Number	The angle, in radians, of the rotation. Positive angles are counterclockwise.
result	Matrix2	optional The object in which the result will be stored, if undefined a new instance will be created.

Returns:

The modified result parameter, or a new Matrix2 instance if one was not provided.

Example:

// Rotate a point 45 degrees counterclockwise.
var p = new Cesium.Cartesian2(5, 6);
var m = Cesium.Matrix2.fromRotation(Cesium.Math.toRadians(45.0));
var rotated = Cesium.Matrix2.multiplyByVector(m, p);

Source: Core/Matrix2.js, line 234

staticMatrix2.fromRowMajorArray(values, result)

Creates a Matrix2 instance from a row-major order array. The resulting matrix will be in column-major order.

Name	Type	Description
values	Number[]	The row-major order array.
result	Matrix2	optional The object in which the result will be stored, if undefined a new instance will be created.

Returns:

The modified result parameter, or a new Matrix2 instance if one was not provided.

Source: Core/Matrix2.js, line 134

staticMatrix2.fromScale(scale, result)

Computes a Matrix2 instance representing a non-uniform scale.

Name	Type	Description
scale	Cartesian2	The x and y scale factors.
result	Matrix2	optional The object in which the result will be stored, if undefined a new instance will be created.

Returns:

The modified result parameter, or a new Matrix2 instance if one was not provided.

Example:

// Creates
//   [7.0, 0.0]
//   [0.0, 8.0]
var m = Cesium.Matrix2.fromScale(new Cesium.Cartesian2(7.0, 8.0));

Source: Core/Matrix2.js, line 166

staticMatrix2.fromUniformScale(scale, result)

Computes a Matrix2 instance representing a uniform scale.

Name	Type	Description
scale	Number	The uniform scale factor.
result	Matrix2	optional The object in which the result will be stored, if undefined a new instance will be created.

Returns:

The modified result parameter, or a new Matrix2 instance if one was not provided.

Example:

// Creates
//   [2.0, 0.0]
//   [0.0, 2.0]
var m = Cesium.Matrix2.fromUniformScale(2.0);

Source: Core/Matrix2.js, line 200

staticMatrix2.getColumn(matrix, index, result) → Cartesian2

Retrieves a copy of the matrix column at the provided index as a Cartesian2 instance.

Name	Type	Description
matrix	Matrix2	The matrix to use.
index	Number	The zero-based index of the column to retrieve.
result	Cartesian2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Cartesian2 instance if one was not provided.

Throws:

• DeveloperError : index must be 0 or 1.

See:

• Cartesian2

Source: Core/Matrix2.js, line 325

staticMatrix2.getElementIndex(row, column) → Number

Computes the array index of the element at the provided row and column.

Name	Type	Description
row	Number	The zero-based index of the row.
column	Number	The zero-based index of the column.

Returns:

The index of the element at the provided row and column.

Throws:

• DeveloperError : row must be 0 or 1.
• DeveloperError : column must be 0 or 1.

Example:

var myMatrix = new Cesium.Matrix2();
var column1Row0Index = Cesium.Matrix2.getElementIndex(1, 0);
var column1Row0 = myMatrix[column1Row0Index]
myMatrix[column1Row0Index] = 10.0;

Source: Core/Matrix2.js, line 299

staticMatrix2.getMaximumScale(matrix) → Number

Computes the maximum scale assuming the matrix is an affine transformation. The maximum scale is the maximum length of the column vectors.

Name	Type	Description
matrix	Matrix2	The matrix.

Returns:

The maximum scale.

Source: Core/Matrix2.js, line 486

staticMatrix2.getRow(matrix, index, result) → Cartesian2

Retrieves a copy of the matrix row at the provided index as a Cartesian2 instance.

Name	Type	Description
matrix	Matrix2	The matrix to use.
index	Number	The zero-based index of the row to retrieve.
result	Cartesian2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Cartesian2 instance if one was not provided.

Throws:

• DeveloperError : index must be 0 or 1.

See:

• Cartesian2

Source: Core/Matrix2.js, line 395

staticMatrix2.getScale(matrix, result) → Cartesian2

Extracts the non-uniform scale assuming the matrix is an affine transformation.

Name	Type	Description
matrix	Matrix2	The matrix.
result	Cartesian2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Cartesian2 instance if one was not provided.

Source: Core/Matrix2.js, line 460

staticMatrix2.multiply(left, right, result) → Matrix2

Computes the product of two matrices.

Name	Type	Description
left	Matrix2	The first matrix.
right	Matrix2	The second matrix.
result	Matrix2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided.

Source: Core/Matrix2.js, line 500

staticMatrix2.multiplyByScalar(matrix, scalar, result) → Matrix2

Computes the product of a matrix and a scalar.

Name	Type	Description
matrix	Matrix2	The matrix.
scalar	Number	The number to multiply by.
result	Matrix2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Cartesian2 instance if one was not provided.

Source: Core/Matrix2.js, line 565

staticMatrix2.multiplyByVector(matrix, cartesian, result) → Cartesian2

Computes the product of a matrix and a column vector.

Name	Type	Description
matrix	Matrix2	The matrix.
cartesian	Cartesian2	The column.
result	Cartesian2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Cartesian2 instance if one was not provided.

Source: Core/Matrix2.js, line 535

staticMatrix2.negate(matrix, result) → Matrix2

Creates a negated copy of the provided matrix.

Name	Type	Description
matrix	Matrix2	The matrix to negate.
result	Matrix2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided.

Source: Core/Matrix2.js, line 594

staticMatrix2.setColumn(matrix, index, cartesian, result) → Matrix2

Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian2 instance.

Name	Type	Description
matrix	Matrix2	The matrix to use.
index	Number	The zero-based index of the column to set.
cartesian	Cartesian2	The Cartesian whose values will be assigned to the specified column.
result	Cartesian2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided.

Throws:

• DeveloperError : index must be 0 or 1.

See:

• Cartesian2

Source: Core/Matrix2.js, line 362

staticMatrix2.setRow(matrix, index, cartesian, result) → Matrix2

Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian2 instance.

Name	Type	Description
matrix	Matrix2	The matrix to use.
index	Number	The zero-based index of the row to set.
cartesian	Cartesian2	The Cartesian whose values will be assigned to the specified row.
result	Cartesian2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided.

Throws:

• DeveloperError : index must be 0 or 1.

See:

• Cartesian2

Source: Core/Matrix2.js, line 431

staticMatrix2.toArray(matrix, result) → Number[]

Creates an Array from the provided Matrix2 instance. The array will be in column-major order.

Name	Type	Description
matrix	Matrix2	The matrix to use..
result	Number[]	optional The Array onto which to store the result.

Returns:

The modified Array parameter or a new Array instance if one was not provided.

Source: Core/Matrix2.js, line 265

staticMatrix2.transpose(matrix, result) → Matrix2

Computes the transpose of the provided matrix.

Name	Type	Description
matrix	Matrix2	The matrix to transpose.
result	Matrix2	optional The object onto which to store the result.

Returns:

The modified result parameter or a new Matrix2 instance if one was not provided.

Source: Core/Matrix2.js, line 620