Class: Matrix2

Matrix2

new Matrix2(column0Row0opt, column1Row0opt, column0Row1opt, column1Row1opt)

A 2x2 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.
Parameters:
Name Type Attributes Default Description
column0Row0 Number <optional>
 0.0 The value for column 0, row 0.
column1Row0 Number <optional>
 0.0 The value for column 1, row 0.
column0Row1 Number <optional>
 0.0 The value for column 0, row 1.
column1Row1 Number <optional>
 0.0 The value for column 1, row 1.
Source:
See:

Members

length :Number

Gets the number of items in the collection.
Type:
  • Number
Source:

(static, constant) COLUMN0ROW0 :Number

The index into Matrix2 for column 0, row 0.
Type:
  • Number
Source:
Example
var matrix = new Cesium.Matrix2();
matrix[Cesium.Matrix2.COLUMN0ROW0] = 5.0; // set column 0, row 0 to 5.0

(static, constant) COLUMN0ROW1 :Number

The index into Matrix2 for column 0, row 1.
Type:
  • Number
Source:
Example
var matrix = new Cesium.Matrix2();
matrix[Cesium.Matrix2.COLUMN0ROW1] = 5.0; // set column 0, row 1 to 5.0

(static, constant) COLUMN1ROW0 :Number

The index into Matrix2 for column 1, row 0.
Type:
  • Number
Source:
Example
var matrix = new Cesium.Matrix2();
matrix[Cesium.Matrix2.COLUMN1ROW0] = 5.0; // set column 1, row 0 to 5.0

(static, constant) COLUMN1ROW1 :Number

The index into Matrix2 for column 1, row 1.
Type:
  • Number
Source:
Example
var matrix = new Cesium.Matrix2();
matrix[Cesium.Matrix2.COLUMN1ROW1] = 5.0; // set column 1, row 1 to 5.0

(static, constant) IDENTITY :Matrix2

An immutable Matrix2 instance initialized to the identity matrix.
Type:
Source:

(static) packedLength :Number

The number of elements used to pack the object into an array.
Type:
  • Number
Source:

(static, constant) ZERO :Matrix2

An immutable Matrix2 instance initialized to the zero matrix.
Type:
Source:

Methods

clone(resultopt) → {Matrix2}

Duplicates the provided Matrix2 instance.
Parameters:
Name Type Attributes Description
result Matrix2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Matrix2 instance if one was not provided.
Type
Matrix2

equals(rightopt) → {Boolean}

Compares this matrix to the provided matrix componentwise and returns true if they are equal, false otherwise.
Parameters:
Name Type Attributes Description
right Matrix2 <optional>
 The right hand side matrix.
Source:
Returns:
true if they are equal, false otherwise.
Type
Boolean

equalsEpsilon(rightopt, epsilon) → {Boolean}

Compares this matrix to the provided matrix componentwise and returns true if they are within the provided epsilon, false otherwise.
Parameters:
Name Type Attributes Description
right Matrix2 <optional>
 The right hand side matrix.
epsilon Number The epsilon to use for equality testing.
Source:
Returns:
true if they are within the provided epsilon, false otherwise.
Type
Boolean

toString() → {String}

Creates a string representing this Matrix with each row being on a separate line and in the format '(column0, column1)'.
Source:
Returns:
A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1)'.
Type
String

(static) abs(matrix, result) → {Matrix2}

Computes a matrix, which contains the absolute (unsigned) values of the provided matrix's elements.
Parameters:
Name Type Description
matrix Matrix2 The matrix with signed elements.
result Matrix2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Matrix2

(static) add(left, right, result) → {Matrix2}

Computes the sum of two matrices.
Parameters:
Name Type Description
left Matrix2 The first matrix.
right Matrix2 The second matrix.
result Matrix2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Matrix2

(static) clone(matrix, resultopt) → {Matrix2}

Duplicates a Matrix2 instance.
Parameters:
Name Type Attributes Description
matrix Matrix2 The matrix to duplicate.
result Matrix2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Matrix2 instance if one was not provided. (Returns undefined if matrix is undefined)
Type
Matrix2

(static) equals(leftopt, rightopt) → {Boolean}

Compares the provided matrices componentwise and returns true if they are equal, false otherwise.
Parameters:
Name Type Attributes Description
left Matrix2 <optional>
 The first matrix.
