Class Matrix

存储矩阵（4x4）数据的类

| m01 m02 m03 m04 |
| m11 m12 m13 m14 |
| m21 m22 m23 m24 |
| m31 m32 m33 m34 |

Hierarchy

Matrix

Constructors

constructor

new Matrix(): Matrix
创建一个空矩阵。

Returns Matrix

Accessors

tuple

get tuple(): MatrixTuple
获取当前矩阵的元组。

Returns MatrixTuple

Methods

addTranslation

addTranslation(vector: Vector3): Matrix
将平移向量插入到当前转换矩阵之中。

Returns
当前插入平移向量之后的转换矩阵自身
Parameters
- vector: Vector3
  
  平移向量
Returns Matrix
addTranslation(x?: number, y?: number, z?: number): Matrix
转换矩阵在各轴向上的平移量。

Returns
当前插入平移向量之后的转换矩阵自身
Parameters
- Optional x: number
  
  x 轴上的平移量
- Optional y: number
  
  y 轴上的平移量
- Optional z: number
  
  z 轴上的平移量
Returns Matrix

clone

clone(): Matrix
复制当前矩阵

Returns
一个从当前矩阵复制得到的新的矩阵

Returns Matrix

copyFrom

copyFrom(other: Matrix): Matrix
从源矩阵中复制各项值至当前矩阵之中。

Returns
复制之后的当前矩阵
Parameters
- other: Matrix
  
  源矩阵
Returns Matrix

decompose

decompose(): { rotation: Quaternion; scale: Vector3; translation: Vector3 }
从当前转换矩阵中分解出平移、旋转及缩放分量。

Returns
一个包含表示缩放向量、位移向量及旋转四元组的对象

Returns { rotation: Quaternion; scale: Vector3; translation: Vector3 }
- rotation: Quaternion
- scale: Vector3
- translation: Vector3

decomposeLerpTo

decomposeLerpTo(end: Matrix, gradient: number): Matrix
依照下述规则构造新矩阵：
- 以自身作为变换初始状态，参数传入的矩阵作为变换终止状态，分别分解出各自的平移、旋转及缩放分量；
- 分别在每个分量的起始状态与终止状态间，按指定浮点梯度进行（球面）线性插值；
- 将插值计算得到的平移、旋转及缩放分量合成新的插值转换矩阵。
Returns
新的插值变换矩阵
Parameters
- end: Matrix
  
  终止状态的变换矩阵
- gradient: number
  
  插值梯度，取值 0~1
Returns Matrix

determinant

determinant(): number
获取当前矩阵的行列式。

Returns
当前矩阵的行列式

Returns number

getRotationMatrix

getRotationMatrix(): Matrix
仅获取当前矩阵的旋转部分。

Returns
从当前矩阵中提取的旋转矩阵

Returns Matrix

getRotationQuaternion

getRotationQuaternion(): Quaternion
仅获取当前矩阵的旋转部分。

Returns
从当前矩阵中提取的旋转四元数

Returns Quaternion

getScale

getScale(): Vector3
获取到当前转换矩阵的缩放向量。

Returns
提取自转换矩阵缩放量的新向量

Returns Vector3

getTranslation

getTranslation(): Vector3
获取当前转换矩阵的平移向量。

Returns
提取自转换矩阵平移量的新向量

Returns Vector3

invert

invert(): Matrix
创建当前矩阵的逆矩阵。

Returns
创建的新矩阵

Returns Matrix

invertInPlace

invertInPlace(): Matrix
将当前矩阵转为其逆矩阵。

Returns
求逆的结果

Returns Matrix

isIdentity

isIdentity(): boolean
检查当前矩阵是否是单位矩阵

Returns
当前矩阵为单位矩阵时返回 true

Returns boolean

lerpTo

lerpTo(end: Matrix, gradient: number): Matrix
以自身为起始状态，参数传入的变换矩阵为终止状态，按指定浮点梯度进行线性插值。

Returns
新的插值变换矩阵
Parameters
- end: Matrix
  
  终止状态的变换矩阵
- gradient: number
  
  插值梯度，取值 0~1
Returns Matrix

multiply

multiply(other: Matrix): Matrix
计算当前矩阵与另一个矩阵得乘积，并将将结果作为新的矩阵返回

Returns
乘积结果矩阵
Parameters
- other: Matrix
  
  乘数矩阵
Returns Matrix

multiplyInPlace

multiplyInPlace(other: Matrix): Matrix
计算当前矩阵与另一个矩阵得乘积，并将将结果更新至当前矩阵。

Returns
更新后的矩阵
Parameters
- other: Matrix
  
  乘数矩阵
Returns Matrix

scale

scale(scale: number): Matrix
将当前矩阵值乘以比例计算得到新矩阵。

Returns
新矩阵
Parameters
- scale: number
  
  缩放比例因子
Returns Matrix

scaleInPlace

scaleInPlace(scalar: number): Matrix
将当前矩阵值按照比例进行缩放。

Returns
当前按比例缩放后的矩阵
Parameters
- scalar: number
Returns Matrix

setRotation

setRotation(rotation: Matrix): Matrix
使用一个表示旋转的矩阵设置当前变换矩阵的旋转分量。

Returns
设置旋转的变换矩阵
Parameters
- rotation: Matrix
  
  表示旋转的矩阵
Returns Matrix
setRotation(rotation: Quaternion): Matrix
使用一个表示旋转的四元数设置当前变换矩阵的旋转分量。

Returns
设置旋转的变换矩阵
Parameters
- rotation: Quaternion
  
  表示旋转的四元数
Returns Matrix

setTranslation

setTranslation(vector: Vector3): Matrix
将平移向量设置到当前转换矩阵上。

Returns
当前插入平移向量之后的转换矩阵自身
Parameters
- vector: Vector3
  
  平移向量
Returns Matrix
setTranslation(x: number, y: number, z: number): Matrix
设置转换矩阵在各轴向上的平移量。

Returns
当前插入平移向量之后的转换矩阵自身
Parameters
- x: number
  
  x 轴上的平移量
- y: number
  
  y 轴上的平移量
- z: number
  
  z 轴上的平移量
Returns Matrix

`Static` Compose

Compose(scale: Vector3, rotation: Quaternion, translation: Vector3): Matrix
创建一个由
- scale 缩放（vector3）
- rotation 旋转（quaternion）
- translation 平移（vector）
所合成的转换矩阵。

Returns
创建的转换矩阵
Parameters
- scale: Vector3
  
  定义三维缩放的向量
- rotation: Quaternion
  
  定义旋转的四元数
- translation: Vector3
  
  定义相对于原点平移的向量
Returns Matrix

`Static` Decompose

Decompose(matrix: Matrix): { rotation: Quaternion; scale: Vector3; translation: Vector3 }
从换矩阵中分解出平移、旋转及缩放分量。

Returns
一个包含表示缩放向量、位移向量及旋转四元组的对象
Parameters
- matrix: Matrix
Returns { rotation: Quaternion; scale: Vector3; translation: Vector3 }
- rotation: Quaternion
- scale: Vector3
- translation: Vector3

`Static` DecomposeLerp

DecomposeLerp(start: Matrix, end: Matrix, gradient: number): Matrix
依照下述规则构造新矩阵：
- 将初始状态，终止状态，分别分解出各自的平移、旋转及缩放分量；
- 分别在每个分量的起始状态与终止状态间，按指定浮点梯度进行（球面）线性插值；
- 将插值计算得到的平移、旋转及缩放分量合成新的插值转换矩阵。
Returns
新的插值变换矩阵
Parameters
- start: Matrix
  
  起始状态的变换矩阵
- end: Matrix
  
  终止状态的变换矩阵
- gradient: number
  
  插值梯度，取值 0~1
Returns Matrix

`Static` FromLookAt

FromLookAt(eye: Vector3, target: Vector3, up?: Vector3): Matrix
由 eye 的位置看向给定 target 位置向量，并指定实体上方方向的的向量，计算出当前姿态的变换矩阵。

Returns
变换矩阵
Parameters
- eye: Vector3
  
  定义实体最终位置的向量
- target: Vector3
  
  定义实体看向的位置向量
- up: Vector3 = Axis.Z
  
  定义表示实体上方方向的向量，默认为 Z 轴
Returns Matrix

`Static` FromLookDirection

FromLookDirection(forward: Vector3, up?: Vector3): Matrix
根据给定的两个方向向量（前方与上方），计算用于表示该实体姿态的旋转矩阵。

Returns
旋转矩阵
Parameters
- forward: Vector3
  
  定义表示前方方向的向量，需要与表示上方的向量正交
