mat4
Class4x4 matrix used for 3D transformations including rotation, scale, translation, and projection.
Index
Properties
Methods
- add
- compMult
- compose
- determinant
- div
- equal
- extractEulerAngles
- fromColumns
- fromEulerAngles
- fromEulerX
- fromEulerY
- fromEulerZ
- fromRotation
- fromRows
- fromScale
- fromTranslation
- identity
- inverse
- lookAt
- makeBasis
- mult
- multiplyDirection
- multiplyPoint
- multiplyScalar
- multiplyVector
- orthographic
- outerProduct
- perspective
- sub
- toString
- transpose
- zero
Example
const identity = new mat4();
console.log('mat4 identity column0:', identity.column0.x, identity.column0.y, identity.column0.z, identity.column0.w);
const a = new mat4();
a.column0 = new vec4(2, 0, 0, 0);
a.column1 = new vec4(0, 2, 0, 0);
a.column2 = new vec4(0, 0, 2, 0);
a.column3 = new vec4(0, 0, 0, 1);
const b = new mat4();
b.column0 = new vec4(1, 0, 0, 0);
b.column1 = new vec4(0, 1, 0, 0);
b.column2 = new vec4(0, 0, 1, 0);
b.column3 = new vec4(5, 10, 15, 1);
const result = a.mult(b);
console.log('Multiplied mat4 column3 (translation):', result.column3.x, result.column3.y, result.column3.z);
Constructors
Constructor
new mat4():
mat4
Constructs a new identity mat4.
Returns
mat4
Properties
column0
column0:
vec4
First column of the matrix as a vec4.
column1
column1:
vec4
Second column of the matrix as a vec4.
column2
column2:
vec4
Third column of the matrix as a vec4.
column3
column3:
vec4
Fourth column of the matrix as a vec4.
description
description:
string
Returns a string representation of the matrix.
Methods
add()
add(
mat):mat4
Adds another mat4 to this matrix and returns the result.
Parameters
| Parameter | Type |
|---|---|
mat | mat4 |
Returns
mat4
compMult()
staticcompMult(a,b):mat4
Performs component-wise multiplication of two mat4 matrices and returns the result.
Parameters
| Parameter | Type |
|---|---|
a | mat4 |
b | mat4 |
Returns
mat4
compose()
staticcompose(translation,rotation,scale):mat4
Constructs a mat4 from translation, rotation quaternion, and scale components.
Parameters
Returns
mat4
determinant()
determinant():
number
Returns the scalar determinant of this matrix.
Returns
number
div()
div(
mat):mat4
Divides this matrix by another mat4 element-wise and returns the result.
Parameters
| Parameter | Type |
|---|---|
mat | mat4 |
Returns
mat4
equal()
equal(
mat):boolean
Returns true if this matrix equals the given mat4.
Parameters
| Parameter | Type |
|---|---|
mat | mat4 |
Returns
boolean
extractEulerAngles()
extractEulerAngles():
vec3
Extracts and returns the Euler angles as a vec3 from this matrix.
Returns
fromColumns()
staticfromColumns(column0,column1,column2,column3):mat4
Creates a mat4 from four column vectors.
Parameters
Returns
mat4
fromEulerAngles()
staticfromEulerAngles(angles):mat4
Creates a mat4 rotation matrix from Euler angles in radians.
Parameters
| Parameter | Type |
|---|---|
angles | vec3 |
Returns
mat4
fromEulerX()
staticfromEulerX(angle):mat4
Creates a mat4 rotation matrix for a rotation around the X axis.
Parameters
| Parameter | Type |
|---|---|
angle | number |
Returns
mat4
fromEulerY()
staticfromEulerY(angle):mat4
Creates a mat4 rotation matrix for a rotation around the Y axis.
Parameters
| Parameter | Type |
|---|---|
angle | number |
Returns
mat4
fromEulerZ()
staticfromEulerZ(angle):mat4
Creates a mat4 rotation matrix for a rotation around the Z axis.
Parameters
| Parameter | Type |
|---|---|
angle | number |
Returns
mat4
fromRotation()
staticfromRotation(rotation):mat4
Creates a mat4 rotation matrix from a quaternion.
Parameters
| Parameter | Type |
|---|---|
rotation | quat |
Returns
mat4
fromRows()
staticfromRows(row0,row1,row2,row3):mat4
Creates a mat4 from four row vectors.
Parameters
Returns
mat4
fromScale()
staticfromScale(scale):mat4
Creates a mat4 scale matrix from a vec3.
Parameters
| Parameter | Type |
|---|---|
scale | vec3 |
Returns
mat4
fromTranslation()
staticfromTranslation(translation):mat4
Creates a mat4 translation matrix from a vec3.
Parameters
| Parameter | Type |
|---|---|
translation | vec3 |
Returns
mat4
identity()
staticidentity():mat4
Returns a mat4 identity matrix.
Returns
mat4
inverse()
inverse():
mat4
Returns the inverse of this matrix.
Returns
mat4
lookAt()
staticlookAt(eye,center,up):mat4
Creates a view matrix that orients toward a target from an eye position.
Parameters
Returns
mat4
makeBasis()
staticmakeBasis(x,y,z):mat4
Constructs a mat4 from three basis vectors.
Parameters
Returns
mat4
mult()
mult(
mat):mat4
Multiplies this matrix by another mat4 and returns the result.
Parameters
| Parameter | Type |
|---|---|
mat | mat4 |
Returns
mat4
multiplyDirection()
multiplyDirection(
direction):vec3
Transforms a direction vector by this matrix, ignoring translation.
Parameters
| Parameter | Type |
|---|---|
direction | vec3 |
Returns
multiplyPoint()
multiplyPoint(
point):vec3
Transforms a point by this matrix, applying translation.
Parameters
| Parameter | Type |
|---|---|
point | vec3 |
Returns
multiplyScalar()
multiplyScalar(
scalar):mat4
Multiplies this matrix by a scalar value and returns the result.
Parameters
| Parameter | Type |
|---|---|
scalar | number |
Returns
mat4
multiplyVector()
multiplyVector(
vector):vec4
Multiplies this matrix by a vec4 and returns the result.
Parameters
| Parameter | Type |
|---|---|
vector | vec4 |
Returns
orthographic()
staticorthographic(left,right,bottom,top,near,far):mat4
Creates an orthographic projection matrix.
Parameters
| Parameter | Type |
|---|---|
left | number |
right | number |
bottom | number |
top | number |
near | number |
far | number |
Returns
mat4
outerProduct()
staticouterProduct(a,b):mat4
Computes the outer product of two vec4 vectors and returns the resulting mat4.
Parameters
Returns
mat4
perspective()
staticperspective(fov,aspect,near,far):mat4
Creates a perspective projection matrix.
Parameters
| Parameter | Type |
|---|---|
fov | number |
aspect | number |
near | number |
far | number |
Returns
mat4
sub()
sub(
mat):mat4
Subtracts another mat4 from this matrix and returns the result.
Parameters
| Parameter | Type |
|---|---|
mat | mat4 |
Returns
mat4
toString()
toString():
string
Returns a string representation of this matrix.
Returns
string
transpose()
transpose():
mat4
Returns the transpose of this matrix.
Returns
mat4
zero()
staticzero():mat4
Returns a mat4 with all elements set to zero.
Returns
mat4