Class Matrix4

constructor

• new Matrix4(): Matrix4

  Creates a new identity mat4

  Returns Matrix4

className

elements

isMatrix4

add

• add(a: Matrix4, b?: Matrix4): this

  Adds two mat4's

  Parameters

  • a: Matrix4
  • Optionalb: Matrix4

    如果不传，计算 this 和 a 的和

  Returns this

  this

adjoint

• adjoint(m?: Matrix4): this

  Calculates the adjugate of a mat4

  Parameters

  • m: Matrix4 = ...

  Returns this

  this

clone

• clone(): Matrix4

  Creates a new mat4 initialized with values from this matrix

  Returns Matrix4

  a new Matrix4

compose

• compose(q: Quaternion, v: Vector3, s: Vector3, p?: Vector3): this

  compose

  Parameters

  • q: Quaternion

    quaternion

  • v: Vector3

    position

  • s: Vector3

    scale

  • Optionalp: Vector3

    pivot

  Returns this

  this

copy

• copy(m: Matrix4): this

  Copy the values from one mat4 to this

  Parameters

  • m: Matrix4

    the source matrix

  Returns this

  this

decompose

• decompose(q: Quaternion, v: Vector3, s: Vector3, p?: Vector3): this

  decompose

  Parameters

  • q: Quaternion

    quaternion

  • v: Vector3

    position

  • s: Vector3

    scale

  • Optionalp: Vector3

    [pivot]

  Returns this

  this

determinant

• determinant(): number

  Calculates the determinant of this

  Returns number

  this

equals

• equals(a: Matrix4, b?: Matrix4): boolean

  Returns whether or not the matrices have approximately the same elements in the same position.

  Parameters

  • a: Matrix4
  • Optionalb: Matrix4

    如果不传，比较 this 和 a 是否近似相等

  Returns boolean

exactEquals

• exactEquals(a: Matrix4, b?: Matrix4): boolean

  Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)

  Parameters

  • a: Matrix4
  • Optionalb: Matrix4

    如果不传，比较 this 和 a 是否相等

  Returns boolean

frob

• frob(): number

  Returns Frobenius norm of a mat4

  Returns number

  Frobenius norm

fromArray

• fromArray(array: ArrayLike<number>, offset?: number): this

  从数组赋值

  Parameters

  • array: ArrayLike<number>

    数组

  • offset: number = 0

    数组偏移值

  Returns this

  this

fromQuat

• fromQuat(q: Quaternion): this

  Calculates a 4x4 matrix from the given quaternion

  Parameters

  • q: Quaternion

    Quaternion to create matrix from

  Returns this

  this

fromRotation

• fromRotation(rad: number, axis: Vector3): this

  Creates a matrix from a given angle around a given axis

  Parameters

  • rad: number

    the angle to rotate the matrix by

  • axis: Vector3

    the axis to rotate around

  Returns this

  this

fromRotationTranslation

• fromRotationTranslation(q: Quaternion, v: Vector3): this

  Creates a matrix from a quaternion rotation and vector translation

  Parameters

  • q: Quaternion

    Rotation quaternion

  • v: Vector3

    Translation vector

  Returns this

  this

fromRotationTranslationScale

• fromRotationTranslationScale(q: Quaternion, v: Vector3, s: Vector3): this

  Creates a matrix from a quaternion rotation, vector translation and vector scale

  Parameters

  • q: Quaternion

    Rotation quaternion

  • v: Vector3

    Translation vector

  • s: Vector3

    Scaling vector

  Returns this

  this

fromRotationTranslationScaleOrigin

• fromRotationTranslationScaleOrigin(
      q: Quaternion,
      v: Vector3,
      s: Vector3,
      o: Vector3,
  ): this

  Creates a matrix from a quaternion rotation, vector translation and vector scale, rotating and scaling around the given origin

  Parameters

  • q: Quaternion

    Rotation quaternion

  • v: Vector3

    Translation vector

  • s: Vector3

    Scaling vector

  • o: Vector3

    The origin vector around which to scale and rotate

  Returns this

  this

fromScaling

• fromScaling(v: Vector3): this

  Creates a matrix from a vector scaling

  Parameters

  • v: Vector3

    Scaling vector

  Returns this

  this

fromTranslation

• fromTranslation(v: Vector3): this

  Creates a matrix from a vector translation

  Parameters

  • v: Vector3

    Translation vector

  Returns this

  this

fromXRotation

• fromXRotation(rad: number): this

  Creates a matrix from the given angle around the X axis

  Parameters

  • rad: number

    the angle to rotate the matrix by

  Returns this

  this

fromYRotation

• fromYRotation(rad: number): this

  Creates a matrix from the given angle around the Y axis

  Parameters

  • rad: number

    the angle to rotate the matrix by

  Returns this

  this

fromZRotation

• fromZRotation(rad: number): this

  Creates a matrix from the given angle around the Z axis

  Parameters

  • rad: number

    the angle to rotate the matrix by

  Returns this

  this

frustum

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

  Generates a frustum matrix with the given bounds

  Parameters

  • left: number

    Left bound of the frustum

  • right: number

    Right bound of the frustum

  • bottom: number

    Bottom bound of the frustum

  • top: number

    Top bound of the frustum

  • near: number

    Near bound of the frustum

  • far: number

    Far bound of the frustum

  Returns this

  this

getRotation

• getRotation(out?: Quaternion): Quaternion

  Returns a quaternion representing the rotational component of a transformation matrix. If a matrix is built with fromRotationTranslation, the returned quaternion will be the same as the quaternion originally supplied.

  Parameters

  • out: Quaternion = ...

    Quaternion to receive the rotation component

  Returns Quaternion

  out

getScaling