- up: Vector3 = Axis.Z
  
  定义表示上方方向的向量，需要与表示前方的向量正交，默认为 Z 轴
Returns Matrix

`Static` FromQuaternion

FromQuaternion(quat: Quaternion): Matrix
根据四元数创建一个旋转矩阵。

Results
创建的旋转变换矩阵
Parameters
- quat: Quaternion
  
  表示旋转的四元数
Returns Matrix

`Static` FromTuple

FromTuple(matrixTuple: MatrixTuple): Matrix
根据旋转矩阵元组创建一个旋转矩阵。
Parameters
- matrixTuple: MatrixTuple
  
  表示旋转矩阵的 16 元组
Returns Matrix

`Static` 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
指定十六个初始值创建一个新的转换矩阵。

Returns
新创建的转换矩阵
Parameters
- initialM11: number
  
  第 1 行第 1 列的初始值（matrix[0][0]）
- initialM12: number
  
  第 1 行第 2 列的初始值（matrix[0][1]）
- initialM13: number
  
  第 1 行第 3 列的初始值（matrix[0][2]）
- initialM14: number
  
  第 1 行第 4 列的初始值（matrix[0][3]）
- initialM21: number
  
  第 2 行第 1 列的初始值（matrix[1][0]）
- initialM22: number
  
  第 2 行第 2 列的初始值（matrix[1][1]）
- initialM23: number
  
  第 2 行第 3 列的初始值（matrix[1][2]）
- initialM24: number
  
  第 2 行第 4 列的初始值（matrix[1][3]）
- initialM31: number
  
  第 3 行第 1 列的初始值（matrix[2][0]）
- initialM32: number
  
  第 3 行第 2 列的初始值（matrix[2][1]）
- initialM33: number
  
  第 3 行第 3 列的初始值（matrix[2][2]）
- initialM34: number
  
  第 3 行第 4 列的初始值（matrix[2][3]）
- initialM41: number
  
  第 4 行第 1 列的初始值（matrix[3][0]）
- initialM42: number
  
  第 4 行第 2 列的初始值（matrix[3][1]）
- initialM43: number
  
  第 4 行第 3 列的初始值（matrix[3][2]）
- initialM44: number
  
  第 4 行第 4 列的初始值（matrix[3][3]）
Returns Matrix

`Static` FromVectorsTo

FromVectorsTo(from: Vector3, to: Vector3): Matrix
指定起始方向向量 from 和结果方向向量 to，创建一个描述其旋转的旋转变换矩阵。

Returns
旋转矩阵
Parameters
- from: Vector3
  
  起始方向向量
- to: Vector3
  
  结果方向向量
Returns Matrix

`Static` FromXYZAxes

FromXYZAxes(xAxis: Vector3, yAxis: Vector3, zAxis: Vector3): Matrix
创建由 3 个左手轴组成的旋转矩阵。
Parameters
- xAxis: Vector3
  
  表示 x 轴的单位向量
- yAxis: Vector3
  
  表示 y 轴的单位向量
- zAxis: Vector3
  
  表示 z 轴的单位向量
Returns Matrix

`Static` FromXZAxes

FromXZAxes(xAxis: Vector3, zAxis: Vector3): Matrix
创建由 x 轴与 z 轴定义左手旋转矩阵。 x 轴将保持不变，z 可能会发生最小的变化以加强正交性。 y 轴将由计算得出。

Note: 输入不需要标准化。
Parameters
- xAxis: Vector3
  
  表示 x 轴的向量
- zAxis: Vector3
  
  表示 z 轴的向量
Returns Matrix

`Static` FromZXAxes

FromZXAxes(zAxis: Vector3, xAxis: Vector3): Matrix
创建由 z 轴与 x 轴定义左手旋转矩阵。 z 轴将保持不变，x 可能会发生最小的变化以加强正交性。 y 轴将由计算得出。

Note: 输入不需要标准化。
Parameters
- zAxis: Vector3
  
  表示 z 轴的向量
- xAxis: Vector3
  
  表示 x 轴的向量
Returns Matrix

`Static` Identity

Identity(): Matrix
创建一个单位矩阵。

Returns
新创建的单位矩阵

Returns Matrix

`Static` Lerp

Lerp(start: Matrix, end: Matrix, gradient: number): Matrix
从起始状态，到终止状态，按指定浮点梯度进行线性插值。

