Class Matrix

Class used to store matrix data (4x4)

Hierarchy

Matrix

Index

Constructors

constructor

Properties

updateFlag

Accessors

Methods

Constructors

constructor

new Matrix(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56427
Creates an empty matrix (filled with zeros)

Returns Matrix

Properties

updateFlag Search playground for updateFlag

updateFlag: number

Gets the update flag of the matrix which is an unique number for the matrix. It will be incremented every time the matrix data change. You can use it to speed the comparison between two versions of the same matrix.

Accessors

m

get m(): DeepImmutableArray<number> | DeepImmutableObject<Float32Array>

- Defined in .temp/docdirectory/doc.d.ts:56418
Gets the internal data of the matrix

Returns DeepImmutableArray<number> | DeepImmutableObject<Float32Array>

Static IdentityReadOnly

get IdentityReadOnly(): DeepImmutableObject<Matrix>

- Defined in .temp/docdirectory/doc.d.ts:56720
Gets an identity matrix that must not be updated

Returns DeepImmutableObject<Matrix>

Static Use64Bits

get Use64Bits(): boolean

- Defined in .temp/docdirectory/doc.d.ts:56401
Gets the precision of matrix computations

Returns boolean

Methods

add Search playground for add

add(other: DeepImmutableObject<Matrix>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56468
Adds the current matrix with a second one

Parameters
- other: DeepImmutableObject<Matrix>
  
  defines the matrix to add
Returns Matrix
a new matrix as the addition of the current matrix and the given one

addAtIndex Search playground for addAtIndex

addAtIndex(index: number, value: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56494
add a value at the specified position in the current Matrix

Parameters
- index: number
  
  the index of the value within the matrix. between 0 and 15.
- value: number
  
  the value to be added
Returns Matrix
the current updated matrix

addToRef Search playground for addToRef

addToRef(other: DeepImmutableObject<Matrix>, result: Matrix): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56475
Sets the given matrix "result" to the addition of the current matrix and the given one

Parameters
- other: DeepImmutableObject<Matrix>
  
  defines the matrix to add
- result: Matrix
  
  defines the target matrix
Returns Matrix
the current matrix

addToSelf Search playground for addToSelf

addToSelf(other: DeepImmutableObject<Matrix>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56481
Adds in place the given matrix to the current matrix

Parameters
- other: DeepImmutableObject<Matrix>
  
  defines the second operand
Returns Matrix
the current updated matrix

addTranslationFromFloats Search playground for addTranslationFromFloats

addTranslationFromFloats(x: number, y: number, z: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56517
Adds the translation vector (using 3 floats) in the current matrix

Parameters
- x: number
  
  defines the 1st component of the translation
- y: number
  
  defines the 2nd component of the translation
- z: number
  
  defines the 3rd component of the translation
Returns Matrix
the current updated matrix

asArray

asArray(): DeepImmutableArray<number> | DeepImmutableObject<Float32Array>

Returns the matrix as a Float32Array or Array

Returns DeepImmutableArray<number> | DeepImmutableObject<Float32Array>

the matrix underlying array.

clone Search playground for clone

clone(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56584
Clone the current matrix

Returns Matrix
a new matrix from the current matrix

copyFrom Search playground for copyFrom

copyFrom(other: DeepImmutableObject<Matrix>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56551
Copy the current matrix from the given one

Parameters
- other: DeepImmutableObject<Matrix>
  
  defines the source matrix
Returns Matrix
the current updated matrix

copyToArray Search playground for copyToArray

copyToArray(array: number[] | Float32Array, offset?: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56558
Populates the given array from the starting index with the current matrix values

Parameters
- array: number[] | Float32Array
  
  defines the target array
- Optional offset: number
  
  defines the offset in the target array where to start storing values
Returns Matrix
the current matrix

decompose Search playground for decompose

decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3, preserveScalingNode?: TransformNode): boolean

- Defined in .temp/docdirectory/doc.d.ts:56609
Decomposes the current Matrix into a translation, rotation and scaling components

Parameters
- Optional scale: Vector3
  
  defines the scale vector3 given as a reference to update
- Optional rotation: Quaternion
  
  defines the rotation quaternion given as a reference to update
- Optional translation: Vector3
  
  defines the translation vector3 given as a reference to update
- Optional preserveScalingNode: TransformNode
  
  Use scaling sign coming from this node. Otherwise scaling sign might change.
Returns boolean
true if operation was successful

decomposeToTransformNode Search playground for decomposeToTransformNode

decomposeToTransformNode(node: TransformNode): boolean

- Defined in .temp/docdirectory/doc.d.ts:56600
Decomposes the current Matrix into a translation, rotation and scaling components of the provided node

Parameters
- node: TransformNode
  
  the node to decompose the matrix to
Returns boolean
true if operation was successful

determinant Search playground for determinant

determinant(): number

- Defined in .temp/docdirectory/doc.d.ts:56442
Gets the determinant of the matrix

Returns number
the matrix determinant

equals Search playground for equals

equals(value: DeepImmutableObject<Matrix>): boolean

- Defined in .temp/docdirectory/doc.d.ts:56579
Check equality between this matrix and a second one

Parameters
- value: DeepImmutableObject<Matrix>
  
  defines the second matrix to compare
Returns boolean
true is the current matrix and the given one values are strictly equal

getClassName Search playground for getClassName

getClassName(): string

- Defined in .temp/docdirectory/doc.d.ts:56589
Returns the name of the current matrix class

Returns string
the string "Matrix"

getHashCode Search playground for getHashCode

getHashCode(): number

- Defined in .temp/docdirectory/doc.d.ts:56594
Gets the hash code of the current matrix

Returns number
the hash code

getRotationMatrix Search playground for getRotationMatrix

getRotationMatrix(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56680
Gets only rotation part of the current matrix

Returns Matrix
a new matrix sets to the extracted rotation matrix from the current one

getRotationMatrixToRef Search playground for getRotationMatrixToRef

getRotationMatrixToRef(result: Matrix): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56686
Extracts the rotation matrix from the current one and sets it as the given "result"

Parameters
- result: Matrix
  
  defines the target matrix to store data to
Returns Matrix
the current matrix

getRow Search playground for getRow

getRow(index: number): Nullable<Vector4>

- Defined in .temp/docdirectory/doc.d.ts:56615
Gets specific row of the matrix

Parameters
- index: number
  
  defines the number of the row to get
Returns Nullable<Vector4>
the index-th row of the current matrix as a new Vector4

getRowToRef Search playground for getRowToRef

getRowToRef(index: number, rowVector: Vector4): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56622
Gets specific row of the matrix to ref

Parameters
- index: number
  
  defines the number of the row to get
- rowVector: Vector4
  
  vector to store the index-th row of the current matrix
Returns Matrix
the current matrix

getTranslation Search playground for getTranslation

getTranslation(): Vector3

- Defined in .temp/docdirectory/doc.d.ts:56528
Gets the translation value of the current matrix

Returns Vector3
a new Vector3 as the extracted translation from the matrix

getTranslationToRef Search playground for getTranslationToRef

getTranslationToRef(result: Vector3): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56534
Fill a Vector3 with the extracted translation from the matrix

Parameters
- result: Vector3
  
  defines the Vector3 where to store the translation
Returns Matrix
the current matrix

invert Search playground for invert

invert(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56457
Inverts the current matrix in place

Returns Matrix
the current inverted matrix

invertToRef Search playground for invertToRef

invertToRef(other: Matrix): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56487
Sets the given matrix to the current inverted Matrix

Parameters
- other: Matrix
  
  defines the target matrix
Returns Matrix
the unmodified current matrix

isIdentity Search playground for isIdentity

isIdentity(): boolean

- Defined in .temp/docdirectory/doc.d.ts:56432
Check if the current matrix is identity

Returns boolean
true is the matrix is the identity matrix

isIdentityAs3x2 Search playground for isIdentityAs3x2

isIdentityAs3x2(): boolean

- Defined in .temp/docdirectory/doc.d.ts:56437
Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)

Returns boolean
true is the matrix is the identity matrix

markAsUpdated Search playground for markAsUpdated

markAsUpdated(): void

- Defined in .temp/docdirectory/doc.d.ts:56422
Update the updateFlag to indicate that the matrix has been updated

Returns void

multiply Search playground for multiply

multiply(other: DeepImmutableObject<Matrix>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56545
Multiply two matrices

Parameters
- other: DeepImmutableObject<Matrix>
  
  defines the second operand
Returns Matrix
a new matrix set with the multiplication result of the current Matrix and the given one

multiplyAtIndex Search playground for multiplyAtIndex

multiplyAtIndex(index: number, value: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56501
mutiply the specified position in the current Matrix by a value

Parameters
- index: number
  
  the index of the value within the matrix. between 0 and 15.
- value: number
  
  the value to be added
Returns Matrix
the current updated matrix

multiplyToArray Search playground for multiplyToArray

multiplyToArray(other: DeepImmutableObject<Matrix>, result: number[] | Float32Array, offset: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56573
Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one

Parameters
- other: DeepImmutableObject<Matrix>
  
  defines the second operand
- result: number[] | Float32Array
  
  defines the array where to store the multiplication
- offset: number
  
  defines the offset in the target array where to start storing values
Returns Matrix
the current matrix

multiplyToRef Search playground for multiplyToRef

multiplyToRef(other: DeepImmutableObject<Matrix>, result: Matrix): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56565
Sets the given matrix "result" with the multiplication result of the current Matrix and the given one

Parameters
- other: DeepImmutableObject<Matrix>
  
  defines the second operand
- result: Matrix
  
  defines the matrix where to store the multiplication
Returns Matrix
the current matrix

removeRotationAndScaling Search playground for removeRotationAndScaling

removeRotationAndScaling(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56539
Remove rotation and scaling part from the matrix

Returns Matrix
the updated matrix

reset Search playground for reset

reset(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56462
Sets all the matrix elements to zero

Returns Matrix
the current matrix

scale Search playground for scale

scale(scale: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56656
Compute a new matrix set with the current matrix values multiplied by scale (float)

Parameters
- scale: number
  
  defines the scale factor
Returns Matrix
a new matrix

scaleAndAddToRef Search playground for scaleAndAddToRef

scaleAndAddToRef(scale: number, result: Matrix): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56670
Scale the current matrix values by a factor and add the result to a given matrix

Parameters
- scale: number
  
  defines the scale factor
- result: Matrix
  
  defines the Matrix to store the result
Returns Matrix
the current matrix

scaleToRef Search playground for scaleToRef

scaleToRef(scale: number, result: Matrix): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56663
Scale the current matrix values by a factor to a given result matrix

Parameters
- scale: number
  
  defines the scale factor
- result: Matrix
  
  defines the matrix to store the result
Returns Matrix
the current matrix

setRow Search playground for setRow

setRow(index: number, row: Vector4): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56629
Sets the index-th row of the current matrix to the vector4 values

Parameters
- index: number
  
  defines the number of the row to set
- row: Vector4
  
  defines the target vector4
Returns Matrix
the updated current matrix

setRowFromFloats Search playground for setRowFromFloats

setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56650
Sets the index-th row of the current matrix with the given 4 x float values

Parameters
- index: number
  
  defines the row index
- x: number
  
  defines the x component to set
- y: number
  
  defines the y component to set
- z: number
  
  defines the z component to set
- w: number
  
  defines the w component to set
Returns Matrix
the updated current matrix

setTranslation Search playground for setTranslation

setTranslation(vector3: DeepImmutableObject<Vector3>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56523
Inserts the translation vector in the current matrix

Parameters
- vector3: DeepImmutableObject<Vector3>
  
  defines the translation to insert
Returns Matrix
the current updated matrix

setTranslationFromFloats Search playground for setTranslationFromFloats

setTranslationFromFloats(x: number, y: number, z: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56509
Inserts the translation vector (using 3 floats) in the current matrix

Parameters
- x: number
  
  defines the 1st component of the translation
- y: number
  
  defines the 2nd component of the translation
- z: number
  
  defines the 3rd component of the translation
Returns Matrix
the current updated matrix

toArray

toArray(): DeepImmutableArray<number> | DeepImmutableObject<Float32Array>

Returns the matrix as a Float32Array or Array

Returns DeepImmutableArray<number> | DeepImmutableObject<Float32Array>

the matrix underlying array

toNormalMatrix Search playground for toNormalMatrix

toNormalMatrix(ref: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56675
Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).

Parameters
- ref: Matrix
  
  matrix to store the result
Returns void

toggleModelMatrixHandInPlace Search playground for toggleModelMatrixHandInPlace

toggleModelMatrixHandInPlace(): void

- Defined in .temp/docdirectory/doc.d.ts:56690
Toggles model matrix from being right handed to left handed in place and vice versa

Returns void

toggleProjectionMatrixHandInPlace Search playground for toggleProjectionMatrixHandInPlace

toggleProjectionMatrixHandInPlace(): void

- Defined in .temp/docdirectory/doc.d.ts:56694
Toggles projection matrix from being right handed to left handed in place and vice versa

Returns void

transpose Search playground for transpose

transpose(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56634
Compute the transpose of the matrix

Returns Matrix
the new transposed matrix

transposeToRef Search playground for transposeToRef

transposeToRef(result: Matrix): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56640
Compute the transpose of the matrix and store it in a given matrix

Parameters
- result: Matrix
  
  defines the target matrix
Returns Matrix
the current matrix

Static Compose Search playground for Compose

Compose(scale: DeepImmutableObject<Vector3>, rotation: DeepImmutableObject<Quaternion>, translation: DeepImmutableObject<Vector3>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56770
Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)

Parameters
- scale: DeepImmutableObject<Vector3>
  
  defines the scale vector3
- rotation: DeepImmutableObject<Quaternion>
  
  defines the rotation quaternion
- translation: DeepImmutableObject<Vector3>
  
  defines the translation vector3
Returns Matrix
a new matrix

Static ComposeToRef Search playground for ComposeToRef

ComposeToRef(scale: DeepImmutableObject<Vector3>, rotation: DeepImmutableObject<Quaternion>, translation: DeepImmutableObject<Vector3>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56778
Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)

Parameters
- scale: DeepImmutableObject<Vector3>
  
  defines the scale vector3
- rotation: DeepImmutableObject<Quaternion>
  
  defines the rotation quaternion
- translation: DeepImmutableObject<Vector3>
  
  defines the translation vector3
- result: Matrix
  
  defines the target matrix
Returns void

Static DecomposeLerp Search playground for DecomposeLerp

DecomposeLerp(startValue: DeepImmutableObject<Matrix>, endValue: DeepImmutableObject<Matrix>, gradient: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56932
Builds a new matrix whose values are computed by:
- decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
- interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
- recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
Parameters
- startValue: DeepImmutableObject<Matrix>
  
  defines the first matrix
- endValue: DeepImmutableObject<Matrix>
  
  defines the second matrix
- gradient: number
  
  defines the gradient between the two matrices
Returns Matrix
the new matrix

Static DecomposeLerpToRef Search playground for DecomposeLerpToRef

DecomposeLerpToRef(startValue: DeepImmutableObject<Matrix>, endValue: DeepImmutableObject<Matrix>, gradient: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56943
Update a matrix to values which are computed by:
- decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
- interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
- recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
Parameters
- startValue: DeepImmutableObject<Matrix>
  
  defines the first matrix
- endValue: DeepImmutableObject<Matrix>
  
  defines the second matrix
- gradient: number
  
  defines the gradient between the two matrices
- result: Matrix
  
  defines the target matrix
Returns void

Static FromArray Search playground for FromArray

FromArray(array: DeepImmutableObject<ArrayLike<number>>, offset?: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56701
Creates a matrix from an array

Parameters
- array: DeepImmutableObject<ArrayLike<number>>
  
  defines the source array
- Optional offset: number
  
  defines an offset in the source array
Returns Matrix
a new Matrix set from the starting index of the given array

Static FromArrayToRef Search playground for FromArrayToRef

FromArrayToRef(array: DeepImmutableObject<ArrayLike<number>>, offset: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56708
Copy the content of an array into a given matrix

Parameters
- array: DeepImmutableObject<ArrayLike<number>>
  
  defines the source array
- offset: number
  
  defines an offset in the source array
- result: Matrix
  
  defines the target matrix
Returns void

Static FromFloat32ArrayToRefScaled Search playground for FromFloat32ArrayToRefScaled

FromFloat32ArrayToRefScaled(array: DeepImmutableArray<number> | DeepImmutableObject<Float32Array>, offset: number, scale: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56716
Stores an array into a matrix after having multiplied each component by a given factor

Parameters
- array: DeepImmutableArray<number> | DeepImmutableObject<Float32Array>
  
  defines the source array
- offset: number
  
  defines the offset in the source array
- scale: number
  
  defines the scaling factor
- result: Matrix
  
  defines the target matrix
Returns void

Static FromQuaternionToRef Search playground for FromQuaternionToRef

FromQuaternionToRef(quat: DeepImmutableObject<Quaternion>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:57245
Creates a rotation matrix from a quaternion and stores it in a target matrix

Parameters
- quat: DeepImmutableObject<Quaternion>
  
  defines the quaternion to use
- result: Matrix
  
  defines the target matrix
Returns void

Static FromValues Search playground for FromValues

FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56762
Creates new matrix from a list of values (16)

Parameters
- initialM11: number
  
  defines 1st value of 1st row
- initialM12: number
  
  defines 2nd value of 1st row
- initialM13: number
  
  defines 3rd value of 1st row
- initialM14: number
  
  defines 4th value of 1st row
- initialM21: number
  
  defines 1st value of 2nd row
- initialM22: number
  
  defines 2nd value of 2nd row
- initialM23: number
  
  defines 3rd value of 2nd row
- initialM24: number
  
  defines 4th value of 2nd row
- initialM31: number
  
  defines 1st value of 3rd row
- initialM32: number
  
  defines 2nd value of 3rd row
- initialM33: number
  
  defines 3rd value of 3rd row
- initialM34: number
  
  defines 4th value of 3rd row
- initialM41: number
  
  defines 1st value of 4th row
- initialM42: number
  
  defines 2nd value of 4th row
- initialM43: number
  
  defines 3rd value of 4th row
- initialM44: number
  
  defines 4th value of 4th row
Returns Matrix
the new matrix

Static FromValuesToRef Search playground for FromValuesToRef

FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56741
Stores a list of values (16) inside a given matrix

Parameters
- initialM11: number
  
  defines 1st value of 1st row
- initialM12: number
  
  defines 2nd value of 1st row
- initialM13: number
  
  defines 3rd value of 1st row
- initialM14: number
  
  defines 4th value of 1st row
- initialM21: number
  
  defines 1st value of 2nd row
- initialM22: number
  
  defines 2nd value of 2nd row
- initialM23: number
  
  defines 3rd value of 2nd row
- initialM24: number
  
  defines 4th value of 2nd row
- initialM31: number
  
  defines 1st value of 3rd row
- initialM32: number
  
  defines 2nd value of 3rd row
- initialM33: number
  
  defines 3rd value of 3rd row
- initialM34: number
  
  defines 4th value of 3rd row
- initialM41: number
  
  defines 1st value of 4th row
- initialM42: number
  
  defines 2nd value of 4th row
- initialM43: number
  
  defines 3rd value of 4th row
- initialM44: number
  
  defines 4th value of 4th row
- result: Matrix
  
  defines the target matrix
Returns void

Static FromXYZAxesToRef Search playground for FromXYZAxesToRef

FromXYZAxesToRef(xaxis: DeepImmutableObject<Vector3>, yaxis: DeepImmutableObject<Vector3>, zaxis: DeepImmutableObject<Vector3>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:57239
Sets the given matrix as a rotation matrix composed from the 3 left handed axes

Parameters
- xaxis: DeepImmutableObject<Vector3>
  
  defines the value of the 1st axis
- yaxis: DeepImmutableObject<Vector3>
  
  defines the value of the 2nd axis
- zaxis: DeepImmutableObject<Vector3>
  
  defines the value of the 3rd axis
- result: Matrix
  
  defines the target matrix
Returns void

Static GetAsMatrix2x2 Search playground for GetAsMatrix2x2

GetAsMatrix2x2(matrix: DeepImmutableObject<Matrix>): number[] | Float32Array

- Defined in .temp/docdirectory/doc.d.ts:57201
Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array

Parameters
- matrix: DeepImmutableObject<Matrix>
  
  defines the matrix to use
Returns number[] | Float32Array
a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix

Static GetAsMatrix3x3 Search playground for GetAsMatrix3x3

GetAsMatrix3x3(matrix: DeepImmutableObject<Matrix>): number[] | Float32Array

- Defined in .temp/docdirectory/doc.d.ts:57207
Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array

Parameters
- matrix: DeepImmutableObject<Matrix>
  
  defines the matrix to use
Returns number[] | Float32Array
a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix

Static GetFinalMatrix Search playground for GetFinalMatrix

GetFinalMatrix(viewport: DeepImmutableObject<Viewport>, world: DeepImmutableObject<Matrix>, view: DeepImmutableObject<Matrix>, projection: DeepImmutableObject<Matrix>, zmin: number, zmax: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57195
Computes a complete transformation matrix

Parameters
- viewport: DeepImmutableObject<Viewport>
  
  defines the viewport to use
- world: DeepImmutableObject<Matrix>
  
  defines the world matrix
- view: DeepImmutableObject<Matrix>
  
  defines the view matrix
- projection: DeepImmutableObject<Matrix>
  
  defines the projection matrix
- zmin: number
  
  defines the near clip plane
- zmax: number
  
  defines the far clip plane
Returns Matrix
the transformation matrix

Static Identity Search playground for Identity

Identity(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56783
Creates a new identity matrix

Returns Matrix
a new identity matrix

Static IdentityToRef Search playground for IdentityToRef

IdentityToRef(result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56788
Creates a new identity matrix and stores the result in a given matrix

Parameters
- result: Matrix
  
  defines the target matrix
Returns void

Static Invert Search playground for Invert

Invert(source: DeepImmutableObject<Matrix>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56805
Creates a new matrix as the invert of a given matrix

Parameters
- source: DeepImmutableObject<Matrix>
  
  defines the source matrix
Returns Matrix
the new matrix

Static Lerp Search playground for Lerp

Lerp(startValue: DeepImmutableObject<Matrix>, endValue: DeepImmutableObject<Matrix>, gradient: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56913
Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".

Parameters
- startValue: DeepImmutableObject<Matrix>
  
  defines the start value
- endValue: DeepImmutableObject<Matrix>
  
  defines the end value
- gradient: number
  
  defines the gradient factor
Returns Matrix
the new matrix

Static LerpToRef Search playground for LerpToRef

LerpToRef(startValue: DeepImmutableObject<Matrix>, endValue: DeepImmutableObject<Matrix>, gradient: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56921
Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".

Parameters
- startValue: DeepImmutableObject<Matrix>
  
  defines the start value
- endValue: DeepImmutableObject<Matrix>
  
  defines the end value
- gradient: number
  
  defines the gradient factor
- result: Matrix
  
  defines the Matrix object where to store data
Returns void

Static LookAtLH Search playground for LookAtLH

LookAtLH(eye: DeepImmutableObject<Vector3>, target: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56952
Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up" This function works in left handed mode

Parameters
- eye: DeepImmutableObject<Vector3>
  
  defines the final position of the entity
- target: DeepImmutableObject<Vector3>
  
  defines where the entity should look at
- up: DeepImmutableObject<Vector3>
  
  defines the up vector for the entity
Returns Matrix
the new matrix

Static LookAtLHToRef Search playground for LookAtLHToRef

LookAtLHToRef(eye: DeepImmutableObject<Vector3>, target: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56961
Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up". This function works in left handed mode

Parameters
- eye: DeepImmutableObject<Vector3>
  
  defines the final position of the entity
- target: DeepImmutableObject<Vector3>
  
  defines where the entity should look at
- up: DeepImmutableObject<Vector3>
  
  defines the up vector for the entity
- result: Matrix
  
  defines the target matrix
Returns void

Static LookAtRH Search playground for LookAtRH

LookAtRH(eye: DeepImmutableObject<Vector3>, target: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56970
Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up" This function works in right handed mode

Parameters
- eye: DeepImmutableObject<Vector3>
  
  defines the final position of the entity
- target: DeepImmutableObject<Vector3>
  
  defines where the entity should look at
- up: DeepImmutableObject<Vector3>
  
  defines the up vector for the entity
Returns Matrix
the new matrix

Static LookAtRHToRef Search playground for LookAtRHToRef

LookAtRHToRef(eye: DeepImmutableObject<Vector3>, target: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56979
Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up". This function works in right handed mode

Parameters
- eye: DeepImmutableObject<Vector3>
  
  defines the final position of the entity
- target: DeepImmutableObject<Vector3>
  
  defines where the entity should look at
- up: DeepImmutableObject<Vector3>
  
  defines the up vector for the entity
- result: Matrix
  
  defines the target matrix
Returns void

Static LookDirectionLH Search playground for LookDirectionLH

LookDirectionLH(forward: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56987
Gets a new rotation matrix used to rotate an entity so as it looks in the direction specified by forward from the eye position, the up direction being oriented like "up". This function works in left handed mode

Parameters
- forward: DeepImmutableObject<Vector3>
  
  defines the forward direction - Must be normalized and orthogonal to up.
- up: DeepImmutableObject<Vector3>
  
  defines the up vector for the entity - Must be normalized and orthogonal to forward.
Returns Matrix
the new matrix

Static LookDirectionLHToRef Search playground for LookDirectionLHToRef

LookDirectionLHToRef(forward: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56995
Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks in the direction of forward, the up direction being oriented like "up". This function works in left handed mode

Parameters
- forward: DeepImmutableObject<Vector3>
  
  defines the forward direction - Must be normalized and orthogonal to up.
- up: DeepImmutableObject<Vector3>
  
  defines the up vector for the entity - Must be normalized and orthogonal to forward.
- result: Matrix
  
  defines the target matrix
Returns void

Static LookDirectionRH Search playground for LookDirectionRH

LookDirectionRH(forward: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57003
Gets a new rotation matrix used to rotate an entity so as it looks in the direction specified by forward from the eye position, the up Vector3 being oriented like "up". This function works in right handed mode

Parameters
- forward: DeepImmutableObject<Vector3>
  
  defines the forward direction - Must be normalized and orthogonal to up.
- up: DeepImmutableObject<Vector3>
  
  defines the up vector for the entity - Must be normalized and orthogonal to forward.
Returns Matrix
the new matrix

Static LookDirectionRHToRef Search playground for LookDirectionRHToRef

LookDirectionRHToRef(forward: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:57011
Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks in the direction of forward, the up vector3 being oriented like "up". This function works in right handed mode

Parameters
- forward: DeepImmutableObject<Vector3>
  
  defines the forward direction - Must be normalized and orthogonal to up.
- up: DeepImmutableObject<Vector3>
  
  defines the up vector for the entity - Must be normalized and orthogonal to forward.
- result: Matrix
  
  defines the target matrix
Returns void

Static OrthoLH Search playground for OrthoLH

OrthoLH(width: number, height: number, znear: number, zfar: number, halfZRange?: boolean): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57021
Create a left-handed orthographic projection matrix

Parameters
- width: number
  
  defines the viewport width
- height: number
  
  defines the viewport height
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
Returns Matrix
a new matrix as a left-handed orthographic projection matrix

Static OrthoLHToRef Search playground for OrthoLHToRef

OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix, halfZRange?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:57031
Store a left-handed orthographic projection to a given matrix

Parameters
- width: number
  
  defines the viewport width
- height: number
  
  defines the viewport height
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane
- result: Matrix
  
  defines the target matrix
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
Returns void

Static OrthoOffCenterLH Search playground for OrthoOffCenterLH

OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, halfZRange?: boolean): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57043
Create a left-handed orthographic projection matrix

Parameters
- left: number
  
  defines the viewport left coordinate
- right: number
  
  defines the viewport right coordinate
- bottom: number
  
  defines the viewport bottom coordinate
- top: number
  
  defines the viewport top coordinate
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
Returns Matrix
a new matrix as a left-handed orthographic projection matrix

Static OrthoOffCenterLHToRef Search playground for OrthoOffCenterLHToRef

OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix, halfZRange?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:57055
Stores a left-handed orthographic projection into a given matrix

Parameters
- left: number
  
  defines the viewport left coordinate
- right: number
  
  defines the viewport right coordinate
- bottom: number
  
  defines the viewport bottom coordinate
- top: number
  
  defines the viewport top coordinate
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane
- result: Matrix
  
  defines the target matrix
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
Returns void

Static OrthoOffCenterRH Search playground for OrthoOffCenterRH

OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, halfZRange?: boolean): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57067
Creates a right-handed orthographic projection matrix

Parameters
- left: number
  
  defines the viewport left coordinate
- right: number
  
  defines the viewport right coordinate
- bottom: number
  
  defines the viewport bottom coordinate
- top: number
  
  defines the viewport top coordinate
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
Returns Matrix
a new matrix as a right-handed orthographic projection matrix

Static OrthoOffCenterRHToRef Search playground for OrthoOffCenterRHToRef

OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix, halfZRange?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:57079
Stores a right-handed orthographic projection into a given matrix

Parameters
- left: number
  
  defines the viewport left coordinate
- right: number
  
  defines the viewport right coordinate
- bottom: number
  
  defines the viewport bottom coordinate
- top: number
  
  defines the viewport top coordinate
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane
- result: Matrix
  
  defines the target matrix
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
Returns void

Static PerspectiveFovLH Search playground for PerspectiveFovLH

PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number, halfZRange?: boolean, projectionPlaneTilt?: number, reverseDepthBufferMode?: boolean): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57102
Creates a left-handed perspective projection matrix

Parameters
- fov: number
  
  defines the horizontal field of view
- aspect: number
  
  defines the aspect ratio
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane. If 0, assume we are in "infinite zfar" mode
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
- Optional projectionPlaneTilt: number
  
  optional tilt angle of the projection plane around the X axis (horizontal)
- Optional reverseDepthBufferMode: boolean
  
  true to indicate that we are in a reverse depth buffer mode (meaning znear and zfar have been inverted when calling the function)
Returns Matrix
a new matrix as a left-handed perspective projection matrix

Static PerspectiveFovLHToRef Search playground for PerspectiveFovLHToRef

PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean, halfZRange?: boolean, projectionPlaneTilt?: number, reverseDepthBufferMode?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:57115
Stores a left-handed perspective projection into a given matrix

Parameters
- fov: number
  
  defines the horizontal field of view
- aspect: number
  
  defines the aspect ratio
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane. If 0, assume we are in "infinite zfar" mode
- result: Matrix
  
  defines the target matrix
- Optional isVerticalFovFixed: boolean
  
  defines it the fov is vertically fixed (default) or horizontally
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
- Optional projectionPlaneTilt: number
  
  optional tilt angle of the projection plane around the X axis (horizontal)
- Optional reverseDepthBufferMode: boolean
  
  true to indicate that we are in a reverse depth buffer mode (meaning znear and zfar have been inverted when calling the function)
Returns void

Static PerspectiveFovRH Search playground for PerspectiveFovRH

PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number, halfZRange?: boolean, projectionPlaneTilt?: number, reverseDepthBufferMode?: boolean): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57139
Creates a right-handed perspective projection matrix

Parameters
- fov: number
  
  defines the horizontal field of view
- aspect: number
  
  defines the aspect ratio
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane. If 0, assume we are in "infinite zfar" mode
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
- Optional projectionPlaneTilt: number
  
  optional tilt angle of the projection plane around the X axis (horizontal)
- Optional reverseDepthBufferMode: boolean
  
  true to indicate that we are in a reverse depth buffer mode (meaning znear and zfar have been inverted when calling the function)
Returns Matrix
a new matrix as a right-handed perspective projection matrix

Static PerspectiveFovRHToRef Search playground for PerspectiveFovRHToRef

PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean, halfZRange?: boolean, projectionPlaneTilt?: number, reverseDepthBufferMode?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:57152
Stores a right-handed perspective projection into a given matrix

Parameters
- fov: number
  
  defines the horizontal field of view
- aspect: number
  
  defines the aspect ratio
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane. If 0, assume we are in "infinite zfar" mode
- result: Matrix
  
  defines the target matrix
- Optional isVerticalFovFixed: boolean
  
  defines it the fov is vertically fixed (default) or horizontally
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
- Optional projectionPlaneTilt: number
  
  optional tilt angle of the projection plane around the X axis (horizontal)
- Optional reverseDepthBufferMode: boolean
  
  true to indicate that we are in a reverse depth buffer mode (meaning znear and zfar have been inverted when calling the function)
Returns void

Static PerspectiveFovReverseLHToRef Search playground for PerspectiveFovReverseLHToRef

PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean, halfZRange?: boolean, projectionPlaneTilt?: number): void

- Defined in .temp/docdirectory/doc.d.ts:57127
Stores a left-handed perspective projection into a given matrix with depth reversed

Parameters
- fov: number
  
  defines the horizontal field of view
- aspect: number
  
  defines the aspect ratio
- znear: number
  
  defines the near clip plane
- zfar: number
  
  not used as infinity is used as far clip
- result: Matrix
  
  defines the target matrix
- Optional isVerticalFovFixed: boolean
  
  defines it the fov is vertically fixed (default) or horizontally
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
- Optional projectionPlaneTilt: number
  
  optional tilt angle of the projection plane around the X axis (horizontal)
Returns void

Static PerspectiveFovReverseRHToRef Search playground for PerspectiveFovReverseRHToRef

PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean, halfZRange?: boolean, projectionPlaneTilt?: number): void

- Defined in .temp/docdirectory/doc.d.ts:57164
Stores a right-handed perspective projection into a given matrix

Parameters
- fov: number
  
  defines the horizontal field of view
- aspect: number
  
  defines the aspect ratio
- znear: number
  
  defines the near clip plane
- zfar: number
  
  not used as infinity is used as far clip
- result: Matrix
  
  defines the target matrix
- Optional isVerticalFovFixed: boolean
  
  defines it the fov is vertically fixed (default) or horizontally
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
- Optional projectionPlaneTilt: number
  
  optional tilt angle of the projection plane around the X axis (horizontal)
Returns void

Static PerspectiveFovWebVRToRef Search playground for PerspectiveFovWebVRToRef

PerspectiveFovWebVRToRef(fov: { downDegrees: number; leftDegrees: number; rightDegrees: number; upDegrees: number }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean, halfZRange?: boolean, projectionPlaneTilt?: number): void

- Defined in .temp/docdirectory/doc.d.ts:57179
Stores a perspective projection for WebVR info a given matrix

Parameters
- fov: { downDegrees: number; leftDegrees: number; rightDegrees: number; upDegrees: number }
  
  defines the field of view
  - downDegrees: number
  - leftDegrees: number
  - rightDegrees: number
  - upDegrees: number
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane
- result: Matrix
  
  defines the target matrix
- Optional rightHanded: boolean
  
  defines if the matrix must be in right-handed mode (false by default)
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
- Optional projectionPlaneTilt: number
  
  optional tilt angle of the projection plane around the X axis (horizontal)
Returns void

Static PerspectiveLH Search playground for PerspectiveLH

PerspectiveLH(width: number, height: number, znear: number, zfar: number, halfZRange?: boolean, projectionPlaneTilt?: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57090
Creates a left-handed perspective projection matrix

Parameters
- width: number
  
  defines the viewport width
- height: number
  
  defines the viewport height
- znear: number
  
  defines the near clip plane
- zfar: number
  
  defines the far clip plane
- Optional halfZRange: boolean
  
  true to generate NDC coordinates between 0 and 1 instead of -1 and 1 (default: false)
- Optional projectionPlaneTilt: number
  
  optional tilt angle of the projection plane around the X axis (horizontal)
Returns Matrix
a new matrix as a left-handed perspective projection matrix

Static Reflection Search playground for Reflection

Reflection(plane: DeepImmutableObject<IPlaneLike>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57225
Computes a reflection matrix from a plane

Parameters
- plane: DeepImmutableObject<IPlaneLike>
  
  defines the reflection plane
Returns Matrix
a new matrix

Static ReflectionToRef Search playground for ReflectionToRef

ReflectionToRef(plane: DeepImmutableObject<IPlaneLike>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:57231
Computes a reflection matrix from a plane

Parameters
- plane: DeepImmutableObject<IPlaneLike>
  
  defines the reflection plane
- result: Matrix
  
  defines the target matrix
Returns void

Static RotationAlignToRef Search playground for RotationAlignToRef

RotationAlignToRef(from: DeepImmutableObject<Vector3>, to: DeepImmutableObject<Vector3>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56857
Takes normalised vectors and returns a rotation matrix to align "from" with "to". Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm

Parameters
- from: DeepImmutableObject<Vector3>
  
  defines the vector to align
- to: DeepImmutableObject<Vector3>
  
  defines the vector to align to
- result: Matrix
  
  defines the target matrix
Returns void

Static RotationAxis Search playground for RotationAxis

RotationAxis(axis: DeepImmutableObject<Vector3>, angle: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56842
Creates a new rotation matrix for "angle" radians around the given axis

Parameters
- axis: DeepImmutableObject<Vector3>
  
  defines the axis to use
- angle: number
  
  defines the angle (in radians) to use
Returns Matrix
the new matrix

Static RotationAxisToRef Search playground for RotationAxisToRef

RotationAxisToRef(axis: DeepImmutableObject<Vector3>, angle: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56849
Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix

Parameters
- axis: DeepImmutableObject<Vector3>
  
  defines the axis to use
- angle: number
  
  defines the angle (in radians) to use
- result: Matrix
  
  defines the target matrix
Returns void

Static RotationX Search playground for RotationX

RotationX(angle: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56799
Creates a new rotation matrix for "angle" radians around the X axis

Parameters
- angle: number
  
  defines the angle (in radians) to use
Returns Matrix
the new matrix

Static RotationXToRef Search playground for RotationXToRef

RotationXToRef(angle: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56811
Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix

Parameters
- angle: number
  
  defines the angle (in radians) to use
- result: Matrix
  
  defines the target matrix
Returns void

Static RotationY Search playground for RotationY

RotationY(angle: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56817
Creates a new rotation matrix for "angle" radians around the Y axis

Parameters
- angle: number
  
  defines the angle (in radians) to use
Returns Matrix
the new matrix

Static RotationYToRef Search playground for RotationYToRef

RotationYToRef(angle: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56823
Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix

Parameters
- angle: number
  
  defines the angle (in radians) to use
- result: Matrix
  
  defines the target matrix
Returns void

Static RotationYawPitchRoll Search playground for RotationYawPitchRoll

RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56865
Creates a rotation matrix

Parameters
- yaw: number
  
  defines the yaw angle in radians (Y axis)
- pitch: number
  
  defines the pitch angle in radians (X axis)
- roll: number
  
  defines the roll angle in radians (Z axis)
Returns Matrix
the new rotation matrix

Static RotationYawPitchRollToRef Search playground for RotationYawPitchRollToRef

RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56873
Creates a rotation matrix and stores it in a given matrix

Parameters
- yaw: number
  
  defines the yaw angle in radians (Y axis)
- pitch: number
  
  defines the pitch angle in radians (X axis)
- roll: number
  
  defines the roll angle in radians (Z axis)
- result: Matrix
  
  defines the target matrix
Returns void

Static RotationZ Search playground for RotationZ

RotationZ(angle: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56829
Creates a new rotation matrix for "angle" radians around the Z axis

Parameters
- angle: number
  
  defines the angle (in radians) to use
Returns Matrix
the new matrix

Static RotationZToRef Search playground for RotationZToRef

RotationZToRef(angle: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56835
Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix

Parameters
- angle: number
  
  defines the angle (in radians) to use
- result: Matrix
  
  defines the target matrix
Returns void

Static Scaling Search playground for Scaling

Scaling(x: number, y: number, z: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56881
Creates a scaling matrix

Parameters
- x: number
  
  defines the scale factor on X axis
- y: number
  
  defines the scale factor on Y axis
- z: number
  
  defines the scale factor on Z axis
Returns Matrix
the new matrix

Static ScalingToRef Search playground for ScalingToRef

ScalingToRef(x: number, y: number, z: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56889
Creates a scaling matrix and stores it in a given matrix

Parameters
- x: number
  
  defines the scale factor on X axis
- y: number
  
  defines the scale factor on Y axis
- z: number
  
  defines the scale factor on Z axis
- result: Matrix
  
  defines the target matrix
Returns void

Static Translation Search playground for Translation

Translation(x: number, y: number, z: number): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56897
Creates a translation matrix

Parameters
- x: number
  
  defines the translation on X axis
- y: number
  
  defines the translation on Y axis
- z: number
  
  defines the translationon Z axis
Returns Matrix
the new matrix

Static TranslationToRef Search playground for TranslationToRef

TranslationToRef(x: number, y: number, z: number, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:56905
Creates a translation matrix and stores it in a given matrix

Parameters
- x: number
  
  defines the translation on X axis
- y: number
  
  defines the translation on Y axis
- z: number
  
  defines the translationon Z axis
- result: Matrix
  
  defines the target matrix
Returns void

Static Transpose Search playground for Transpose

Transpose(matrix: DeepImmutableObject<Matrix>): Matrix

- Defined in .temp/docdirectory/doc.d.ts:57213
Compute the transpose of a given matrix

Parameters
- matrix: DeepImmutableObject<Matrix>
  
  defines the matrix to transpose
Returns Matrix
the new matrix

Static TransposeToRef Search playground for TransposeToRef

TransposeToRef(matrix: DeepImmutableObject<Matrix>, result: Matrix): void

- Defined in .temp/docdirectory/doc.d.ts:57219
Compute the transpose of a matrix and store it in a target matrix

Parameters
- matrix: DeepImmutableObject<Matrix>
  
  defines the matrix to transpose
- result: Matrix
  
  defines the target matrix
Returns void

Static Zero Search playground for Zero

Zero(): Matrix

- Defined in .temp/docdirectory/doc.d.ts:56793
Creates a new zero matrix

Returns Matrix
a new zero matrix

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Matrix

Properties

updateFlagSearch playground for updateFlag

Accessors

m

Returns DeepImmutableArray<number> | DeepImmutableObject<Float32Array>

Static IdentityReadOnly

Returns DeepImmutableObject<Matrix>

Static Use64Bits

Returns boolean

Methods

addSearch playground for add

Parameters

other: DeepImmutableObject<Matrix>

Returns Matrix

addAtIndexSearch playground for addAtIndex

Parameters

index: number

value: number

Returns Matrix

addToRefSearch playground for addToRef

Parameters

other: DeepImmutableObject<Matrix>

result: Matrix

Returns Matrix

addToSelfSearch playground for addToSelf

Parameters

other: DeepImmutableObject<Matrix>

Returns Matrix

addTranslationFromFloatsSearch playground for addTranslationFromFloats

Parameters

x: number

y: number

z: number

Returns Matrix

asArray

Returns DeepImmutableArray<number> | DeepImmutableObject<Float32Array>

cloneSearch playground for clone

Returns Matrix

copyFromSearch playground for copyFrom

Parameters

other: DeepImmutableObject<Matrix>

Returns Matrix

copyToArraySearch playground for copyToArray

Parameters

array: number[] | Float32Array

Optional offset: number

Returns Matrix

decomposeSearch playground for decompose

Parameters

Optional scale: Vector3

Optional rotation: Quaternion

Optional translation: Vector3

Optional preserveScalingNode: TransformNode

Returns boolean

decomposeToTransformNodeSearch playground for decomposeToTransformNode

Parameters

node: TransformNode

Returns boolean

determinantSearch playground for determinant

Returns number

equalsSearch playground for equals

Parameters

value: DeepImmutableObject<Matrix>

Returns boolean

getClassNameSearch playground for getClassName

Returns string

getHashCodeSearch playground for getHashCode

Returns number

getRotationMatrixSearch playground for getRotationMatrix

Returns Matrix

getRotationMatrixToRefSearch playground for getRotationMatrixToRef

updateFlag Search playground for updateFlag

add Search playground for add

addAtIndex Search playground for addAtIndex

addToRef Search playground for addToRef

addToSelf Search playground for addToSelf

addTranslationFromFloats Search playground for addTranslationFromFloats

clone Search playground for clone

copyFrom Search playground for copyFrom

copyToArray Search playground for copyToArray

decompose Search playground for decompose

decomposeToTransformNode Search playground for decomposeToTransformNode

determinant Search playground for determinant

equals Search playground for equals

getClassName Search playground for getClassName

getHashCode Search playground for getHashCode

getRotationMatrix Search playground for getRotationMatrix

getRotationMatrixToRef Search playground for getRotationMatrixToRef

getRow Search playground for getRow

getRowToRef Search playground for getRowToRef

getTranslation Search playground for getTranslation

getTranslationToRef Search playground for getTranslationToRef

invert Search playground for invert

invertToRef Search playground for invertToRef

isIdentity Search playground for isIdentity

isIdentityAs3x2 Search playground for isIdentityAs3x2

markAsUpdated Search playground for markAsUpdated

multiply Search playground for multiply

multiplyAtIndex Search playground for multiplyAtIndex

multiplyToArray Search playground for multiplyToArray

multiplyToRef Search playground for multiplyToRef

removeRotationAndScaling Search playground for removeRotationAndScaling

reset Search playground for reset

scale Search playground for scale

scaleAndAddToRef Search playground for scaleAndAddToRef

scaleToRef Search playground for scaleToRef

setRow Search playground for setRow