Class Mat4

Constructors

constructor

Accessors

a11 a12 a13 a14 a21 a22 a23 a24 a31 a32 a33 a34 a41 a42 a43 a44 array determinant determinantFunction frobeniusnorm rotation scaling translation

Methods

[iterator] add addNew clone invert invertNew multiply multiplyNew multiplyScalar multiplyScalarNew reset resetToMat4 rotate rotateNew scale scaleByVec3 scaleByVec3New scaleNew subtract subtractNew toString transform transformNew transformTo transformToNew translate translateNew transpose transposeNew fromQuat fromRotation fromRotationTranslationScale fromRotationTranslationScaleOrigin fromScalingVec3 fromTranslatingVec3 fromXRotation fromYRotation fromZRotation frustum lookAt ortho perspective targetTo

Constructors

constructor

  • new Mat4(...args): Mat4

  • Parameters

    • Rest...args: number[]

    Returns Mat4

Accessors

a11

  • get a11(): number

  • Returns number

  • set a11(v): void

  • Parameters

    • v: number

    Returns void

a12

  • get a12(): number

  • Returns number

  • set a12(v): void

  • Parameters

    • v: number

    Returns void

a13

  • get a13(): number

  • Returns number

  • set a13(v): void

  • Parameters

    • v: number

    Returns void

a14

  • get a14(): number

  • Returns number

  • set a14(v): void

  • Parameters

    • v: number

    Returns void

a21

  • get a21(): number

  • Returns number

  • set a21(v): void

  • Parameters

    • v: number

    Returns void

a22

  • get a22(): number

  • Returns number

  • set a22(v): void

  • Parameters

    • v: number

    Returns void

a23

  • get a23(): number

  • Returns number

  • set a23(v): void

  • Parameters

    • v: number

    Returns void

a24

  • get a24(): number

  • Returns number

  • set a24(v): void

  • Parameters

    • v: number

    Returns void

a31

  • get a31(): number

  • Returns number

  • set a31(v): void

  • Parameters

    • v: number

    Returns void

a32

  • get a32(): number

  • Returns number

  • set a32(v): void

  • Parameters

    • v: number

    Returns void

a33

  • get a33(): number

  • Returns number

  • set a33(v): void

  • Parameters

    • v: number

    Returns void

a34

  • get a34(): number

  • Returns number

  • set a34(v): void

  • Parameters

    • v: number

    Returns void

a41

  • get a41(): number

  • Returns number

  • set a41(v): void

  • Parameters

    • v: number

    Returns void

a42

  • get a42(): number

  • Returns number

  • set a42(v): void

  • Parameters

    • v: number

    Returns void

a43

  • get a43(): number

  • Returns number

  • set a43(v): void

  • Parameters

    • v: number

    Returns void

a44

  • get a44(): number

  • Returns number

  • set a44(v): void

  • Parameters

    • v: number

    Returns void

array

  • get array(): number[]

  • (getter) Returns the basic array representation of this matrix.

    Returns number[]

determinant

  • get determinant(): number

  • Calculates the determinant of the mat4

    Returns number

    determinant of a

determinantFunction

  • get determinantFunction(): Mat4DeterminantFunction

  • Calculates the determinant function the mat4

    Returns Mat4DeterminantFunction

    determinant of a

frobeniusnorm

  • get frobeniusnorm(): number

  • Returns number

rotation

  • get rotation(): Quat

  • Returns Quat

scaling

  • get scaling(): Vec3

  • Returns Vec3

translation

  • get translation(): Vec3

  • Returns Vec3

Methods

[iterator]

  • [iterator](): {
        next(): {
            done: boolean;
            value: number;
        } | {
            done: boolean;
            value?: undefined;
        };
    }

  • Adds iteration to the object, allowing it to be destructured and iterated upon in various useful ways.

    Returns {
        next(): {
            done: boolean;
            value: number;
        } | {
            done: boolean;
            value?: undefined;
        };
    }

    • next:function
      • next(): {
            done: boolean;
            value: number;
        } | {
            done: boolean;
            value?: undefined;
        }

      • Returns {
            done: boolean;
            value: number;
        } | {
            done: boolean;
            value?: undefined;
        }

add

  • add(m): Mat4

  • Parameters

    Returns Mat4

addNew

  • addNew(m): Mat4

  • Parameters

    Returns Mat4

clone

  • clone(): Mat4

  • Returns Mat4

invert

  • invert(): Mat4

  • Returns Mat4

invertNew

  • invertNew(): Mat4

  • Returns Mat4

multiply

  • multiply(m): Mat4

  • Parameters

    Returns Mat4

multiplyNew

  • multiplyNew(m): Mat4

  • Parameters

    Returns Mat4

multiplyScalar

  • multiplyScalar(s): Mat4

  • Parameters

    • s: number

    Returns Mat4

multiplyScalarNew

  • multiplyScalarNew(s): Mat4

  • Parameters

    • s: number

    Returns Mat4

reset

  • reset(...args): Mat4

  • Parameters

    • Rest...args: number[]

    Returns Mat4

resetToMat4

  • resetToMat4(m): Mat4

  • Parameters

    Returns Mat4

rotate

  • rotate(r, axis): Mat4

  • Rotates a mat4 by the given angle around the given axis

    Parameters

    • r: number

      the angle to rotate the matrix by

    • axis: any

      the axis to rotate around

    Returns Mat4

    output

rotateNew

  • rotateNew(r, axis): Mat4

  • Parameters

    • r: number
    • axis: any

    Returns Mat4

scale

  • scale(s): Mat4

  • Parameters

    • s: number

    Returns Mat4

scaleByVec3

  • scaleByVec3(v): Mat4

  • Parameters

    • v: any

    Returns Mat4