• getScaling(out?: Vector3): Vector3

  Returns the scaling factor component of a transformation matrix. If a matrix is built with fromRotationTranslationScale with a normalized Quaternion paramter, the returned vector will be the same as the scaling vector originally supplied.

  Parameters

  • out: Vector3 = ...

    Vector to receive scaling factor component

  Returns Vector3

  out

getTranslation

• getTranslation(out?: Vector3): Vector3

  Returns the translation vector component of a transformation matrix. If a matrix is built with fromRotationTranslation, the returned vector will be the same as the translation vector originally supplied.

  Parameters

  • out: Vector3 = ...

    Vector to receive translation component

  Returns Vector3

  out

identity

• identity(): this

  Set this to the identity matrix

  Returns this

  this

invert

• invert(m?: Matrix4): this

  invert a matrix

  Parameters

  • m: Matrix4 = ...

  Returns this

  this

lookAt

• lookAt(eye: XYZObject, center: XYZObject, up: Vector3): this

  Generates a look-at matrix with the given eye position, focal point, and up axis

  Parameters

  • eye: XYZObject

    Position of the viewer

  • center: XYZObject

    Point the viewer is looking at

  • up: Vector3

    pointing up

  Returns this

  this

mul

• mul(a: Matrix4, b?: Matrix4): this

  Parameters

  • a: Matrix4
  • Optionalb: Matrix4

  Returns this

multiply

• multiply(a: Matrix4, b?: Matrix4): this

  Multiplies two matrix4's

  Parameters

  • a: Matrix4
  • Optionalb: Matrix4

    如果不传，计算 this 和 a 的乘积

  Returns this

  this

ortho

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

  Generates a orthogonal projection matrix with the given bounds

  Parameters

  • left: number

    Left bound of the frustum

  • right: number

    Right bound of the frustum

  • bottom: number

    Bottom bound of the frustum

  • top: number

    Top bound of the frustum

  • near: number

    Near bound of the frustum

  • far: number

    Far bound of the frustum

  Returns this

  this

perspective

• perspective(fovy: number, aspect: number, near: number, far: number): this

  Generates a perspective projection matrix with the given bounds

  Parameters

  • fovy: number

    Vertical field of view in radians

  • aspect: number

    Aspect ratio. typically viewport width/height

  • near: number

    Near bound of the frustum

  • far: number

    Far bound of the frustum

  Returns this

  this

perspectiveFromFieldOfView

• perspectiveFromFieldOfView(fov: unknown, near: number, far: number): this

  Generates a perspective projection matrix with the given field of view.

  Parameters

  • fov: unknown

    Object containing the following values: upDegrees, downDegrees, leftDegrees, rightDegrees

  • near: number

    Near bound of the frustum

  • far: number

    Far bound of the frustum

  Returns this

  this

premultiply

• premultiply(m: Matrix4): this

  左乘

  Parameters

  • m: Matrix4

  Returns this

  this

rotate

• rotate(rad: number, axis: Vector3): this

  Rotates this by the given angle

  Parameters

  • rad: number

    the angle to rotate the matrix by

  • axis: Vector3

    the axis to rotate around

  Returns this

  this

rotateX

• rotateX(rad: number): this

  Rotates this by the given angle around the X axis

  Parameters

  • rad: number

    the angle to rotate the matrix by

  Returns this

  this

rotateY

• rotateY(rad: number): this

  Rotates this by the given angle around the Y axis

  Parameters

  • rad: number

    the angle to rotate the matrix by

  Returns this

  this

rotateZ

• rotateZ(rad: number): this

  Rotates this by the given angle around the Z axis

  Parameters

  • rad: number

    the angle to rotate the matrix by

  Returns this

  this

scale

• scale(v: Vector3): this

  Scales the mat3 by the dimensions in the given vec2

  Parameters

  • v: Vector3

    the vec3 to scale the matrix by

  Returns this

  this

set

• set(
      m00: number,
      m01: number,
      m02: number,
      m03: number,
      m10: number,
      m11: number,
      m12: number,
      m13: number,
      m20: number,
      m21: number,
      m22: number,
      m23: number,
      m30: number,
      m31: number,
      m32: number,
      m33: number,
  ): this

  Set the components of a mat3 to the given values

  Parameters

  • m00: number
  • m01: number
  • m02: number
  • m03: number
  • m10: number
  • m11: number
  • m12: number
  • m13: number
  • m20: number
  • m21: number
  • m22: number
  • m23: number
  • m30: number
  • m31: number
  • m32: number
  • m33: number

  Returns this

  this

sub

• sub(a: Matrix4, b?: Matrix4): this

  Parameters

  • a: Matrix4
  • Optionalb: Matrix4

  Returns this

subtract

• subtract(a: Matrix4, b?: Matrix4): this

  Subtracts matrix b from matrix a

  Parameters

  • a: Matrix4
  • Optionalb: Matrix4

    如果不传，计算 this 和 a 的差

  Returns this

  this

targetTo

• targetTo(eye: XYZObject, target: XYZObject, up: Vector3): this

  Generates a matrix that makes something look at something else.

  Parameters

  • eye: XYZObject

    Position of the viewer

  • target: XYZObject

    Point the viewer is looking at

  • up: Vector3

    pointing up

  Returns this

  this

toArray

• toArray(array?: MutableNumberArray, offset?: number): MutableNumberArray

  转换到数组

  Parameters

  • array: MutableNumberArray = []

    数组

  • offset: number = 0

    数组偏移值

  Returns MutableNumberArray

translate

• translate(v: Vector3): this

  Translate this by the given vector

  Parameters

  • v: Vector3

    vector to translate by

  Returns this

  this

transpose

• transpose(): this

  Transpose the values of this

  Returns this

  this