goog.vec.mat3d

Provided By	`goog.vec.mat3d`

Performs a per-component addition of the matrices mat0 and mat1, storing the result into resultMat.

Parameters

`mat0`	`Float64Array`
	The first addend.
`mat1`	`Float64Array`
	The second addend.
`resultMat`	`Float64Array`
	The matrix to receive the results (may be either mat0 or mat1).

Returns

Float64Array

return resultMat so that operations can be chained together.

VIEW SOURCE

Creates a mat3d with all elements initialized to zero.

Parameters

None.

Returns

Float64Array

The new mat3d.

VIEW SOURCE

Creates a mat3d identity matrix.

Parameters

None.

Returns

Float64Array

The new mat3d.

VIEW SOURCE

Returns true if the components of mat0 are equal to the components of mat1.

Parameters

`mat0`	`Float64Array`
	The first matrix.
`mat1`	`Float64Array`
	The second matrix.

Returns

boolean

True if the two matrices are equivalent.

VIEW SOURCE

Retrieves the specified column from the matrix into the given vector array.

Parameters

`mat`	`Float64Array`
	The matrix supplying the values.
`column`	`number`
	The column to get the values from.
`vec`	`Float64Array`
	The vector elements to receive the column.

Returns

Float64Array

return vec so that operations can be chained together.

VIEW SOURCE

Retrieves the column values from the given matrix into the given vector elements.

Parameters

`mat`	`Float64Array`
	The matrix supplying the columns.
`vec0`	`Float64Array`
	The vector to receive column 0.
`vec1`	`Float64Array`
	The vector to receive column 1.
`vec2`	`Float64Array`
	The vector to receive column 2.

VIEW SOURCE

Retrieves the element at the requested row and column.

Parameters

`mat`	`Float64Array`
	The matrix containing the value to retrieve.
`row`	`number`
	The row index.
`column`	`number`
	The column index.

Returns

number

The element value at the requested row, column indices.

VIEW SOURCE

Retrieves the row values into the given vector.

Parameters

`mat`	`Float64Array`
	The matrix supplying the values.
`row`	`number`
	The index of the row supplying the values.
`vec`	`Float64Array`
	The vector to receive the row.

Returns

Float64Array

return vec so that operations can be chained together.

VIEW SOURCE

Retrieves the rows of the matrix into the supplied vectors.

Parameters

`mat`	`Float64Array`
	The matrix to supplying the values.
`vec0`	`Float64Array`
	The vector to receive row 0.
`vec1`	`Float64Array`
	The vector to receive row 1.
`vec2`	`Float64Array`
	The vector to receive row 2.

VIEW SOURCE

Computes the inverse of mat0 storing the result into resultMat. If the inverse is defined, this function returns true, false otherwise.

Parameters

`mat0`	`Float64Array`
	The matrix to invert.
`resultMat`	`Float64Array`
	The matrix to receive the result (may be mat0).

Returns

boolean

True if the inverse is defined. If false is returned, resultMat is not modified.

VIEW SOURCE

Makes the given 3x3 matrix a rotation matrix given Euler angles using the ZXZ convention. Given the euler angles [theta1, theta2, theta3], the rotation is defined as rotation = rotation_z(theta1) * rotation_x(theta2) * rotation_z(theta3), with theta1 in [0, 2 * pi], theta2 in [0, pi] and theta3 in [0, 2 * pi]. rotation_x(theta) means rotation around the X axis of theta radians.

Parameters

`mat`	`Float64Array`
	The matrix.
`theta1`	`number`
	The angle of rotation around the Z axis in radians.
`theta2`	`number`
	The angle of rotation around the X axis in radians.
`theta3`	`number`
	The angle of rotation around the Z axis in radians.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Makes the given 3x3 matrix the identity matrix.

Parameters

`mat`	`Float64Array`
	The matrix.

Returns

Float64Array

return mat so operations can be chained.

VIEW SOURCE

