Class: Matrix4 ​

math 4*4 matrix

Constructors ​

• constructor

Properties ​

• blockBytes
• allocCount
• allocOnceCount
• maxCount
• useCount
• dynamicMatrixBytes
• dynamicGlobalMatrixRef
• help_matrix_0
• help_matrix_1
• help_matrix_2
• helpMatrix
• helpMatrix2
• index
• rawData

Accessors ​

• determinant
• position
• scale

Methods ​

• allocMatrix
• fromToRotation
• getAxisRotation
• sanitizeEuler
• makePositive
• matrixToEuler
• matrixMultiply
• matrixAppend
• matrixRotateY
• matrixRotate
• lookAt
• multiply
• multiplyMatrices
• multiplyPoint3
• multiplyVector4
• transformVector4
• perspectiveMultiplyPoint3
• perspective
• perspective3
• frustum
• ortho
• orthoZO
• orthoOffCenter
• transformDir
• append
• add
• sub
• mult
• appendRotation
• createByRotation
• appendScale
• createByScale
• appendTranslation
• clone
• copyRowFrom
• copyRowTo
• copyFrom
• copyRawDataTo
• copyColFrom
• copyColTo
• copyToMatrix3D
• makeRotationFromQuaternion
• decompose
• getEuler
• compose
• deltaTransformVector
• identity
• fill
• invers33
• invert
• transformPoint
• transformVector
• transpose
• getPosition
• toString
• lerp
• get
• set
• getMaxScaleOnAxis
• translate
• setTRInverse
• setScale
• makeBasis
• makeRotationAxis

Constructors ​

constructor ​

• new Matrix4(doMatrix?)

Parameters ​

Defined in ​

src/math/Matrix4.ts:321

Properties ​

blockBytes ​

▪ Static blockBytes: number

matrix44 bytes block size

Defined in ​

src/math/Matrix4.ts:17

allocCount ​

▪ Static allocCount: number = 1000

matrix do total count

Defined in ​

src/math/Matrix4.ts:27

allocOnceCount ​

▪ Static allocOnceCount: number = 1000

quantity allocated for each capacity expansion

Defined in ​

src/math/Matrix4.ts:32

maxCount ​

▪ Static maxCount: number

matrix has max limit count

Defined in ​

src/math/Matrix4.ts:37

useCount ​

▪ Static useCount: number = 0

current matrix use count

Defined in ​

src/math/Matrix4.ts:42

dynamicMatrixBytes ​

▪ Static dynamicMatrixBytes: Float32Array

matrix do use share bytesArray

Defined in ​

src/math/Matrix4.ts:58

dynamicGlobalMatrixRef ​

▪ Static dynamicGlobalMatrixRef: Matrix4[]

cache all use do matrix

Defined in ​

src/math/Matrix4.ts:63

help_matrix_0 ​

▪ Static help_matrix_0: Matrix4

help fix global matrix 0

Defined in ​

src/math/Matrix4.ts:73

help_matrix_1 ​

▪ Static help_matrix_1: Matrix4

help fix global matrix 1

Defined in ​

src/math/Matrix4.ts:78

help_matrix_2 ​

▪ Static help_matrix_2: Matrix4

help fix global matrix 2

Defined in ​

src/math/Matrix4.ts:83

helpMatrix ​

▪ Static helpMatrix: Matrix4

help fix global matrix 3

Defined in ​

src/math/Matrix4.ts:88

helpMatrix2 ​

▪ Static helpMatrix2: Matrix4

help fix global matrix 4

Defined in ​

src/math/Matrix4.ts:93

index ​

• index: number = 0

matrix index at global matrix list

Defined in ​

src/math/Matrix4.ts:104

rawData ​

• rawData: Float32Array

matrix raw data format Float32Array

See

Float32Array

Version

Orillusion3D 0.5.1

Defined in ​

src/math/Matrix4.ts:116

Accessors ​

determinant ​

• get determinant(): number

