Matrix4

Matrix4

new

A 4x4 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.

Parameters:
Name Type Argument 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.
column2Row0 Number <optional>
0.0 The value for column 2, row 0.
column3Row0 Number <optional>
0.0 The value for column 3, 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.
column2Row1 Number <optional>
0.0 The value for column 2, row 1.
column3Row1 Number <optional>
0.0 The value for column 3, row 1.
column0Row2 Number <optional>
0.0 The value for column 0, row 2.
column1Row2 Number <optional>
0.0 The value for column 1, row 2.
column2Row2 Number <optional>
0.0 The value for column 2, row 2.
column3Row2 Number <optional>
0.0 The value for column 3, row 2.
column0Row3 Number <optional>
0.0 The value for column 0, row 3.
column1Row3 Number <optional>
0.0 The value for column 1, row 3.
column2Row3 Number <optional>
0.0 The value for column 2, row 3.
column3Row3 Number <optional>
0.0 The value for column 3, row 3.
See:
Source:

Members

<static>

The index into Matrix4 for column 0, row 0.

<static>

The index into Matrix4 for column 0, row 1.

<static>

The index into Matrix4 for column 0, row 2.

<static>

The index into Matrix4 for column 0, row 3.

<static>

The index into Matrix4 for column 1, row 0.

<static>

The index into Matrix4 for column 1, row 1.

<static>

The index into Matrix4 for column 1, row 2.

<static>

The index into Matrix4 for column 1, row 3.

<static>

The index into Matrix4 for column 2, row 0.

<static>

The index into Matrix4 for column 2, row 1.

<static>

The index into Matrix4 for column 2, row 2.

<static>

The index into Matrix4 for column 2, row 3.

<static>

The index into Matrix4 for column 3, row 0.

<static>

The index into Matrix4 for column 3, row 1.

<static>

The index into Matrix4 for column 3, row 2.

<static>

The index into Matrix4 for column 3, row 3.

<static>

An immutable Matrix4 instance initialized to the identity matrix.

Methods

Duplicates the provided Matrix4 instance.

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

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

Parameters:
Name Type Argument Description
right Matrix4 <optional>
The right hand side matrix.
Returns:
Boolean true if they are equal, false otherwise.

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

Parameters:
Name Type Argument Description
right Matrix4 <optional>
The right hand side matrix.
epsilon Number The epsilon to use for equality testing.
Throws:
DeveloperError : epsilon is required and must be a number.
Returns:
Boolean true if they are within the provided epsilon, false otherwise.

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

Parameters:
Name Type Argument Description
index Number The zero-based index of the column to retrieve.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : index is required and must be 0, 1, 2, or 3.
Returns:
Cartesian4 The modified result parameter or a new Cartesian4 instance if one was not provided.
See:

Gets the upper left 3x3 rotation matrix of this matrix, assuming the matrix is a affine transformation matrix.

Parameters:
Name Type Argument Description
result Matrix3 <optional>
The object onto which to store the result.
Returns:
Matrix3 The modified result parameter or a new Cartesian3 instance if one was not provided.
See:

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

Parameters:
Name Type Argument Description
index Number The zero-based index of the row to retrieve.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : index is required and must be 0, 1, 2, or 3.
Returns:
Cartesian4 The modified result parameter or a new Cartesian4 instance if one was not provided.
See:

Gets the translation portion of this matrix, assuming the matrix is a affine transformation matrix.

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

Computes the inverse of this matrix using Cramers Rule. If the determinant is zero, the matrix can not be inverted, and an exception is thrown. If the matrix is an affine transformation matrix, it is more efficient to invert it with #inverseTransformation.

Parameters:
Name Type Argument Description
result Matrix4 <optional>
The object onto which to store the result.
Throws:
RuntimeError : matrix is not invertible because its determinate is zero.
Returns:
Matrix4 The modified result parameter or a new Cartesian3 instance if one was not provided.

Computes the inverse of this matrix assuming it is an affine transformation matrix, where the upper left 3x3 elements are a rotation matrix, and the upper three elements in the fourth column are the translation. The bottom row is assumed to be [0, 0, 0, 1]. The matrix is not verified to be in the proper form. This method is faster than computing the inverse for a general 4x4 matrix using #inverse.

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

Computes the product of this matrix and the provided matrix.

Parameters:
Name Type Argument Description
right Matrix4 The right hand side matrix.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : right is required.
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.

Computes the product of a matrix and a Cartesian3. This is equivalent to calling Matrix4#multiplyByVector with a Cartesian4 with a w component of one.

Parameters:
Name Type Argument Description
cartesian Cartesian3 The point.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : cartesian is required.
Returns:
Cartesian4 The modified result parameter or a new Cartesian4 instance if one was not provided.

Computes the product of this matrix and a scalar.

Parameters:
Name Type Argument Description
scalar Number The number to multiply by.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : scalar is required and must be a number.
Returns:
Matrix4 The modified result parameter or a new Cartesian4 instance if one was not provided.

Multiplies this matrix, assuming it is a transformation matrix (with a bottom row of [0.0, 0.0, 0.0, 1.0]), by an implicit translation matrix defined by a Cartesian3.

Parameters:
Name Type Argument Description
translation Cartesian3 The translation on the right-hand side of the multiplication.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : translation is required.
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.

Multiplies this matrix, assuming it is a transformation matrix (with a bottom row of [0.0, 0.0, 0.0, 1.0]), by an implicit uniform scale matrix.

Parameters:
Name Type Argument Description
scale Number The scale on the right-hand side of the multiplication.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : scale is required.
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.

Computes the product of this matrix and a column vector.

Parameters:
Name Type Argument Description
cartesian Cartesian4 The vector.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : cartesian is required.
Returns:
Cartesian4 The modified result parameter or a new Cartesian4 instance if one was not provided.

Computes a negated copy of this matrix.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to negate.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : matrix is required.
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.

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

Parameters:
Name Type Description
index Number The zero-based index of the column to set.
cartesian Cartesian4 The Cartesian whose values will be assigned to the specified column.
Throws:
See:

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

Parameters:
Name Type Description
index Number The zero-based index of the row to set.
cartesian Cartesian4 The Cartesian whose values will be assigned to the specified row.
Throws:
See:

Computes an Array from this Matrix4 instance.

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

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

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

Computes the transpose of this matrix.

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

<static>

Duplicates a Matrix4 instance.

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

<static>

Computes a Matrix4 instance representing an infinite off center perspective transformation.

Parameters:
Name Type Argument Description
left Number The number of meters to the left of the camera that will be in view.
right Number The number of meters to the right of the camera that will be in view.
bottom Number The number of meters below of the camera that will be in view.
top Number The number of meters above of the camera that will be in view.
near Number The distance to the near plane in meters.
far Number The distance to the far plane in meters.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.

<static>

Computes a Matrix4 instance representing an orthographic transformation matrix.

Parameters:
Name Type Argument Description
left Number The number of meters to the left of the camera that will be in view.
right Number The number of meters to the right of the camera that will be in view.
bottom Number The number of meters below of the camera that will be in view.
top Number The number of meters above of the camera that will be in view.
near Number The distance to the near plane in meters.
far Number The distance to the far plane in meters.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.

<static>

Computes a Matrix4 instance representing a perspective transformation matrix.

Parameters:
Name Type Argument Description
fovY Number The field of view along the Y axis in radians.
aspectRatio Number The aspect ratio.
near Number The distance to the near plane in meters.
far Number The distance to the far plane in meters.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.

<static>

Computes a Matrix4 instance representing an off center perspective transformation.

Parameters:
Name Type Argument Description
left Number The number of meters to the left of the camera that will be in view.
right Number The number of meters to the right of the camera that will be in view.
bottom Number The number of meters below of the camera that will be in view.
top Number The number of meters above of the camera that will be in view.
near Number The distance to the near plane in meters.
far Number The distance to the far plane in meters.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.

<static>