right Matrix2 <optional>
 The second matrix.
Source:
Returns:
true if left and right are equal, false otherwise.
Type
Boolean

(static) equalsEpsilon(leftopt, rightopt, epsilon) → {Boolean}

Compares the provided matrices componentwise and returns true if they are within the provided epsilon, false otherwise.
Parameters:
Name Type Attributes Description
left Matrix2 <optional>
 The first matrix.
right Matrix2 <optional>
 The second matrix.
epsilon Number The epsilon to use for equality testing.
Source:
Returns:
true if left and right are within the provided epsilon, false otherwise.
Type
Boolean

(static) fromArray(array, startingIndexopt, resultopt) → {Matrix2}

Creates a Matrix2 from 4 consecutive elements in an array.
Parameters:
Name Type Attributes Default Description
array Array.<Number> The array whose 4 consecutive elements correspond to the positions of the matrix. Assumes column-major order.
startingIndex Number <optional>
 0 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.
Source:
Returns:
The modified result parameter or a new Matrix2 instance if one was not provided.
Type
Matrix2
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);

(static) fromColumnMajorArray(values, resultopt) → {Matrix2}

Creates a Matrix2 instance from a column-major order array.
Parameters:
Name Type Attributes Description
values Array.<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.
Source:
Returns:
The modified result parameter, or a new Matrix2 instance if one was not provided.
Type
Matrix2

(static) fromRotation(angle, resultopt) → {Matrix2}

Creates a rotation matrix.
Parameters:
Name Type Attributes 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.
Source:
Returns:
The modified result parameter, or a new Matrix2 instance if one was not provided.
Type
Matrix2
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, new Cesium.Cartesian2());

(static) fromRowMajorArray(values, resultopt) → {Matrix2}

Creates a Matrix2 instance from a row-major order array. The resulting matrix will be in column-major order.
Parameters:
Name Type Attributes Description
values Array.<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.
Source:
Returns:
The modified result parameter, or a new Matrix2 instance if one was not provided.
Type
Matrix2

(static) fromScale(scale, resultopt) → {Matrix2}

Computes a Matrix2 instance representing a non-uniform scale.
Parameters:
Name Type Attributes 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.
Source:
Returns:
The modified result parameter, or a new Matrix2 instance if one was not provided.
Type
Matrix2
Example
// Creates
//   [7.0, 0.0]
//   [0.0, 8.0]
var m = Cesium.Matrix2.fromScale(new Cesium.Cartesian2(7.0, 8.0));

(static) fromUniformScale(scale, resultopt) → {Matrix2}

Computes a Matrix2 instance representing a uniform scale.
Parameters:
Name Type Attributes 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.
Source:
Returns:
The modified result parameter, or a new Matrix2 instance if one was not provided.
Type
Matrix2
Example
// Creates
//   [2.0, 0.0]
//   [0.0, 2.0]
var m = Cesium.Matrix2.fromUniformScale(2.0);

(static) getColumn(matrix, index, result) → {Cartesian2}

Retrieves a copy of the matrix column at the provided index as a Cartesian2 instance.
Parameters:
Name Type Description
matrix Matrix2 The matrix to use.
index Number The zero-based index of the column to retrieve.
result Cartesian2 The object onto which to store the result.
Source:
Throws:
index must be 0 or 1.
Type
DeveloperError
Returns:
The modified result parameter.
Type
Cartesian2

(static) getElementIndex(row, column) → {Number}

Computes the array index of the element at the provided row and column.
Parameters:
Name Type Description
row Number The zero-based index of the row.
column Number The zero-based index of the column.
Source:
Throws:
Returns:
The index of the element at the provided row and column.
Type
Number
Example
var myMatrix = new Cesium.Matrix2();
var column1Row0Index = Cesium.Matrix2.getElementIndex(1, 0);
var column1Row0 = myMatrix[column1Row0Index]
myMatrix[column1Row0Index] = 10.0;

(static) 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.
Parameters:
Name Type Description
matrix Matrix2 The matrix.
Source:
Returns:
The maximum scale.
Type
Number

(static) getRow(matrix, index, result) → {Cartesian2}