Returns the matrix determinant

Version

Orillusion3D 0.5.1

Returns ​

number

number determinant

Defined in ​

src/math/Matrix4.ts:1884

position ​

• get position(): Vector3

Return translation

Version

Orillusion3D 0.5.1

Returns ​

Vector3

Vector3 Position of translation

Defined in ​

src/math/Matrix4.ts:1915

• set position(value): void

Set Position of translation

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1925

scale ​

• get scale(): Vector3

get Component of scale

Version

Orillusion3D 0.5.1

Returns ​

Vector3

Vector3 scale

Defined in ​

src/math/Matrix4.ts:1938

• set scale(value): void

Set component of scale

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1946

Methods ​

allocMatrix ​

▸ Static allocMatrix(allocCount): void

alloc web runtime cpu memory totalCount * 4(float) * 4 init matrix memory by totalCount * 4(float) * 4

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:126

fromToRotation ​

▸ Static fromToRotation(fromDirection, toDirection, target?): Matrix4

create matrix from two direction

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Matrix4

return new one matrix

Defined in ​

src/math/Matrix4.ts:156

getAxisRotation ​

▸ Static getAxisRotation(x, y, z, degrees): Matrix4

Generate a matrix (rotate degrees with x,y,z as the center axis)

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Matrix4

Matrix4 result

Defined in ​

src/math/Matrix4.ts:171

sanitizeEuler ​

▸ Static sanitizeEuler(euler): void

Arrange the Euler values

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:205

makePositive ​

▸ Static makePositive(euler): void

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:213

matrixToEuler ​

▸ Static matrixToEuler(matrix, v): boolean

Convert the matrix to Euler angles

Parameters ​

Returns ​

boolean

Defined in ​

src/math/Matrix4.ts:245

matrixMultiply ​

▸ Static matrixMultiply(aMat, bMat, target_Mat): void

Multiply the world matrix, specifying parameters and results according to the index

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:282

matrixAppend ​

▸ Static matrixAppend(aMat, bMat, target_Mat): void

World matrix extension, according to the index to specify parameters and results

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:292

matrixRotateY ​

▸ Static matrixRotateY(rad, target_Mat): void

The Y-axis is rotated between the world matrix, and the parameters and results are specified according to the index

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:302

matrixRotate ​

▸ Static matrixRotate(rad, axis, target_Mat): void

Rotate the world matrix, specifying parameters and results according to the index

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:312

lookAt ​

▸ lookAt(eye, at, up?): void

current matrix move position and rotation to target

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:352

multiply ​

▸ multiply(mat4): void

matrix multiply

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:403

multiplyMatrices ​

▸ multiplyMatrices(a, b): Matrix4

Parameters ​

Returns ​

Matrix4

Defined in ​

src/math/Matrix4.ts:452

multiplyPoint3 ​

▸ multiplyPoint3(v, output?): Vector3

convert a vector3 to this matrix space if output not set , return a new one

Parameters ​

Returns ​

Vector3

save target

Defined in ​

src/math/Matrix4.ts:499

multiplyVector4 ​

▸ multiplyVector4(a, out?): Vector3

Parameters ​

Returns ​

Vector3

Defined in ​

src/math/Matrix4.ts:508

transformVector4 ​

▸ transformVector4(v, target?): Vector3

convert a vector3 to this matrix space if output not set , return a new one

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Vector3

Vector3

Defined in ​

src/math/Matrix4.ts:531

perspectiveMultiplyPoint3 ​

▸ perspectiveMultiplyPoint3(v, output): boolean

Convert projection coordinates to 3D coordinates

Parameters ​

Returns ​

boolean

Defined in ​

src/math/Matrix4.ts:555

perspective ​

▸ perspective(fov, aspect, zn, zf): void

set matrix perspective

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:585

perspective3 ​

▸ perspective3(fov, aspect, near, far): void

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:612

frustum ​

▸ frustum(l, r, b, t, n, f): void

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:618