Makes the given 3x3 matrix a rotation matrix with the given rotation angle about the axis defined by the vector (ax, ay, az).

Parameters

`mat`	`Float64Array`
	The matrix.
`angle`	`number`
	The rotation angle in radians.
`ax`	`number`
	The x component of the rotation axis.
`ay`	`number`
	The y component of the rotation axis.
`az`	`number`
	The z component of the rotation axis.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Makes the given 3x3 matrix a rotation matrix with the given rotation angle about the X axis.

Parameters

`mat`	`Float64Array`
	The matrix.
`angle`	`number`
	The rotation angle in radians.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Makes the given 3x3 matrix a rotation matrix with the given rotation angle about the Y axis.

Parameters

`mat`	`Float64Array`
	The matrix.
`angle`	`number`
	The rotation angle in radians.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Makes the given 3x3 matrix a rotation matrix with the given rotation angle about the Z axis.

Parameters

`mat`	`Float64Array`
	The matrix.
`angle`	`number`
	The rotation angle in radians.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Makes the given 3x3 matrix a scale matrix with x, y, and z scale factors.

Parameters

`mat`	`Float64Array`
	The 3x3 (9-element) matrix array to receive the new scale matrix.
`x`	`number`
	The scale along the x axis.
`y`	`number`
	The scale along the y axis.
`z`	`number`
	The scale along the z axis.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Makes the given 3x3 matrix a translation matrix with x and y translation values.

Parameters

`mat`	`Float64Array`
	The matrix.
`x`	`number`
	The translation along the x axis.
`y`	`number`
	The translation along the y axis.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Makes the given 3x3 matrix the zero matrix.

Parameters

`mat`	`Float64Array`
	The matrix.

Returns

Float64Array

return mat so operations can be chained.

VIEW SOURCE

Multiplies the two matrices mat0 and mat1 using matrix multiplication, storing the result into resultMat.

Parameters

`mat0`	`Float64Array`
	The first (left hand) matrix.
`mat1`	`Float64Array`
	The second (right hand) matrix.
`resultMat`	`Float64Array`
	The matrix to receive the results (may be either mat0 or mat1).

Returns

Float64Array

return resultMat so that operations can be chained together.

VIEW SOURCE

Multiplies matrix mat0 with the given scalar, storing the result into resultMat.

Parameters

`mat`	`Float64Array`
	The matrix.
`scalar`	`number`
	The scalar value to multiple to each element of mat.
`resultMat`	`Float64Array`
	The matrix to receive the results (may be mat).

Returns

Float64Array

return resultMat so that operations can be chained together.

VIEW SOURCE

Transforms the given vector with the given matrix storing the resulting, transformed matrix into resultVec.

Parameters

`mat`	`Float64Array`
	The matrix supplying the transformation.
`vec`	`Float64Array`
	The vector to transform.
`resultVec`	`Float64Array`
	The vector to receive the results (may be vec).

Returns

Float64Array

return resultVec so that operations can be chained together.

VIEW SOURCE

Rotate the given matrix by angle about the x,y,z axis. Equivalent to: goog.vec.mat3d.multMat( mat, goog.vec.mat3d.makeRotate(goog.vec.mat3d.create(), angle, x, y, z), mat);

Parameters

`mat`	`Float64Array`
	The matrix.
`angle`	`number`
	The angle in radians.
`x`	`number`
	The x component of the rotation axis.
`y`	`number`
	The y component of the rotation axis.
`z`	`number`
	The z component of the rotation axis.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Rotate the given matrix by angle about the x axis. Equivalent to: goog.vec.mat3d.multMat( mat, goog.vec.mat3d.makeRotateX(goog.vec.mat3d.create(), angle), mat);

Parameters

`mat`	`Float64Array`
	The matrix.
`angle`	`number`
	The angle in radians.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Rotate the given matrix by angle about the y axis. Equivalent to: goog.vec.mat3d.multMat( mat, goog.vec.mat3d.makeRotateY(goog.vec.mat3d.create(), angle), mat);

