Constructor
new Matrix4()
Create a 4x4 matrix.
Methods
clone() → {Matrix4}
Creates a new Matrix4 with identical elements to this one.
- Type:
- Matrix4
copy(m) → {Matrix4}
Copies the elements of matrix m into this matrix.
| Name | Type | Description |
|---|---|---|
m | Matrix4 |
- Type:
- Matrix4
decompose(position, quaternion, scale) → {Matrix4}
Decomposes this matrix into it's position, quaternion and scale components.
| Name | Type | Description |
|---|---|---|
position | Vector3 | |
quaternion | Quaternion | |
scale | Vector3 |
- Type:
- Matrix4
determinant() → {number}
Computes and returns the determinant of this matrix.
- Type:
- number
equals(m) → {boolean}
Return true if this matrix and m are equal.
| Name | Type | Description |
|---|---|---|
m | Matrix4 |
- Type:
- boolean
extractRotation(m) → {Matrix4}
Extracts the rotation component of the supplied matrix m into this matrix's rotation component.
| Name | Type | Description |
|---|---|---|
m | Matrix4 |
- Type:
- Matrix4
fromArray(array, offsetopt) → {Matrix4}
Sets the elements of this matrix based on an array in column-major format.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
array | Array.<number> | |||
offset | number | <optional> | 0 |
- Type:
- Matrix4
getInverse(m) → {Matrix4}
Take the inverse of the matrix
| Name | Type | Description |
|---|---|---|
m | Matrix4 |
- Type:
- Matrix4
getMaxScaleOnAxis() → {number}
Gets the maximum scale value of the 3 axes.
- Type:
- number
identity() → {Matrix4}
Resets this matrix to the identity matrix.
- Type:
- Matrix4
inverse() → {Matrix4}
Take the inverse of this matrix
- Type:
- Matrix4
isIdentity() → {boolean}
Checks if the matrix is an identity matrix.
- True if the matrix is an identity matrix, false otherwise.
- Type:
- boolean
lerpMatrices(m1, m2, ratio) → {Matrix4}
Linearly interpolates between two matrix4.
- Type:
- Matrix4
lookAtRH(eye, target, up) → {Matrix4}
Constructs a rotation matrix, looking from eye towards center oriented by the up vector.
- Type:
- Matrix4
makeRotationAxis(axis, angle) → {Matrix4}
Sets this matrix as rotation transform around axis by theta radians.
| Name | Type | Description |
|---|---|---|
axis | Vector3 | |
angle | number |
- Type:
- Matrix4
makeRotationFromQuaternion(q) → {Matrix4}
Sets the rotation component of this matrix to the rotation specified by q, as outlined here.
| Name | Type | Description |
|---|---|---|
q | Quaternion |
- Type:
- Matrix4
makeScale(x, y, z) → {Matrix4}
Sets this matrix as a scaling transform.
| Name | Type | Description |
|---|---|---|
x | number | The amount to scale in the X axis. |
y | number | The amount to scale in the Y axis. |
z | number | The amount to scale in the Z axis. |
- Type:
- Matrix4
makeTranslation(x, y, z) → {Matrix4}
Sets this matrix as a translation transform.
| Name | Type | Description |
|---|---|---|
x | number | the amount to translate in the X axis. |
y | number | the amount to translate in the Y axis. |
z | number | the amount to translate in the Z axis. |
- Type:
- Matrix4
multiply(m) → {Matrix4}
Post-multiplies this matrix by m.
| Name | Type | Description |
|---|---|---|
m | Matrix4 |
- Type:
- Matrix4
multiplyMatrices(a, b) → {Matrix4}
Sets this matrix to a x b.
- Type:
- Matrix4
premultiply(m) → {Matrix4}
Pre-multiplies this matrix by m.
| Name | Type | Description |
|---|---|---|
m | Matrix4 |
- Type:
- Matrix4
set(n11, n12, n13, n14, n21, n22, n23, n24, n31, n32, n33, n34, n41, n42, n43, n44) → {Matrix4}
Set the elements of this matrix to the supplied row-major values n11, n12, ... n44.
| Name | Type | Description |
|---|---|---|
n11 | number | |
n12 | number | |
n13 | number | |
n14 | number | |
n21 | number | |
n22 | number | |
n23 | number | |
n24 | number | |
n31 | number | |
n32 | number | |
n33 | number | |
n34 | number | |
n41 | number | |
n42 | number | |
n43 | number | |
n44 | number |
- Type:
- Matrix4
setFromMatrix3(m) → {Matrix4}
Set the upper 3x3 elements of this matrix to the values of the Matrix3 m.
| Name | Type | Description |
|---|---|---|
m | Matrix3 |
- Type:
- Matrix4
toArray(arrayopt, offsetopt) → {Array.<number>}
Writes the elements of this matrix to an array in column-major format.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
array | Array.<number> | <optional> | ||
offset | number | <optional> | 0 |
- Type:
- Array.<number>
transform(position, scale, quaternion) → {Matrix4}
Make transform from position&scale&quaternion(Quaternion).
| Name | Type | Description |
|---|---|---|
position | Vector3 | |
scale | Vector3 | |
quaternion | Quaternion |
- Type:
- Matrix4
transpose() → {Matrix4}
Transposes this matrix.
- Type:
- Matrix4