ortho ​

▸ ortho(w, h, zn, zf): Matrix4

Version

Orillusion3D 0.5.1 set matrix orthogonal projection

Parameters ​

Returns ​

Matrix4

this matrix

Defined in ​

src/math/Matrix4.ts:651

orthoZO ​

▸ orthoZO(left, right, bottom, top, near, far): Matrix4

set matrix orthogonal projection by view side

Parameters ​

Returns ​

Matrix4

this matrix

Defined in ​

src/math/Matrix4.ts:687

orthoOffCenter ​

▸ orthoOffCenter(l, r, b, t, zn, zf): void

set matrix orthogonal projection by view center

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:714

transformDir ​

▸ transformDir(fromDirection, toDirection): void

set matrix from two direction

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:744

append ​

▸ append(lhs): void

multiply matrix a b

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:865

add ​

▸ add(lhs): Matrix4

matrix a add matrix b

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Matrix4

Matrix4 result.

Defined in ​

src/math/Matrix4.ts:911

sub ​

▸ sub(lhs): Matrix4

matrix a sub matrix b

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Matrix4

Matrix4 .

Defined in ​

src/math/Matrix4.ts:974

mult ​

▸ mult(v): Matrix4

Matrix times components.

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Matrix4

Matrix4 Returns a multiplicative result matrix.

Defined in ​

src/math/Matrix4.ts:1038

appendRotation ​

▸ appendRotation(degrees, axis): void

Add a direction Angle rotation to the current matrix (the matrix created by rotating degrees according to axis)

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1085

createByRotation ​

▸ createByRotation(degrees, axis): void

Create a matrix based on the axis and rotation Angle (the matrix created by rotating the degrees according to the axis)

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1096

appendScale ​

▸ appendScale(xScale, yScale, zScale): void

Append the triaxial scaling value

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1172

createByScale ​

▸ createByScale(xScale, yScale, zScale): void

A scaling matrix is generated and other properties are reset

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1184

appendTranslation ​

▸ appendTranslation(x, y, z): void

Plus a translation matrix

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1211

clone ​

▸ clone(): Matrix4

Returns a clone of the current matrix

Version

Orillusion3D 0.5.1

Returns ​

Matrix4

Matrix4 The cloned matrix

Defined in ​

src/math/Matrix4.ts:1223

copyRowFrom ​

▸ copyRowFrom(row, Vector3): void

Assigns a value to one row of the current matrix

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1235

copyRowTo ​

▸ copyRowTo(row, Vector3): void

One of the rows in the copy matrix stores the values in Vector3.

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1273

copyFrom ​

▸ copyFrom(sourceMatrix3D): Matrix4

Assigns the value of a matrix to the current matrix.

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Matrix4

Returns the current matrix

Defined in ​

src/math/Matrix4.ts:1311

copyRawDataTo ​

▸ copyRawDataTo(vector, index?, transpose?): void

CoMath.PIes the value of the current matrix to a float array.

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1339

copyColFrom ​

▸ copyColFrom(col, Vector3): void

Assigns a value to a column of the current matrix

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1365

copyColTo ​

▸ copyColTo(col, Vector3): void

Copy a column of the current matrix

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1403

copyToMatrix3D ​

▸ copyToMatrix3D(dest): void

Copy the current matrix

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1440

makeRotationFromQuaternion ​

▸ makeRotationFromQuaternion(quaternion): Matrix4

Calculate rotation matrix

Parameters ​

Returns ​

Matrix4

Defined in ​

src/math/Matrix4.ts:1449

decompose ​

▸ decompose(orientationStyle?, target?): Vector3[]

Decompose the current matrix

See

• Orientation3D.AXIS_ANGLE
• Orientation3D.EULER_ANGLES
• Orientation3D.QUATERNION

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Vector3[]

Vector3[3] pos rot scale

Defined in ​

src/math/Matrix4.ts:1464

getEuler ​