Parameters

`mat`	`Float64Array`
	The matrix.
`angle`	`number`
	The angle in radians.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Rotate the given matrix by angle about the z axis. Equivalent to: goog.vec.mat3d.multMat( mat, goog.vec.mat3d.makeRotateZ(goog.vec.mat3d.create(), angle), mat);

Parameters

`mat`	`Float64Array`
	The matrix.
`angle`	`number`
	The angle in radians.

Returns

Float64Array

return mat so that operations can be chained.

VIEW SOURCE

Sets the specified column with the value from the supplied array.

Parameters

`mat`	`Float64Array`
	The matrix to receive the values.
`column`	`number`
	The column index to set the values on.
`vec`	`Float64Array`
	The vector elements for the column.

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Sets the specified column with the supplied values.

Parameters

`mat`	`Float64Array`
	The matrix to receive the values.
`column`	`number`
	The column index to set the values on.
`v0`	`number`
	The value for row 0.
`v1`	`number`
	The value for row 1.
`v2`	`number`
	The value for row 2.

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Sets the columns of the matrix from the set of vector elements.

Parameters

`mat`	`Float64Array`
	The matrix to receive the values.
`vec0`	`Float64Array`
	The values for column 0.
`vec1`	`Float64Array`
	The values for column 1.
`vec2`	`Float64Array`
	The values for column 2.

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Sets the diagonal values of the matrix from the given vector.

Parameters

`mat`	`Float64Array`
	The matrix to receive the values.
`vec`	`Float64Array`
	The vector containing the values.

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Sets the diagonal values of the matrix from the given values.

Parameters

`mat`	`Float64Array`
	The matrix to receive the values.
`v00`	`number`
	The values for (0, 0).
`v11`	`number`
	The values for (1, 1).
`v22`	`number`
	The values for (2, 2).

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Sets the element at the requested row and column.

Parameters

`mat`	`Float64Array`
	The matrix containing the value to retrieve.
`row`	`number`
	The row index.
`column`	`number`
	The column index.
`value`	`number`
	The value to set at the requested row, column.

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Initializes mat3d mat from Array src.

Parameters

`mat`	`Float64Array`
	The destination matrix.
`src`	`(Array<number>\|null)`
	The source matrix.

Returns

Float64Array

Return mat so that operations can be chained together.

VIEW SOURCE

Initializes mat3d mat from mat3d src.

Parameters

`mat`	`Float64Array`
	The destination matrix.
`src`	`Float64Array`
	The source matrix.

Returns

Float64Array

Return mat so that operations can be chained together.

VIEW SOURCE

Initializes mat3d mat from mat3f src (typed as a Float32Array to avoid circular goog.requires).

Parameters

`mat`	`Float64Array`
	The destination matrix.
`src`	`(Float32Array\|null)`
	The source matrix.

Returns

Float64Array

Return mat so that operations can be chained together.

VIEW SOURCE

Initializes the matrix from the set of values. Note the values supplied are in column major order.

Parameters

`mat`	`Float64Array`
	The matrix to receive the values.
`v00`	`number`
	The values at (0, 0).
`v10`	`number`
	The values at (1, 0).
`v20`	`number`
	The values at (2, 0).
`v01`	`number`
	The values at (0, 1).
`v11`	`number`
	The values at (1, 1).
`v21`	`number`
	The values at (2, 1).
`v02`	`number`
	The values at (0, 2).
`v12`	`number`
	The values at (1, 2).
`v22`	`number`
	The values at (2, 2).

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Sets the row values from the supplied vector.

Parameters

`mat`	`Float64Array`
	The matrix to receive the row values.
`row`	`number`
	The index of the row.
`vec`	`Float64Array`
	The vector containing the values.

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Sets the row values from the supplied values.

Parameters

`mat`	`Float64Array`
	The matrix to receive the values.
`row`	`number`
	The index of the row to receive the values.
`v0`	`number`
	The value for column 0.