scaleByVec3New

  • scaleByVec3New(v): Mat4

  • Parameters

    • v: any

    Returns Mat4

scaleNew

  • scaleNew(s): Mat4

  • Parameters

    • s: number

    Returns Mat4

subtract

  • subtract(m): Mat4

  • Parameters

    Returns Mat4

subtractNew

  • subtractNew(m): Mat4

  • Parameters

    Returns Mat4

toString

  • toString(): string

  • Returns string

transform

  • transform(v): Mat4

  • Transforms the mat4 by a given amount

    Parameters

    • v: any

      The amount to add to the matrixes transformation properties

    Returns Mat4

    output

transformNew

  • transformNew(v): Mat4

  • Parameters

    • v: any

    Returns Mat4

transformTo

  • transformTo(v): Mat4

  • Transforms the mat4 to a given position

    Parameters

    • v: any

      The amount to add to the matrixes transformation properties

    Returns Mat4

    output

transformToNew

  • transformToNew(v): Mat4

  • Parameters

    • v: any

    Returns Mat4

translate

  • translate(v): Mat4

  • Translates the mat4 to a given position

    Parameters

    • v: any

      The amount to add to the matrixes translation properties

    Returns Mat4

    output

translateNew

  • translateNew(v): Mat4

  • Parameters

    • v: any

    Returns Mat4

transpose

  • transpose(): Mat4

  • Returns Mat4

transposeNew

  • transposeNew(): Mat4

  • Returns Mat4

StaticfromQuat

  • fromQuat(q): Mat4

  • Calculates a 4x4 matrix from the given quaternion

    Parameters

    • q: any

      Quaternion to create matrix from

    Returns Mat4

    out

StaticfromRotation

  • fromRotation(r, axis): Mat4

  • Parameters

    • r: any
    • axis: any

    Returns Mat4

StaticfromRotationTranslationScale

  • fromRotationTranslationScale(q, v, s): Mat4

  • Creates a matrix from a quaternion rotation, vector translation and vector scale This is equivalent to (but much faster than):

    mat4.identity(dest);
mat4.translate(dest, vec);
let quatMat = mat4.create();
quat4.toMat4(quat, quatMat);
mat4.multiply(dest, quatMat);
mat4.scale(dest, scale)

    Parameters

    • q: any

      Rotation quaternion

    • v: any

      Translation vector

    • s: any

      Scaling vector

    Returns Mat4

    out

StaticfromRotationTranslationScaleOrigin

  • fromRotationTranslationScaleOrigin(q, v, s, o): Mat4

  • Creates a matrix from a quaternion rotation, vector translation and vector scale, rotating and scaling around the given origin This is equivalent to (but much faster than):

    mat4.identity(dest);
mat4.translate(dest, vec);
mat4.translate(dest, origin);
let quatMat = mat4.create();
quat4.toMat4(quat, quatMat);
mat4.multiply(dest, quatMat);
mat4.scale(dest, scale)
mat4.translate(dest, negativeOrigin);

    Parameters

    • q: any

      Rotation quaternion

    • v: any

      Translation vector

    • s: any

      Scaling vector

    • o: any

      The origin vector around which to scale and rotate

    Returns Mat4

    out

StaticfromScalingVec3

  • fromScalingVec3(v): Mat4

  • Parameters

    • v: any

    Returns Mat4

StaticfromTranslatingVec3

  • fromTranslatingVec3(v): Mat4

  • Parameters

    • v: any

    Returns Mat4

StaticfromXRotation

  • fromXRotation(r): Mat4

  • Parameters

    • r: any

    Returns Mat4

StaticfromYRotation

  • fromYRotation(r): Mat4

  • Parameters

    • r: any

    Returns Mat4

StaticfromZRotation

  • fromZRotation(r): Mat4

  • Parameters

    • r: any

    Returns Mat4

Staticfrustum

  • frustum(left, right, bottom, top, near, far): Mat4

  • Generates a frustum matrix with the given bounds

    Parameters

    • left: any

      Left bound of the frustum

    • right: any

      Right bound of the frustum

    • bottom: any

      Bottom bound of the frustum

    • top: any

      Top bound of the frustum

    • near: any

      Near bound of the frustum

    • far: any

      Far bound of the frustum

    Returns Mat4

    out

StaticlookAt

  • lookAt(eye, center, up): Mat4

  • Generates a look-at matrix with the given eye position, focal point, and up axis. If you want a matrix that actually makes an object look at another object, you should use targetTo instead.

    Parameters

    • eye: any

      Position of the viewer

    • center: any

      Point the viewer is looking at

    • up: any

      vec3 pointing up

    Returns Mat4

    out

Staticortho

  • ortho(left, right, bottom, top, near, far): Mat4

  • Generates a orthogonal projection matrix with the given bounds

    Parameters

    • left: any

      Left bound of the frustum

    • right: any

      Right bound of the frustum

    • bottom: any

      Bottom bound of the frustum

    • top: any

      Top bound of the frustum

    • near: any

      Near bound of the frustum

    • far: any

      Far bound of the frustum

    Returns Mat4

    out

Staticperspective

  • perspective(fovy, aspect, near, far): Mat4

  • Generates a perspective projection matrix with the given bounds. Passing null/undefined/no value for far will generate infinite projection matrix.

    Parameters

    • fovy: any

      Vertical field of view in radians

    • aspect: any

      Aspect ratio. typically viewport width/height

    • near: any

      Near bound of the frustum

    • far: any

      Far bound of the frustum, can be null or Infinity

    Returns Mat4

    out

StatictargetTo

  • targetTo(eye, target, up): Mat4

  • Generates a matrix that makes something look at something else.

    Parameters

    • eye: any

      Position of the viewer

    • target: any
    • up: any

      vec3 pointing up

    Returns Mat4

    out

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods