Class: TransformUV

Constructor

new TransformUV()

Create a new TransformUV object.

Extends

Matrix3

Members

(readonly) isTransformUV :boolean

Type:

boolean

Default Value: true

Methods

clone() → {TransformUV}

Clone this TransformUV object.

Overrides: Matrix3#clone

Returns:

The cloned object.

Type:: TransformUV

copy(source) → {TransformUV}

Copy the properties of another TransformUV object.

Parameters:

Name	Type	Description
`source`	TransformUV \| Matrix3	The object to copy the properties from.

Overrides: Matrix3#copy

Returns:

This object.

Type:: TransformUV

equals(matrix) → {boolean}

Return true if this matrix and m are equal.

Parameters:

Name	Type	Description
`matrix`	Matrix3

Overrides: Matrix3#equals

Returns:

Type:: boolean

extractBasis(xAxis, yAxis, zAxis) → {Matrix3}

Extracts the basis vectors from the matrix.

Parameters:

Name	Type	Description
`xAxis`	Vector3
`yAxis`	Vector3
`zAxis`	Vector3

Overrides: Matrix3#extractBasis

Returns:

Type:: Matrix3

fromArray(array, offsetopt) → {Matrix3}

Sets the elements of this matrix based on an array in column-major format.

Parameters:

Name	Type	Attributes	Default	Description
`array`	Array.<number>
`offset`	number	<optional>	0

Overrides: Matrix3#fromArray

Returns:

Type:: Matrix3

getInverse(matrix) → {Matrix3}

Take the inverse of the matrix

Parameters:

Name	Type	Description
`matrix`	Matrix3	The matrix to take the inverse of.

Overrides: Matrix3#getInverse

Returns:

Type:: Matrix3

identity() → {Matrix3}

Resets this matrix to the 3x3 identity matrix

Overrides: Matrix3#identity

Returns:

Type:: Matrix3

inverse() → {Matrix3}

Take the inverse of this matrix

Overrides: Matrix3#inverse

Returns:

Type:: Matrix3

isIdentity() → {boolean}

Checks if the matrix is an identity matrix.

Overrides: Matrix3#isIdentity

Returns:

True if the matrix is an identity matrix, false otherwise.

Type:: boolean

multiply(m) → {Matrix3}

Post-multiplies this matrix by m.

Parameters:

Name	Type	Description
`m`	Matrix3

Overrides: Matrix3#multiply

Returns:

Type:: Matrix3

multiplyMatrices(a, b) → {Matrix3}

Sets this matrix to a x b.

Parameters:

Name	Type	Description
`a`	Matrix3
`b`	Matrix3

Overrides: Matrix3#multiplyMatrices

Returns:

Type:: Matrix3

premultiply(m) → {Matrix3}

Pre-multiplies this matrix by m.

Parameters:

Name	Type	Description
`m`	Matrix3

Overrides: Matrix3#premultiply

Returns:

Type:: Matrix3

set(n11, n12, n13, n21, n22, n23, n31, n32, n33) → {Matrix3}

Sets the 3x3 matrix values to the given row-major sequence of values.

Parameters:

Name	Type	Description
`n11`	number	value to put in row 1, col 1.
`n12`	number	value to put in row 1, col 2.
`n13`	number	value to put in row 1, col 3.
`n21`	number	value to put in row 2, col 1.
`n22`	number	value to put in row 2, col 2.
`n23`	number	value to put in row 2, col 3.
`n31`	number	value to put in row 3, col 1.
`n32`	number	value to put in row 3, col 2.
`n33`	number	value to put in row 3, col 3.

Overrides: Matrix3#set

Returns:

Type:: Matrix3

setFromMatrix4(m) → {Matrix3}

Sets the matri3 planes from the matrix4.

Parameters:

Name	Type	Description
`m`	Matrix4

Overrides: Matrix3#setFromMatrix4

Returns:

Type:: Matrix3

setUvTransform(tx, ty, sx, sy, rotation, cx, cy) → {Matrix3}

Set the transformation matrix of uv coordinates

Parameters:

Name	Type	Description
`tx`	number
`ty`	number
`sx`	number
`sy`	number
`rotation`	number
`cx`	number
`cy`	number

Overrides: Matrix3#setUvTransform

Returns:

Type:: Matrix3

toArray(arrayopt, offsetopt) → {Array.<number>}

Writes the elements of this matrix to an array in column-major format.

Parameters:

Name	Type	Attributes	Default	Description
`array`	Array.<number>	<optional>
`offset`	number	<optional>	0

Overrides: Matrix3#toArray

Returns:

Type:: Array.<number>

transform(x, y, scaleX, scaleY, rotation, anchorX, anchorY) → {Matrix3}

Transform 2D

Parameters:

Name	Type	Description
`x`	number	position.x
`y`	number	position.y
`scaleX`	number	scale.x
`scaleY`	number	scale.y
`rotation`	number	rotation
`anchorX`	number	anchor.x
`anchorY`	number	anchor.y

Overrides: Matrix3#transform

Returns:

Type:: Matrix3

transpose() → {Matrix3}

Transposes this matrix in place.

Overrides: Matrix3#transpose

Returns:

Type:: Matrix3

update() → {TransformUV}

Update the matrix for UV transformation based on the offset, scale, rotation and center. If needsUpdate is false, this method will do nothing.

Returns:

This object.

Type:: TransformUV

updateMatrix() → {TransformUV}

Update the matrix for UV transformation based on the offset, scale, rotation and center. This method will always update the matrix regardless of the needsUpdate flag.

Returns:

This object.

Type:: TransformUV