`v1`	`number`
	The value for column 1.
`v2`	`number`
	The value for column 2.

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Sets the rows of the matrix from the supplied vectors.

Parameters

`mat`	`Float64Array`
	The matrix to receive the values.
`vec0`	`Float64Array`
	The values for row 0.
`vec1`	`Float64Array`
	The values for row 1.
`vec2`	`Float64Array`
	The values for row 2.

Returns

Float64Array

return mat so that operations can be chained together.

VIEW SOURCE

Performs a per-component subtraction of the matrices mat0 and mat1, storing the result into resultMat.

Parameters

`mat0`	`Float64Array`
	The minuend.
`mat1`	`Float64Array`
	The subtrahend.
`resultMat`	`Float64Array`
	The matrix to receive the results (may be either mat0 or mat1).

Returns

Float64Array

return resultMat so that operations can be chained together.

VIEW SOURCE

Decomposes a rotation matrix into Euler angles using the ZXZ convention so that rotation = rotation_z(theta1) * rotation_x(theta2) * rotation_z(theta3), with theta1 in [0, 2 * pi], theta2 in [0, pi] and theta3 in [0, 2 * pi]. rotation_x(theta) means rotation around the X axis of theta radians.

Parameters

`mat`	`Float64Array`
	The matrix.
`euler`	`Float64Array`
	The ZXZ Euler angles in radians as [theta1, theta2, theta3].
`opt_theta2IsNegative`	`boolean=`
	Whether theta2 is in [-pi, 0] instead of the default [0, pi].

Returns

Float64Array

return euler so that operations can be chained together.

VIEW SOURCE

Transposes the given matrix mat storing the result into resultMat.

Parameters

`mat`	`Float64Array`
	The matrix to transpose.
`resultMat`	`Float64Array`
	The matrix to receive the results (may be mat).

Returns

Float64Array

return resultMat so that operations can be chained together.

VIEW SOURCE

goog.vec.mat3d

Functions

addMat( mat0, mat1, resultMat ) → Float64Array

create() → Float64Array

createIdentity() → Float64Array

equals( mat0, mat1 ) → boolean

getColumn( mat, column, vec ) → Float64Array

getColumns( mat, vec0, vec1, vec2 ) → void

getElement( mat, row, column ) → number

getRow( mat, row, vec ) → Float64Array

getRows( mat, vec0, vec1, vec2 ) → void

invert( mat0, resultMat ) → boolean

makeEulerZXZ( mat, theta1, theta2, theta3 ) → Float64Array

makeIdentity( mat ) → Float64Array

makeRotate( mat, angle, ax, ay, az ) → Float64Array

makeRotateX( mat, angle ) → Float64Array

makeRotateY( mat, angle ) → Float64Array

makeRotateZ( mat, angle ) → Float64Array

makeScale( mat, x, y, z ) → Float64Array

makeTranslate( mat, x, y ) → Float64Array

makeZero( mat ) → Float64Array

multMat( mat0, mat1, resultMat ) → Float64Array

multScalar( mat, scalar, resultMat ) → Float64Array

multVec3( mat, vec, resultVec ) → Float64Array

rotate( mat, angle, x, y, z ) → Float64Array

rotateX( mat, angle ) → Float64Array

rotateY( mat, angle ) → Float64Array

rotateZ( mat, angle ) → Float64Array

setColumn( mat, column, vec ) → Float64Array

setColumnValues( mat, column, v0, v1, v2 ) → Float64Array

setColumns( mat, vec0, vec1, vec2 ) → Float64Array

setDiagonal( mat, vec ) → Float64Array

setDiagonalValues( mat, v00, v11, v22 ) → Float64Array

setElement( mat, row, column, value ) → Float64Array

setFromArray( mat, src ) → Float64Array

setFromMat3d( mat, src ) → Float64Array

setFromMat3f( mat, src ) → Float64Array

setFromValues( mat, v00, v10, v20, v01, v11, v21, v02, v12, v22 ) → Float64Array

