[name]

A class representing a 3x3 [link:https://en.wikipedia.org/wiki/Matrix_(mathematics) matrix].

Code Example


const m = new Matrix3();

A Note on Row-Major and Column-Major Ordering

The constructor and [page:set]() method take arguments in [link:https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order row-major] order, while internally they are stored in the [page:.elements elements] array in column-major order.

This means that calling m.set( 11, 12, 13, 21, 22, 23, 31, 32, 33 ); will result in the [page:.elements elements] array containing: m.elements = [ 11, 21, 31, 12, 22, 32, 13, 23, 33 ]; and internally all calculations are performed using column-major ordering. However, as the actual ordering makes no difference mathematically and most people are used to thinking about matrices in row-major order, the three.js documentation shows matrices in row-major order. Just bear in mind that if you are reading the source code, you'll have to take the [link:https://en.wikipedia.org/wiki/Transpose transpose] of any matrices outlined here to make sense of the calculations.

Constructor

[name]( [param:Number n11], [param:Number n12], [param:Number n13], [param:Number n21], [param:Number n22], [param:Number n23], [param:Number n31], [param:Number n32], [param:Number n33] )

Creates a 3x3 matrix with the given arguments in row-major order. If no arguments are provided, the constructor initializes the [name] to the 3x3 [link:https://en.wikipedia.org/wiki/Identity_matrix identity matrix].

Properties

[property:Array elements]

A [link:https://en.wikipedia.org/wiki/Row-_and_column-major_order column-major] list of matrix values.

Methods

[method:Matrix3 clone]()

Creates a new Matrix3 and with identical elements to this one.

[method:this copy]( [param:Matrix3 m] )

Copies the elements of matrix [page:Matrix3 m] into this matrix.

[method:Float determinant]()

Computes and returns the [link:https://en.wikipedia.org/wiki/Determinant determinant] of this matrix.

[method:Boolean equals]( [param:Matrix3 m] )

Return true if this matrix and [page:Matrix3 m] are equal.

[method:this extractBasis]( [param:Vector3 xAxis], [param:Vector3 yAxis], [param:Vector3 zAxis] )

Extracts the [link:https://en.wikipedia.org/wiki/Basis_(linear_algebra) basis] of this matrix into the three axis vectors provided. If this matrix is:

[\begin{matrix} a & b & c \\ d & e & f \\ g & h & i \end{matrix}]

then the [page:Vector3 xAxis], [page:Vector3 yAxis], [page:Vector3 zAxis] will be set to:

$xAxis = [\begin{matrix} a \\ d \\ g \end{matrix}]$ , $yAxis = [\begin{matrix} b \\ e \\ h \end{matrix}]$ , and $zAxis = [\begin{matrix} c \\ f \\ i \end{matrix}]$

[method:this fromArray]( [param:Array array], [param:Integer offset] )

[page:Array array] - the array to read the elements from.
[page:Integer offset] - (optional) index of first element in the array. Default is `0`.

Sets the elements of this matrix based on an array in [link:https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order column-major] format.

[method:this invert]()

Inverts this matrix, using the [link:https://en.wikipedia.org/wiki/Invertible_matrix#Analytic_solution analytic method]. You can not invert with a determinant of zero. If you attempt this, the method produces a zero matrix instead.

[method:this getNormalMatrix]( [param:Matrix4 m] )

[page:Matrix4 m] - [page:Matrix4]

Sets this matrix as the upper left 3x3 of the [link:https://en.wikipedia.org/wiki/Normal_matrix normal matrix] of the passed [page:Matrix4 matrix4]. The normal matrix is the [link:https://en.wikipedia.org/wiki/Invertible_matrix inverse] [link:https://en.wikipedia.org/wiki/Transpose transpose] of the matrix [page:Matrix4 m].

[method:this identity]()

Resets this matrix to the 3x3 identity matrix:

[\begin{matrix} 1 & 0 & 0 \\ 0 & 1 & 0 \\ 0 & 0 & 1 \end{matrix}]

[method:this makeRotation]( [param:Float theta] )

[page:Float theta] — Rotation angle in radians. Positive values rotate counterclockwise.

Sets this matrix as a 2D rotational transformation by [page:Float theta] radians. The resulting matrix will be:

[\begin{matrix} \cos θ & -sin θ & 0 \\ \sin θ & \cos θ & 0 \\ 0 & 0 & 1 \end{matrix}]

[method:this makeScale]( [param:Float x], [param:Float y] )

[page:Float x] - the amount to scale in the X axis.
[page:Float y] - the amount to scale in the Y axis.
Sets this matrix as a 2D scale transform:

[\begin{matrix} x & 0 & 0 \\ 0 & y & 0 \\ 0 & 0 & 1 \end{matrix}]

[method:this makeTranslation]( [param:Vector2 v] )

[method:this makeTranslation]( [param:Float x], [param:Float y] )

[page:Vector2 v] a translation transform from vector.
or
[page:Float x] - the amount to translate in the X axis.
[page:Float y] - the amount to translate in the Y axis.
Sets this matrix as a 2D translation transform:

[\begin{matrix} 1 & 0 & x \\ 0 & 1 & y \\ 0 & 0 & 1 \end{matrix}]

[method:this multiply]( [param:Matrix3 m] )

Post-multiplies this matrix by [page:Matrix3 m].

[method:this multiplyMatrices]( [param:Matrix3 a], [param:Matrix3 b] )

Sets this matrix to [page:Matrix3 a] x [page:Matrix3 b].

[method:this multiplyScalar]( [param:Float s] )

Multiplies every component of the matrix by the scalar value *s*.

[method:this rotate]( [param:Float theta] )

Rotates this matrix by the given angle (in radians).

[method:this scale]( [param:Float sx], [param:Float sy] )

Scales this matrix with the given scalar values.

[method:this set]( [param:Float n11], [param:Float n12], [param:Float n13], [param:Float n21], [param:Float n22], [param:Float n23], [param:Float n31], [param:Float n32], [param:Float n33] )

Sets the 3x3 matrix values to the given [link:https://en.wikipedia.org/wiki/Row-_and_column-major_order row-major] sequence of values:

[\begin{matrix} n11 & n12 & n13 \\ n21 & n22 & n23 \\ n31 & n32 & n33 \end{matrix}]

[method:this premultiply]( [param:Matrix3 m] )

Pre-multiplies this matrix by [page:Matrix3 m].

[method:this setFromMatrix4]( [param:Matrix4 m] )

Set this matrix to the upper 3x3 matrix of the Matrix4 [page:Matrix4 m].

[method:this setUvTransform]( [param:Float tx], [param:Float ty], [param:Float sx], [param:Float sy], [param:Float rotation], [param:Float cx], [param:Float cy] )

[page:Float tx] - offset x
[page:Float ty] - offset y
[page:Float sx] - repeat x
[page:Float sy] - repeat y
[page:Float rotation] - rotation, in radians. Positive values rotate counterclockwise
[page:Float cx] - center x of rotation
[page:Float cy] - center y of rotation

Sets the UV transform matrix from offset, repeat, rotation, and center.

[method:Array toArray]( [param:Array array], [param:Integer offset] )

[page:Array array] - (optional) array to store the resulting vector in. If not given a new array will be created.
[page:Integer offset] - (optional) offset in the array at which to put the result.

Writes the elements of this matrix to an array in [link:https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order column-major] format.

[method:this translate]( [param:Float tx], [param:Float ty] )

Translates this matrix by the given scalar values.

[method:this transpose]()

[link:https://en.wikipedia.org/wiki/Transpose Transposes] this matrix in place.

[method:this transposeIntoArray]( [param:Array array] )

[page:Array array] - array to store the resulting vector in.

[link:https://en.wikipedia.org/wiki/Transpose Transposes] this matrix into the supplied array, and returns itself unchanged.

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]