Computes a Matrix4 instance that transforms from normalized device coordinates to window coordinates.

Parameters:
Name Type Argument Default Description
viewport Object <optional>
{ x : 0.0, y : 0.0, width : 0.0, height : 0.0 } The viewport's corners as shown in Example 1.
nearDepthRange Number <optional>
0.0 The near plane distance in window coordinates.
farDepthRange Number <optional>
1.0 The far plane distance in window coordinates.
result Matrix4 <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 Matrix4 instance if one was not provided.
Example
// Example 1.  Create viewport transformation using an explicit viewport and depth range.
var m = Matrix4.computeViewportTransformation({
    x : 0.0,
    y : 0.0,
    width : 1024.0,
    height : 768.0
}, 0.0, 1.0);

// Example 2.  Create viewport transformation using the context's viewport.
var m = Matrix4.computeViewportTransformation(context.getViewport());
See:

<static>

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

Parameters:
Name Type Argument Description
left Matrix4 <optional>
The first matrix.
right Matrix4 <optional>
The second matrix.
Returns:
Boolean true if left and right are equal, false otherwise.
Example
//compares two Matrix4 instances

// a = [10.0, 14.0, 18.0, 22.0]
//     [11.0, 15.0, 19.0, 23.0]
//     [12.0, 16.0, 20.0, 24.0]
//     [13.0, 17.0, 21.0, 25.0]

// b = [10.0, 14.0, 18.0, 22.0]
//     [11.0, 15.0, 19.0, 23.0]
//     [12.0, 16.0, 20.0, 24.0]
//     [13.0, 17.0, 21.0, 25.0]

if(Matrix4.equals(a,b)) {
     console.log("Both matrices are equal");
} else {
     console.log("They are not equal");
}

//Prints "Both matrices are equal" on the console

<static>

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

Parameters:
Name Type Argument Description
left Matrix4 <optional>
The first matrix.
right Matrix4 <optional>
The second matrix.
epsilon Number The epsilon to use for equality testing.
Throws:
DeveloperError : epsilon is required and must be a number.
Returns:
Boolean true if left and right are within the provided epsilon, false otherwise.
Example
//compares two Matrix4 instances

// a = [10.5, 14.5, 18.5, 22.5]
//     [11.5, 15.5, 19.5, 23.5]
//     [12.5, 16.5, 20.5, 24.5]
//     [13.5, 17.5, 21.5, 25.5]

// b = [10.0, 14.0, 18.0, 22.0]
//     [11.0, 15.0, 19.0, 23.0]
//     [12.0, 16.0, 20.0, 24.0]
//     [13.0, 17.0, 21.0, 25.0]

if(Matrix4.equalsEpsilon(a,b,0.1)){
     console.log("Difference between both the matrices is less than 0.1");
} else {
     console.log("Difference between both the matrices is not less than 0.1");
}

//Prints "Difference between both the matrices is not less than 0.1" on the console

<static>

Computes a Matrix4 instance from a Camera.

Parameters:
Name Type Argument Description
camera Camera The camera to use.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.

<static>

Computes a Matrix4 instance from a column-major order array.

Parameters:
Name Type Argument Description
values Array The column-major order array.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
DeveloperError : values is required.
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.

<static>

Computes a Matrix4 instance from a Matrix3 representing the rotation and a Cartesian3 representing the translation.

Parameters:
Name Type Argument Description
rotation Matrix3 The upper left portion of the matrix representing the rotation.
translation Cartesian3 The upper right portion of the matrix representing the translation.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.

<static>

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

Parameters:
Name Type Argument Description
values Array The row-major order array.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
DeveloperError : values is required.
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.

<static>

Computes a Matrix4 instance representing a non-uniform scale.

Parameters:
Name Type Argument Description
scale Cartesian3 The x, y, and z scale factors.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
DeveloperError : scale is required.
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.
Example
// Creates
//   [7.0, 0.0, 0.0, 0.0]
//   [0.0, 8.0, 0.0, 0.0]
//   [0.0, 0.0, 9.0, 0.0]
//   [0.0, 0.0, 0.0, 1.0]
var m = Matrix4.fromScale(new Cartesian3(7.0, 8.0, 9.0));