setRow( mat, row, vec ) → Float64Array

setRowValues( mat, row, v0, v1, v2 ) → Float64Array

setRows( mat, vec0, vec1, vec2 ) → Float64Array

subMat( mat0, mat1, resultMat ) → Float64Array

toEulerZXZ( mat, euler, opt_theta2IsNegative ) → Float64Array

transpose( mat, resultMat ) → Float64Array

Properties

Type → Float64Array

addMat( `mat0`, `mat1`, `resultMat` ) `→` `Float64Array`

create() `→` `Float64Array`

createIdentity() `→` `Float64Array`

equals( `mat0`, `mat1` ) `→` `boolean`

getColumn( `mat`, `column`, `vec` ) `→` `Float64Array`

getColumns( `mat`, `vec0`, `vec1`, `vec2` ) `→` `void`

getElement( `mat`, `row`, `column` ) `→` `number`

getRow( `mat`, `row`, `vec` ) `→` `Float64Array`

getRows( `mat`, `vec0`, `vec1`, `vec2` ) `→` `void`

invert( `mat0`, `resultMat` ) `→` `boolean`

makeEulerZXZ( `mat`, `theta1`, `theta2`, `theta3` ) `→` `Float64Array`

makeIdentity( `mat` ) `→` `Float64Array`

makeRotate( `mat`, `angle`, `ax`, `ay`, `az` ) `→` `Float64Array`

makeRotateX( `mat`, `angle` ) `→` `Float64Array`

makeRotateY( `mat`, `angle` ) `→` `Float64Array`

makeRotateZ( `mat`, `angle` ) `→` `Float64Array`

makeScale( `mat`, `x`, `y`, `z` ) `→` `Float64Array`

makeTranslate( `mat`, `x`, `y` ) `→` `Float64Array`

makeZero( `mat` ) `→` `Float64Array`

multMat( `mat0`, `mat1`, `resultMat` ) `→` `Float64Array`

multScalar( `mat`, `scalar`, `resultMat` ) `→` `Float64Array`

multVec3( `mat`, `vec`, `resultVec` ) `→` `Float64Array`

rotate( `mat`, `angle`, `x`, `y`, `z` ) `→` `Float64Array`

rotateX( `mat`, `angle` ) `→` `Float64Array`

rotateY( `mat`, `angle` ) `→` `Float64Array`

rotateZ( `mat`, `angle` ) `→` `Float64Array`

setColumn( `mat`, `column`, `vec` ) `→` `Float64Array`

setColumnValues( `mat`, `column`, `v0`, `v1`, `v2` ) `→` `Float64Array`

setColumns( `mat`, `vec0`, `vec1`, `vec2` ) `→` `Float64Array`

setDiagonal( `mat`, `vec` ) `→` `Float64Array`

setDiagonalValues( `mat`, `v00`, `v11`, `v22` ) `→` `Float64Array`

setElement( `mat`, `row`, `column`, `value` ) `→` `Float64Array`

setFromArray( `mat`, `src` ) `→` `Float64Array`

setFromMat3d( `mat`, `src` ) `→` `Float64Array`

setFromMat3f( `mat`, `src` ) `→` `Float64Array`

setFromValues( `mat`, `v00`, `v10`, `v20`, `v01`, `v11`, `v21`, `v02`, `v12`, `v22` ) `→` `Float64Array`

setRow( `mat`, `row`, `vec` ) `→` `Float64Array`

setRowValues( `mat`, `row`, `v0`, `v1`, `v2` ) `→` `Float64Array`

setRows( `mat`, `vec0`, `vec1`, `vec2` ) `→` `Float64Array`

subMat( `mat0`, `mat1`, `resultMat` ) `→` `Float64Array`

toEulerZXZ( `mat`, `euler`, `opt_theta2IsNegative` ) `→` `Float64Array`

transpose( `mat`, `resultMat` ) `→` `Float64Array`

Type `→` `Float64Array`