Skip to content

class Mat4 (shared-side)

Available since version: 0.3.0

This class represents a 4x4 matrix.

Constructor

Mat4.new()

Parameters:

No parameters.

Constructor

Mat4.new(number value)

Parameters:

  • number value: Scalar initialization value.

Constructor

Mat4.new(Vec4 v0, Vec4 v1, Vec4 v2, Vec4 v3)

Parameters:

  • Vec4 v0: First row vector.
  • Vec4 v1: Second row vector.
  • Vec4 v2: Third row vector.
  • Vec4 v3: Fourth row vector.

Properties

No properties.

Methods

makeIdentity

This method resets the matrix to identity.

void makeIdentity()

makeZero

This method sets all matrix elements to zero.

void makeZero()

makeOrthonormal

This method orthonormalizes the upper-left 3x3 basis vectors while preserving translation.

void makeOrthonormal()

isUpper3x3Orthonormal

This method returns true if the upper 3x3 basis vectors are orthonormal.

boolean isUpper3x3Orthonormal()

Returns boolean:

True if orthonormal within epsilon tolerance.

transpose

This method returns the transposed matrix.

Mat4 transpose()

Returns Mat4:

Transposed matrix.

inverse

This method returns the inverse matrix.

Mat4 inverse()

Returns Mat4:

Inverse matrix.

inverseLinTrafo

This method returns the inverse of a linear transform with translation. This is intended for typical transform matrices (rotation/scale + translation).

Mat4 inverseLinTrafo()

Returns Mat4:

Inverse linear transform matrix.

rotate

This method rotates a vector by the matrix (ignores translation).

Vec3 rotate(Vec3 vec)

Parameters:

  • Vec3 vec: Vector to rotate.

Returns Vec3:

Rotated vector.

setRightVector

This method sets the right basis vector.

void setRightVector(Vec3 vec)

Parameters:

  • Vec3 vec: New right vector.

getRightVector

This method returns the right basis vector.

Vec3 getRightVector()

Returns Vec3:

Right vector.

setAtVector

This method sets the forward (at) basis vector.

void setAtVector(Vec3 vec)

Parameters:

  • Vec3 vec: New at vector.

getAtVector

This method returns the forward (at) basis vector.

Vec3 getAtVector()

Returns Vec3:

At vector.

setUpVector

This method sets the up basis vector.

void setUpVector(Vec3 vec)

Parameters:

  • Vec3 vec: New up vector.

getUpVector

This method returns the up basis vector.

Vec3 getUpVector()

Returns Vec3:

Up vector.

setTranslation

This method sets the translation component.

void setTranslation(Vec3 vec)

Parameters:

  • Vec3 vec: New translation vector.

getTranslation

This method returns the translation component.

Vec3 getTranslation()

Returns Vec3:

Translation vector.

resetRotation

This method resets rotation to identity while preserving translation.

void resetRotation()

extractRotation

This method extracts the rotation part of the matrix (scaling removed).

Mat3 extractRotation()

Returns Mat3:

Rotation matrix.

extractScaling

This method extracts scaling factors from the matrix basis vectors.

Vec3 extractScaling()

Returns Vec3:

Scaling factors for x, y and z axes.

postRotateX

This method post-multiplies a rotation around the X axis (degrees).

void postRotateX(number angle_degrees)

Parameters:

  • number angle_degrees: Rotation angle in degrees.

postRotateY

This method post-multiplies a rotation around the Y axis (degrees).

void postRotateY(number angle_degrees)

Parameters:

  • number angle_degrees: Rotation angle in degrees.

postRotateZ

This method post-multiplies a rotation around the Z axis (degrees).

void postRotateZ(number angle_degrees)

Parameters:

  • number angle_degrees: Rotation angle in degrees.

preScale

This method pre-multiplies a scaling transformation.

void preScale(Vec3 scale)

Parameters:

  • Vec3 scale: Scaling factors for x, y and z axes.

postScale

This method post-multiplies a scaling transformation.

void postScale(Vec3 scale)

Parameters:

  • Vec3 scale: Scaling factors for x, y and z axes.

static swap

This method swaps two matrices.

void swap(Mat4 mat1, Mat4 mat2)

Parameters:

  • Mat4 mat1: First matrix.
  • Mat4 mat2: Second matrix.

static lookAt

This method builds a look-at transform from a position, target and up vector.

Mat4 lookAt(Vec3 from, Vec3 to, Vec3 up)

Parameters:

  • Vec3 from: Camera/world position.
  • Vec3 to: Target position to look at.
  • Vec3 up: Up direction vector.

Returns Mat4:

Look-at matrix.

data

This method returns a pointer to the raw matrix data (column-major float array).

userdata data()

Returns userdata:

Pointer to matrix float data.

Callbacks

No callbacks.