<static>

Creates a Matrix4 instance from a Cartesian3 representing the translation.

Parameters:
Name Type Argument Description
translation Cartesian3 The upper right portion of the matrix representing the translation.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
DeveloperError : translation is required.
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.
See:

<static>

Computes a Matrix4 instance representing a uniform scale.

Parameters:
Name Type Argument Description
scale Number The uniform scale factor.
result Matrix4 <optional>
The object in which the result will be stored, if undefined a new instance will be created.
Throws:
DeveloperError : scale is required.
Returns:
The modified result parameter, or a new Matrix4 instance if one was not provided.
Example
// Creates
//   [2.0, 0.0, 0.0, 0.0]
//   [0.0, 2.0, 0.0, 0.0]
//   [0.0, 0.0, 2.0, 0.0]
//   [0.0, 0.0, 0.0, 1.0]
var m = Matrix4.fromScale(2.0);

<static>

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

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to use.
index Number The zero-based index of the column to retrieve.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
Returns:
Cartesian4 The modified result parameter or a new Cartesian4 instance if one was not provided.
Example
//returns a Cartesian4 instance with values from the specified column
// m = [10.0, 11.0, 12.0, 13.0]
//     [14.0, 15.0, 16.0, 17.0]
//     [18.0, 19.0, 20.0, 21.0]
//     [22.0, 23.0, 24.0, 25.0]

//Example 1: Creates an instance of Cartesian
var a = Matrix4.getColumn(m, 2);

//Example 2: Sets values for Cartesian instance
var a = new Cartesian4();
Matrix4.getColumn(m, 2, a);

// a.x = 12.0; a.y = 16.0; a.z = 20.0; a.w = 24.0;
See:

<static>

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.
Throws:
Returns:
Number The index of the element at the provided row and column.
Example
var myMatrix = new Matrix4();
var column1Row0Index = Matrix4.getElementIndex(1, 0);
var column1Row0 = myMatrix[column1Row0Index]
myMatrix[column1Row0Index] = 10.0;

<static>

Gets the upper left 3x3 rotation matrix of the provided matrix, assuming the matrix is a affine transformation matrix.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to use.
result Matrix3 <optional>
The object onto which to store the result.
Throws:
DeveloperError : matrix is required.
Returns:
Matrix3 The modified result parameter or a new Cartesian3 instance if one was not provided.
Example
// returns a Matrix3 instance from a Matrix4 instance

// m = [10.0, 14.0, 18.0, 22.0]
//     [11.0, 15.0, 19.0, 23.0]
//     [12.0, 16.0, 20.0, 24.0]
//     [13.0, 17.0, 21.0, 25.0]

var b = new Matrix3();
Matrix4.getRotation(m,b);

// b = [10.0, 14.0, 18.0]
//     [11.0, 15.0, 19.0]
//     [12.0, 16.0, 20.0]
See:

<static>

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

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to use.
index Number The zero-based index of the row to retrieve.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
Returns:
Cartesian4 The modified result parameter or a new Cartesian4 instance if one was not provided.
Example
//returns a Cartesian4 instance with values from the specified column
// m = [10.0, 11.0, 12.0, 13.0]
//     [14.0, 15.0, 16.0, 17.0]
//     [18.0, 19.0, 20.0, 21.0]
//     [22.0, 23.0, 24.0, 25.0]

//Example 1: Returns an instance of Cartesian
var a = Matrix4.getRow(m, 2);

//Example 1: Sets values for a Cartesian instance
var a = new Cartesian4();
Matrix4.getRow(m, 2, a);

// a.x = 18.0; a.y = 19.0; a.z = 20.0; a.w = 21.0;
See:

<static>

Gets the translation portion of the provided matrix, assuming the matrix is a affine transformation matrix.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to use.
result Cartesian3 <optional>
The object onto which to store the result.
Throws:
DeveloperError : matrix is required.
Returns:
Cartesian3 The modified result parameter or a new Cartesian3 instance if one was not provided.
See:

<static>

Computes the inverse of the provided matrix using Cramers Rule. If the determinant is zero, the matrix can not be inverted, and an exception is thrown. If the matrix is an affine transformation matrix, it is more efficient to invert it with #inverseTransformation.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to invert.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
Returns:
Matrix4 The modified result parameter or a new Cartesian3 instance if one was not provided.

<static>

Computes the inverse of the provided matrix assuming it is an affine transformation matrix, where the upper left 3x3 elements are a rotation matrix, and the upper three elements in the fourth column are the translation. The bottom row is assumed to be [0, 0, 0, 1]. The matrix is not verified to be in the proper form. This method is faster than computing the inverse for a general 4x4 matrix using #inverse.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to invert.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : matrix is required.
Returns:
Matrix4 The modified result parameter or a new Cartesian3 instance if one was not provided.

<static>

Computes the product of two matrices.

Parameters:
Name Type Argument Description
left Matrix4 The first matrix.
right Matrix4 The second matrix.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.

<static>

Computes the product of a matrix and a Cartesian3. This is equivalent to calling Matrix4.multiplyByVector with a Cartesian4 with a w component of one.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix.
cartesian Cartesian3 The point.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
Returns:
Cartesian4 The modified result parameter or a new Cartesian4 instance if one was not provided.
Example
Cartesian3 p = new Cartesian3(1.0, 2.0, 3.0);
Matrix4.multiplyByPoint(matrix, p, result);
// A shortcut for
//   Cartesian3 p = ...
//   Matrix4.multiplyByVector(matrix, new Cartesian4(p.x, p.y, p.z, 1.0), result);

<static>

Computes the product of a matrix and a scalar.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix.
scalar Number The number to multiply by.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
Returns:
Matrix4 The modified result parameter or a new Cartesian4 instance if one was not provided.
Example
//create a Matrix4 instance which is a scaled version of the supplied Matrix4
// m = [10.0, 11.0, 12.0, 13.0]
//     [14.0, 15.0, 16.0, 17.0]
//     [18.0, 19.0, 20.0, 21.0]
//     [22.0, 23.0, 24.0, 25.0]

var a = Matrix4.multiplyByScalar(m, -2);

// m remains the same
// a = [-20.0, -22.0, -24.0, -26.0]
//     [-28.0, -30.0, -32.0, -34.0]
//     [-36.0, -38.0, -40.0, -42.0]
//     [-44.0, -46.0, -48.0, -50.0]

<static>

Multiplies a transformation matrix (with a bottom row of [0.0, 0.0, 0.0, 1.0]) by an implicit translation matrix defined by a Cartesian3. This is an optimization for Matrix4.multiply(m, Matrix4.fromTranslation(position), m); with less allocations and arithmetic operations.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix on the left-hand side.
translation Cartesian3 The translation on the right-hand side.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.
Example
// Instead of Matrix4.multiply(m, Matrix4.fromTranslation(position), m);
Matrix4.multiplyByTranslation(m, position, m);
See:
  • Matrix4#fromTranslation

<static>

Multiplies a transformation matrix (with a bottom row of [0.0, 0.0, 0.0, 1.0]) by an implicit uniform scale matrix. This is an optimization for Matrix4.multiply(m, Matrix4.fromScale(scale), m); with less allocations and arithmetic operations.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix on the left-hand side.
scale Number The uniform scale on the right-hand side.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.
Example
// Instead of Matrix4.multiply(m, Matrix4.fromUniformScale(scale), m);
Matrix4.multiplyByUniformScale(m, scale, m);
See:
  • Matrix4#fromUniformScale

<static>

Computes the product of a matrix and a column vector.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix.
cartesian Cartesian4 The vector.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
Returns:
Cartesian4 The modified result parameter or a new Cartesian4 instance if one was not provided.

<static>