Returns
新的插值变换矩阵
Parameters
- start: Matrix
  
  起始状态的变换矩阵
- end: Matrix
  
  终止状态的变换矩阵
- gradient: number
  
  插值梯度，取值 0~1
Returns Matrix

`Static` RotationAxis

RotationAxis(axis: Vector3, angle: number): Matrix
创建一个表示根据给定轴向量旋转指定弧度角度的旋转矩阵。
Parameters
- axis: Vector3
  
  表示旋转轴方向的向量
- angle: number
  
  旋转弧度角度
Returns Matrix

`Static` RotationX

RotationX(angle: number): Matrix
创建一个表示按 x 轴旋转指定弧度角度的旋转矩阵。

Returns
创建的旋转矩阵
Parameters
- angle: number
  
  旋转弧度角度
Returns Matrix

`Static` RotationY

RotationY(angle: number): Matrix
创建一个表示按 y 轴旋转指定弧度角度的旋转矩阵。

Returns
创建的旋转矩阵
Parameters
- angle: number
  
  旋转弧度角度
Returns Matrix

`Static` RotationYawPitchRoll

RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix
创建一个旋转矩阵。

Deprecated
请使用其它工厂方法代替, 如 FromQuaternion()。

Returns
创建的旋转矩阵
Parameters
- yaw: number
  
  横倾弧度角度 (y 轴)
- pitch: number
  
  纵倾弧度角度 (x 轴)
- roll: number
  
  横摆弧度角度 (z 轴)
Returns Matrix

`Static` RotationZ

RotationZ(angle: number): Matrix
创建一个表示按 z 轴旋转指定弧度角度的旋转矩阵。

Returns
创建的旋转矩阵
Parameters
- angle: number
  
  旋转弧度角度
Returns Matrix

`Static` Scaling

Scaling(vector: Vector3): Matrix
创建一个缩放矩阵。

Returns
创建的缩放变换矩阵
Parameters
- vector: Vector3
  
  缩放向量
Returns Matrix
Scaling(x: number, y: number, z: number): Matrix
创建一个缩放矩阵。

Returns
创建的缩放变换矩阵
Parameters
- x: number
  
  沿 x 轴缩放系数
- y: number
  
  沿 y 轴缩放系数
- z: number
  
  沿 z 轴缩放系数
Returns Matrix

`Static` Translation

Translation(vector: Vector3): Matrix
创建一个平移矩阵。

Returns
创建的平移矩阵
Parameters
- vector: Vector3
  
  平移向量
Returns Matrix
Translation(x: number, y: number, z: number): Matrix
创建一个平移矩阵。

Returns
创建的平移矩阵
Parameters
- x: number
  
  沿 x 轴平移距离
- y: number
  
  沿 y 轴平移距离
- z: number
  
  沿 z 轴平移距离
Returns Matrix

`Static` Zero

Zero(): Matrix
创建一个零矩阵。

Returns
新创建的零矩阵

Returns Matrix

Class Matrix

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Matrix

Accessors

tuple

Returns MatrixTuple

Methods

addTranslation

Returns

Parameters

vector: Vector3

Returns Matrix

Returns

Parameters

Optional x: number

Optional y: number

Optional z: number

Returns Matrix

clone

Returns

Returns Matrix

copyFrom

Returns

Parameters

other: Matrix

Returns Matrix

decompose

Returns

Returns { rotation: Quaternion; scale: Vector3; translation: Vector3 }

rotation: Quaternion

scale: Vector3

translation: Vector3

decomposeLerpTo

Returns

Parameters

end: Matrix

gradient: number

Returns Matrix

determinant

Returns

Returns number

getRotationMatrix

Returns

Returns Matrix

getRotationQuaternion

Returns

Returns Quaternion

getScale

Returns

Returns Vector3

getTranslation

Returns

Returns Vector3

invert

Returns

Returns Matrix

invertInPlace

Returns

Returns Matrix

isIdentity

Returns

Returns boolean

lerpTo

Returns

Parameters

end: Matrix

gradient: number

Returns Matrix

multiply

Returns

Parameters

other: Matrix

Returns Matrix

multiplyInPlace

`Optional` x: number

`Optional` y: number

`Optional` z: number

`Static` Compose

`Static` Decompose

`Static` DecomposeLerp

`Static` FromLookAt

`Static` FromLookDirection

`Static` FromQuaternion