Class Matrix3

Serializable THREE.js Matrix3

Hierarchy-Diagram

UML class diagram of Matrix3
Legend
icon for a class in the UML class diagram class

Hierarchy

  • Matrix3
    • Matrix3

Constructors

constructor

Properties

elements

Methods

clone copy determinant equals extractBasis flattenToArrayOffset fromArray getInverse getNormalMatrix identity invert makeRotation makeScale makeTranslation multiply multiplyMatrices multiplyScalar multiplyVector3 multiplyVector3Array premultiply rotate scale set setFromMatrix4 setUvTransform toArray translate transpose transposeIntoArray fromArray

Constructors

constructor

  • new Matrix3(): Matrix3

  • Creates an identity matrix.

    Returns Matrix3

  • new Matrix3(n11, n12, n13, n21, n22, n23, n31, n32, n33): Matrix3

  • Creates a 3x3 matrix with the given arguments in row-major order.

    Parameters

    • n11: number
    • n12: number
    • n13: number
    • n21: number
    • n22: number
    • n23: number
    • n31: number
    • n32: number
    • n33: number

    Returns Matrix3

Properties

elements

elements: number[]

Methods

clone

copy

  • copy(m): this

  • Parameters

    • m: Matrix3

    Returns this

determinant

  • determinant(): number

  • Returns number

equals

  • equals(matrix): boolean

  • Parameters

    • matrix: Matrix3

    Returns boolean

extractBasis

  • extractBasis(xAxis, yAxis, zAxis): Matrix3

  • Parameters

    • xAxis: Vector3
    • yAxis: Vector3
    • zAxis: Vector3

    Returns Matrix3

flattenToArrayOffset

  • flattenToArrayOffset(array, offset): number[]

  • Parameters

    • array: number[]
    • offset: number

    Returns number[]

    Deprecated

    Use .toArray() instead.

fromArray

  • fromArray(array, offset?): Matrix3

  • Sets the values of this matrix from the provided array or array-like.

    Parameters

    • array: number[] | ArrayLike<number>

      the source array or array-like.

    • Optional offset: number

      (optional) offset into the array-like. Default is 0.

    Returns Matrix3

getInverse

  • getInverse(matrix, throwOnDegenerate?): Matrix3

  • Parameters

    • matrix: Matrix4
    • Optional throwOnDegenerate: boolean

    Returns Matrix3

    Deprecated

    Use .invert() instead.

  • getInverse(matrix): Matrix

  • Parameters

    • matrix: Matrix

    Returns Matrix

getNormalMatrix

  • getNormalMatrix(matrix4): Matrix3

  • Parameters

    • matrix4: Matrix4

    Returns Matrix3

identity

  • identity(): Matrix3

  • Returns Matrix3

invert

  • invert(): Matrix3

  • Inverts this matrix in place.

    Returns Matrix3

makeRotation

  • makeRotation(theta): this

  • Sets this matrix as a 2D rotational transformation by theta radians. The resulting matrix will be:

    cos(θ) -sin(θ) 0
    sin(θ) cos(θ)  0
    0      0       1

    Parameters

    • theta: number

      Rotation angle in radians. Positive values rotate counterclockwise.

    Returns this

  • makeRotation(theta): Matrix3

  • Parameters

    • theta: number

    Returns Matrix3

makeScale

  • makeScale(x, y): this

  • Sets this matrix as a 2D scale transform:

    x, 0, 0,
    0, y, 0,
    0, 0, 1

    Parameters

    • x: number

      the amount to scale in the X axis.

    • y: number

      the amount to scale in the Y axis.

    Returns this

  • makeScale(x, y): Matrix3

  • Parameters

    • x: number
    • y: number

    Returns Matrix3

makeTranslation

  • makeTranslation(v): this

  • Sets this matrix as a 2D translation transform:

    1, 0, x,
    0, 1, y,
    0, 0, 1

    Parameters

    • v: Vector2

    Returns this

  • makeTranslation(x, y): this

  • Parameters

    • x: number
    • y: number

    Returns this

multiply

  • multiply(m): Matrix3

  • Multiplies this matrix by m.

    Parameters

    • m: Matrix3

    Returns Matrix3

multiplyMatrices

  • multiplyMatrices(a, b): Matrix3

  • Sets this matrix to a x b.

    Parameters

    • a: Matrix3
    • b: Matrix3

    Returns Matrix3

multiplyScalar

  • multiplyScalar(s): Matrix3

  • Parameters

    • s: number

    Returns Matrix3

multiplyVector3

  • multiplyVector3(vector): any

  • Parameters

    • vector: Vector3

    Returns any

    Deprecated

    Use vector.applyMatrix3( matrix ) instead.

multiplyVector3Array

  • multiplyVector3Array(a): any

  • Parameters

    • a: any

    Returns any

    Deprecated

    This method has been removed completely.

premultiply

  • premultiply(m): Matrix3

  • Parameters

    • m: Matrix3

    Returns Matrix3

rotate

  • rotate(theta): Matrix3

  • Parameters

    • theta: number

    Returns Matrix3

scale

  • scale(sx, sy): Matrix3

  • Parameters

    • sx: number
    • sy: number

    Returns Matrix3

set

  • set(n11, n12, n13, n21, n22, n23, n31, n32, n33): Matrix3

  • Parameters

    • n11: number
    • n12: number
    • n13: number
    • n21: number
    • n22: number
    • n23: number
    • n31: number
    • n32: number
    • n33: number

    Returns Matrix3

setFromMatrix4

  • setFromMatrix4(m): Matrix3

  • Parameters

    • m: Matrix4

    Returns Matrix3

setUvTransform

  • setUvTransform(tx, ty, sx, sy, rotation, cx, cy): Matrix3

  • Parameters

    • tx: number
    • ty: number
    • sx: number
    • sy: number
    • rotation: number
    • cx: number
    • cy: number

    Returns Matrix3

toArray

  • toArray(array?, offset?): number[]

  • Returns an array with the values of this matrix, or copies them into the provided array.

    Parameters

    • Optional array: number[]

      (optional) array to store the matrix to. If this is not provided, a new array will be created.

    • Optional offset: number

      (optional) optional offset into the array.

    Returns number[]

    The created or provided array.

  • toArray(array?, offset?): Matrix3Tuple

  • Parameters

    • Optional array: Matrix3Tuple
    • Optional offset: 0

    Returns Matrix3Tuple

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

  • Copies he values of this matrix into the provided array-like.

    Parameters

    • Optional array: ArrayLike<number>

      array-like to store the matrix to.

    • Optional offset: number

      (optional) optional offset into the array-like.

    Returns ArrayLike<number>

    The provided array-like.

translate

  • translate(tx, ty): Matrix3

  • Parameters

    • tx: number
    • ty: number

    Returns Matrix3

transpose

  • transpose(): Matrix3

  • Transposes this matrix in place.

    Returns Matrix3

transposeIntoArray

  • transposeIntoArray(r): Matrix3

  • Transposes this matrix into the supplied array r, and returns itself.

    Parameters

    • r: number[]

    Returns Matrix3

Static fromArray

Settings

Member Visibility

Theme

On This Page

constructorelementsclonecopydeterminantequalsextractBasisflattenToArrayOffsetfromArraygetInversegetNormalMatrixidentityinvertmakeRotationmakeScalemakeTranslationmultiplymultiplyMatricesmultiplyScalarmultiplyVector3multiplyVector3ArraypremultiplyrotatescalesetsetFromMatrix4setUvTransformtoArraytranslatetransposetransposeIntoArrayfromArray