Computes a negated copy of the provided matrix.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to negate.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : matrix is required.
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.
Example
//create a new Matrix4 instance which is a negation of a Matrix4
// m = [10.0, 11.0, 12.0, 13.0]
//     [14.0, 15.0, 16.0, 17.0]
//     [18.0, 19.0, 20.0, 21.0]
//     [22.0, 23.0, 24.0, 25.0]

var a = Matrix4.negate(m);

// m remains the same
// a = [-10.0, -11.0, -12.0, -13.0]
//     [-14.0, -15.0, -16.0, -17.0]
//     [-18.0, -19.0, -20.0, -21.0]
//     [-22.0, -23.0, -24.0, -25.0]

<static>

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

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to use.
index Number The zero-based index of the column to set.
cartesian Cartesian4 The Cartesian whose values will be assigned to the specified column.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.
Example
//creates a new Matrix4 instance with new column values from the Cartesian4 instance
// m = [10.0, 11.0, 12.0, 13.0]
//     [14.0, 15.0, 16.0, 17.0]
//     [18.0, 19.0, 20.0, 21.0]
//     [22.0, 23.0, 24.0, 25.0]

var a = Matrix4.setColumn(m, 2, new Cartesian4(99.0, 98.0, 97.0, 96.0));

// m remains the same
// a = [10.0, 11.0, 99.0, 13.0]
//     [14.0, 15.0, 98.0, 17.0]
//     [18.0, 19.0, 97.0, 21.0]
//     [22.0, 23.0, 96.0, 25.0]
See:

<static>

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

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to use.
index Number The zero-based index of the row to set.
cartesian Cartesian4 The Cartesian whose values will be assigned to the specified row.
result Cartesian4 <optional>
The object onto which to store the result.
Throws:
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.
Example
//create a new Matrix4 instance with new row values from the Cartesian4 instance
// m = [10.0, 11.0, 12.0, 13.0]
//     [14.0, 15.0, 16.0, 17.0]
//     [18.0, 19.0, 20.0, 21.0]
//     [22.0, 23.0, 24.0, 25.0]

var a = Matrix4.setRow(m, 2, new Cartesian4(99.0, 98.0, 97.0, 96.0));

// m remains the same
// a = [10.0, 11.0, 12.0, 13.0]
//     [14.0, 15.0, 16.0, 17.0]
//     [99.0, 98.0, 97.0, 96.0]
//     [22.0, 23.0, 24.0, 25.0]
See:

<static>

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

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to use..
result Array <optional>
The Array onto which to store the result.
Throws:
DeveloperError : matrix is required.
Returns:
Array The modified Array parameter or a new Array instance if one was not provided.
Example
//create an array from an instance of Matrix4
// m = [10.0, 14.0, 18.0, 22.0]
//     [11.0, 15.0, 19.0, 23.0]
//     [12.0, 16.0, 20.0, 24.0]
//     [13.0, 17.0, 21.0, 25.0]
var a = Matrix4.toArray(m);

// m remains the same
//creates a = [10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0, 17.0, 18.0, 19.0, 20.0, 21.0, 22.0, 23.0, 24.0, 25.0]

<static>

Computes the transpose of the provided matrix.

Parameters:
Name Type Argument Description
matrix Matrix4 The matrix to transpose.
result Matrix4 <optional>
The object onto which to store the result.
Throws:
DeveloperError : matrix is required.
Returns:
Matrix4 The modified result parameter or a new Matrix4 instance if one was not provided.
Example
//returns transpose of a Matrix4
// m = [10.0, 11.0, 12.0, 13.0]
//     [14.0, 15.0, 16.0, 17.0]
//     [18.0, 19.0, 20.0, 21.0]
//     [22.0, 23.0, 24.0, 25.0]

var a = Matrix4.negate(m);

// m remains the same
// a = [10.0, 14.0, 18.0, 22.0]
//     [11.0, 15.0, 19.0, 23.0]
//     [12.0, 16.0, 20.0, 24.0]
//     [13.0, 17.0, 21.0, 25.0]