Retrieves a copy of the matrix row at the provided index as a Cartesian2 instance.
Parameters:
Name Type Description
matrix Matrix2 The matrix to use.
index Number The zero-based index of the row to retrieve.
result Cartesian2 The object onto which to store the result.
Source:
Throws:
index must be 0 or 1.
Type
DeveloperError
Returns:
The modified result parameter.
Type
Cartesian2

(static) getScale(matrix, result) → {Cartesian2}

Extracts the non-uniform scale assuming the matrix is an affine transformation.
Parameters:
Name Type Description
matrix Matrix2 The matrix.
result Cartesian2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) multiply(left, right, result) → {Matrix2}

Computes the product of two matrices.
Parameters:
Name Type Description
left Matrix2 The first matrix.
right Matrix2 The second matrix.
result Matrix2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Matrix2

(static) multiplyByScalar(matrix, scalar, result) → {Matrix2}

Computes the product of a matrix and a scalar.
Parameters:
Name Type Description
matrix Matrix2 The matrix.
scalar Number The number to multiply by.
result Matrix2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Matrix2

(static) multiplyByScale(matrix, scale, result) → {Matrix2}

Computes the product of a matrix times a (non-uniform) scale, as if the scale were a scale matrix.
Parameters:
Name Type Description
matrix Matrix2 The matrix on the left-hand side.
scale Cartesian2 The non-uniform scale on the right-hand side.
result Matrix2 The object onto which to store the result.
Source:
See:
Returns:
The modified result parameter.
Type
Matrix2
Example
// Instead of Cesium.Matrix2.multiply(m, Cesium.Matrix2.fromScale(scale), m);
Cesium.Matrix2.multiplyByScale(m, scale, m);

(static) multiplyByVector(matrix, cartesian, result) → {Cartesian2}

Computes the product of a matrix and a column vector.
Parameters:
Name Type Description
matrix Matrix2 The matrix.
cartesian Cartesian2 The column.
result Cartesian2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Cartesian2

(static) negate(matrix, result) → {Matrix2}

Creates a negated copy of the provided matrix.
Parameters:
Name Type Description
matrix Matrix2 The matrix to negate.
result Matrix2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Matrix2

(static) pack(value, array, startingIndexopt) → {Array.<Number>}

Stores the provided instance into the provided array.
Parameters:
Name Type Attributes Default Description
value Matrix2 The value to pack.
array Array.<Number> The array to pack into.
startingIndex Number <optional>
 0 The index into the array at which to start packing the elements.
Source:
Returns:
The array that was packed into
Type
Array.<Number>

(static) setColumn(matrix, index, cartesian, result) → {Matrix2}

Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian2 instance.
Parameters:
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 The object onto which to store the result.
Source:
Throws:
index must be 0 or 1.
Type
DeveloperError
Returns:
The modified result parameter.
Type
Matrix2

(static) setRow(matrix, index, cartesian, result) → {Matrix2}

Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian2 instance.
Parameters:
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 Matrix2 The object onto which to store the result.
Source:
Throws:
index must be 0 or 1.
Type
DeveloperError
Returns:
The modified result parameter.
Type
Matrix2

(static) subtract(left, right, result) → {Matrix2}

Computes the difference of two matrices.
Parameters:
Name Type Description
left Matrix2 The first matrix.
right Matrix2 The second matrix.
result Matrix2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Matrix2

(static) toArray(matrix, resultopt) → {Array.<Number>}

Creates an Array from the provided Matrix2 instance. The array will be in column-major order.
Parameters:
Name Type Attributes Description
matrix Matrix2 The matrix to use..
result Array.<Number> <optional>
 The Array onto which to store the result.
Source:
Returns:
The modified Array parameter or a new Array instance if one was not provided.
Type
Array.<Number>

(static) transpose(matrix, result) → {Matrix2}

Computes the transpose of the provided matrix.
Parameters:
Name Type Description
matrix Matrix2 The matrix to transpose.
result Matrix2 The object onto which to store the result.
Source:
Returns:
The modified result parameter.
Type
Matrix2

(static) unpack(array, startingIndexopt, resultopt) → {Matrix2}

Retrieves an instance from a packed array.
Parameters:
Name Type Attributes Default Description
array Array.<Number> The packed array.
startingIndex Number <optional>
 0 The starting index of the element to be unpacked.
result Matrix2 <optional>
 The object into which to store the result.
Source:
Returns:
The modified result parameter or a new Matrix2 instance if one was not provided.
Type
Matrix2