▸ Static getEuler(target, quaternion, isDegree?, order?): Vector3

Get the Euler vector

Parameters ​

Returns ​

Vector3

Defined in ​

src/math/Matrix4.ts:1592

compose ​

▸ compose(position, quaternion, scale): Matrix4

Calculate the combined matrix of displacement, rotation and scaling

Parameters ​

Returns ​

Matrix4

Defined in ​

src/math/Matrix4.ts:1605

deltaTransformVector ​

▸ deltaTransformVector(v, target?): Vector3

The current matrix transforms a vector

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Vector3

Vector3 The transformed vector

Defined in ​

src/math/Matrix4.ts:1659

identity ​

▸ identity(): Matrix4

Unifies the current matrix

Version

Orillusion3D 0.5.1

Returns ​

Matrix4

Defined in ​

src/math/Matrix4.ts:1678

fill ​

▸ fill(value): void

Fill the current matrix

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1705

invers33 ​

▸ invers33(): void

Invert the current matrix

Version

Orillusion3D 0.5.1

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1729

invert ​

▸ invert(): boolean

Invert the current matrix

Version

Orillusion3D 0.5.1

Returns ​

boolean

boolean Whether can invert it

Defined in ​

src/math/Matrix4.ts:1766

transformPoint ​

▸ transformPoint(v, target?): Vector3

Converts the current coordinates to the world coordinates

Parameters ​

Returns ​

Vector3

world coordinate

Defined in ​

src/math/Matrix4.ts:1816

transformVector ​

▸ transformVector(v, target?): Vector3

Transforming a 3D vector with the current matrix does not deal with displacement

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

Vector3

Vector3 The transformed vector

Defined in ​

src/math/Matrix4.ts:1838

transpose ​

▸ transpose(): void

The current matrix transpose

Version

Orillusion3D 0.5.1

Returns ​

void

Defined in ​

src/math/Matrix4.ts:1858

getPosition ​

▸ getPosition(out?): Vector3

Return matrix displacement

Parameters ​

Returns ​

Vector3

Position of translation

Defined in ​

src/math/Matrix4.ts:1901

toString ​

▸ toString(): string

Returns the value of the matrix as a string

Version

Orillusion3D 0.5.1

Returns ​

string

string

Defined in ​

src/math/Matrix4.ts:1963

lerp ​

▸ lerp(m0, m1, t): void

Interpolate between two matrices

Version

Orillusion3D 0.5.1

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:2009

get ​

▸ get(row, column): number

Read matrix element values

Parameters ​

Returns ​

number

Defined in ​

src/math/Matrix4.ts:2020

set ​

▸ set(row, column, v): void

Sets the matrix element values

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:2030

getMaxScaleOnAxis ​

▸ getMaxScaleOnAxis(): number

Get the maximum value of the matrix scaled on each axis

Version

Orillusion3D 0.5.1 4.0

Returns ​

number

Defined in ​

src/math/Matrix4.ts:2038

translate ​

▸ translate(inTrans): Matrix4

Calculate the displacement from the vector

Parameters ​

Returns ​

Matrix4

current matrix

Defined in ​

src/math/Matrix4.ts:2053

setTRInverse ​

▸ setTRInverse(pos, q): void

from unity AMath.PI

Parameters ​

Returns ​

void

Defined in ​

src/math/Matrix4.ts:2070

setScale ​

▸ setScale(inScale): Matrix4

Set scale value

Parameters ​

Returns ​

Matrix4

this matrix

Defined in ​

src/math/Matrix4.ts:2081

makeBasis ​

▸ makeBasis(xAxis, yAxis, zAxis): Matrix4

Generate the matrix according to the three axes

Parameters ​

Returns ​

Matrix4

Defined in ​

src/math/Matrix4.ts:2107

makeRotationAxis ​

▸ makeRotationAxis(axis, angle): Matrix4

Parameters ​

Returns ​

Matrix4

Defined in ​

src/math/Matrix4.ts:2117