Class Matrix4x4

Matrix4x4 类表示一个转换矩阵，该矩阵确定三维 (3D) 显示对象的位置和方向。该矩阵可以执行转换功能，包括平移（沿 x、y 和 z 轴重新定位）、旋转和缩放（调整大小）。 Matrix4x4 类还可以执行透视投影，这会将 3D 坐标空间中的点映射到二维 (2D) 视图。

 ---                                   ---
 |   scaleX      0         0       0     |   x轴
 |     0       scaleY      0       0     |   y轴
 |     0         0       scaleZ    0     |   z轴
 |     tx        ty        tz      1     |   平移
 ---                                   ---

 ---                                   ---
 |     0         1         2        3    |   x轴
 |     4         5         6        7    |   y轴
 |     8         9         10       11   |   z轴
 |     12        13        14       15   |   平移
 ---                                   ---

See

Hierarchy

Matrix4x4

Constructors

constructor

new Matrix4x4(rawData?: NumberArray16): Matrix4x4
创建 Matrix4x4 对象。
Parameters
- rawData: NumberArray16 = ...
  
  一个由 16 个数字组成的矢量，其中，每四个元素可以是 4x4 矩阵的一列。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:230

Properties

elements

elements: NumberArray16

一个由 16 个数字组成的矢量，其中，每四个元素可以是 4x4 矩阵的一列。

Accessors

determinant

get determinant(): number
一个用于确定矩阵是否可逆的数字。如果值为0则不可逆。

Returns number
- Defined in src/math/geom/Matrix4x4.ts:156

Methods

append

append(lhs: Matrix4x4): Matrix4x4
通过将另一个 Matrix4x4 对象与当前 Matrix4x4 对象相乘来后置一个矩阵。
Parameters
- lhs: Matrix4x4
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:367

appendRotation

appendRotation(axis: Vector3, degrees: number, pivotPoint?: Vector3): Matrix4x4
在 Matrix4x4 对象上后置一个增量旋转。
Parameters
- axis: Vector3
  
  旋转轴
- degrees: number
  
  角度
- Optional pivotPoint: Vector3
  
  旋转中心点
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:434

appendScale

appendScale(sx: number, sy: number, sz: number): Matrix4x4
在 Matrix4x4 对象上后置一个增量缩放，沿 x、y 和 z 轴改变位置。
Parameters
- sx: number
  
  用于沿 x 轴缩放对象的乘数。
- sy: number
  
  用于沿 y 轴缩放对象的乘数。
- sz: number
  
  用于沿 z 轴缩放对象的乘数。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:459

appendTranslation

appendTranslation(x: number, y: number, z: number): Matrix4x4
在 Matrix4x4 对象上后置一个增量平移，沿 x、y 和 z 轴重新定位。
Parameters
- x: number
  
  沿 x 轴的增量平移。
- y: number
  
  沿 y 轴的增量平移。
- z: number
  
  沿 z 轴的增量平移。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:474

clone

clone(): Matrix4x4
返回一个新 Matrix4x4 对象，它是与当前 Matrix4x4 对象完全相同的副本。

Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:497

copy

copy(source: Matrix4x4): Matrix4x4
将源 Matrix4x4 对象中的所有矩阵数据复制到调用方 Matrix4x4 对象中。
Parameters
- source: Matrix4x4
  
  要从中复制数据的 Matrix4x4 对象。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:510

equals

equals(matrix: Matrix4x4, precision?: number): boolean
比较矩阵是否相等
Parameters
- matrix: Matrix4x4
- precision: number = mathUtil.PRECISION
Returns boolean
- Defined in src/math/geom/Matrix4x4.ts:1289

fromArray

fromArray(array: number[], index?: number, transpose?: boolean): Matrix4x4
从数组中初始化
Parameters
- array: number[]
  
  包含矩阵数据的数组
- index: number = 0
  
  数组中的起始位置
- transpose: boolean = false
  
  是否转置
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:527

fromAxisRotate

fromAxisRotate(axis: Vector3, degrees: number): Matrix4x4
从轴与旋转角度创建矩阵
Parameters
- axis: Vector3
  
  旋转轴
- degrees: number
  
  角度
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:338

fromPosition

fromPosition(x: number, y: number, z: number): Matrix4x4
创建位移矩阵
Parameters
- x: number
  
  沿 x 轴的增量平移。
- y: number
  
  沿 y 轴的增量平移。
- z: number
  
  沿 z 轴的增量平移。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:246

fromQuaternion

fromQuaternion(q: Quaternion): Matrix4x4
从四元素初始化矩阵。
Parameters
- q: Quaternion
  
  四元素
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:296

fromRotation

fromRotation(rx: number, ry: number, rz: number, order?: RotationOrder): Matrix4x4
从欧拉角旋转角度初始化矩阵。
Parameters
- rx: number
  
  用于沿 x 轴旋转对象的角度。
- ry: number
  
  用于沿 y 轴旋转对象的角度。
- rz: number
  
  用于沿 z 轴旋转对象的角度。
- order: RotationOrder = mathUtil.DefaultRotationOrder
  
  绕轴旋转的顺序。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:284

fromScale

fromScale(sx: number, sy: number, sz: number): Matrix4x4
创建缩放矩阵
Parameters
- sx: number
  
  用于沿 x 轴缩放对象的乘数。
- sy: number
  
  用于沿 y 轴缩放对象的乘数。
- sz: number
  
  用于沿 z 轴缩放对象的乘数。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:264

fromTRS

fromTRS(position: Vector3, rotation: Vector3, scale: Vector3, order?: RotationOrder): Matrix4x4
通过位移旋转缩放重组矩阵
Parameters
- position: Vector3
  
  位移
- rotation: Vector3
  
  旋转角度，按照指定旋转顺序旋转角度。
- scale: Vector3
  
  缩放。
- order: RotationOrder = mathUtil.DefaultRotationOrder
  
  旋转顺序。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:588

getAxisX

getAxisX(out?: Vector3): Vector3
获取X轴向量
Parameters
- out: Vector3 = ...
  
  保存X轴向量
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:173

getAxisY

getAxisY(out?: Vector3): Vector3
获取Y轴向量
Parameters
- out: Vector3 = ...
  
  保存Y轴向量
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:197

getAxisZ

getAxisZ(out?: Vector3): Vector3
获取Z轴向量
Parameters
- out: Vector3 = ...
  
  保存Z轴向量
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:221

getMaxScaleOnAxis

getMaxScaleOnAxis(): number
获取XYZ轴中最大缩放值

Returns number
- Defined in src/math/geom/Matrix4x4.ts:1371

getPosition

getPosition(value?: Vector3): Vector3
获取位移
Parameters
- value: Vector3 = ...
  
  用于存储位移信息的向量
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:54

getRotation

getRotation(rotation?: Vector3, order?: RotationOrder): Vector3
获取欧拉旋转角度。
Parameters
- rotation: Vector3 = ...
  
  欧拉旋转角度。
- order: RotationOrder = mathUtil.DefaultRotationOrder
  
  绕轴旋转的顺序。
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:83

getScale

getScale(scale?: Vector3): Vector3
获取缩放值。
Parameters
- scale: Vector3 = ...
  
  用于存储缩放值的向量。
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:114

identity

identity(): Matrix4x4
将当前矩阵转换为恒等或单位矩阵。

Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:888

invert

invert(): Matrix4x4
反转当前矩阵。逆矩阵

Returns
如果成功反转矩阵，则返回该矩阵。

Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:916

lookAt

lookAt(target: Vector3, upAxis?: Vector3): Matrix4x4
看向目标位置
Parameters
- target: Vector3
  
  目标位置
- Optional upAxis: Vector3
  
  向上朝向
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1309

moveForward

moveForward(distance: number): Matrix4x4
Z轴方向移动
Parameters
- distance: number
  
  移动距离
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1064

moveRight

moveRight(distance: number): Matrix4x4
X轴方向移动
Parameters
- distance: number
  
  移动距离
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1035

moveUp

moveUp(distance: number): Matrix4x4
Y轴方向移动
Parameters
- distance: number
  
  移动距离
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1050

prepend

prepend(rhs: Matrix4x4): Matrix4x4
通过将当前 Matrix4x4 对象与另一个 Matrix4x4 对象相乘来前置一个矩阵。得到的结果将合并两个矩阵转换。
Parameters
- rhs: Matrix4x4
  
  个右侧矩阵，它与当前 Matrix4x4 对象相乘。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:959

prependRotation

prependRotation(axis: Vector3, degrees: number, _pivotPoint?: Vector3): Matrix4x4
在 Matrix4x4 对象上前置一个增量旋转。在将 Matrix4x4 对象应用于显示对象时，矩阵会在 Matrix4x4 对象中先执行旋转，然后再执行其他转换。
Parameters
- axis: Vector3
  
  旋转的轴或方向。常见的轴为 X_AXIS (Vector3(1,0,0))、Y_AXIS (Vector3(0,1,0)) 和 Z_AXIS (Vector3(0,0,1))。此矢量的长度应为 1。
- degrees: number
  
  旋转的角度。
- _pivotPoint: Vector3 = ...
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:975

prependScale

prependScale(xScale: number, yScale: number, zScale: number): Matrix4x4
在 Matrix4x4 对象上前置一个增量缩放，沿 x、y 和 z 轴改变位置。在将 Matrix4x4 对象应用于显示对象时，矩阵会在 Matrix4x4 对象中先执行缩放更改，然后再执行其他转换。
Parameters
- xScale: number
  
  用于沿 x 轴缩放对象的乘数。
- yScale: number
  
  用于沿 y 轴缩放对象的乘数。
- zScale: number
  
  用于沿 z 轴缩放对象的乘数。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:990

prependScale1

prependScale1(xScale: number, yScale: number, zScale: number): Matrix4x4
Parameters
- xScale: number
- yScale: number
- zScale: number
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:999

prependTranslation

prependTranslation(x: number, y: number, z: number): Matrix4x4
在 Matrix4x4 对象上前置一个增量平移，沿 x、y 和 z 轴重新定位。在将 Matrix4x4 对象应用于显示对象时，矩阵会在 Matrix4x4 对象中先执行平移更改，然后再执行其他转换。
Parameters
- x: number
  
  沿 x 轴的增量平移。
- y: number
  
  沿 y 轴的增量平移。
- z: number
  
  沿 z 轴的增量平移。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1022

random

random(): Matrix4x4
随机矩阵。

Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:573

setAxisX

setAxisX(vector?: Vector3): Matrix4x4
设置X轴向量
Parameters
- vector: Vector3 = ...
  
  X轴向量
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:183

setAxisY

setAxisY(vector?: Vector3): Matrix4x4
设置Y轴向量
Parameters
- vector: Vector3 = ...
  
  X轴向量
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:207

setOrtho

setOrtho(left: number, right: number, top: number, bottom: number, near: number, far: number): Matrix4x4
初始化正射投影矩阵
Parameters
- left: number
  
  可视空间左边界
- right: number
  
  可视空间右边界
- top: number
  
  可视空间上边界
- bottom: number
  
  可视空间下边界
- near: number
  
  可视空间近边界
- far: number
  
  可视空间远边界
  
  可视空间的八个顶点分别被投影到立方体 [(-1, -1, -1), (1, 1, 1)] 八个顶点上
  
  将长方体 [(left, bottom, near), (right, top, far)] 投影至立方体 [(-1, -1, -1), (1, 1, 1)] 中
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1394

setPerspective

setPerspective(left: number, right: number, top: number, bottom: number, near: number, far: number): Matrix4x4
初始化透视投影矩阵
Parameters
- left: number
  
  可视空间左边界
- right: number
  
  可视空间右边界
- top: number
  
  可视空间上边界
- bottom: number
  
  可视空间下边界
- near: number
  
  可视空间近边界
- far: number
  
  可视空间远边界
  
  可视空间的八个顶点分别被投影到立方体 [(-1, -1, -1), (1, 1, 1)] 八个顶点上
  
  将长方体 [(left, bottom, near), (right, top, far)] 投影至立方体 [(-1, -1, -1), (1, 1, 1)] 中
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1442

setPerspectiveFromFOV

setPerspectiveFromFOV(fov: number, aspect: number, near: number, far: number): Matrix4x4
初始化透视投影矩阵
Parameters
- fov: number
  
  垂直视角，视锥体顶面和底面间的夹角，必须大于0 （角度）
- aspect: number
  
  近裁剪面的宽高比
- near: number
  
  视锥体近边界
- far: number
  
  视锥体远边界
  
  视锥体的八个顶点分别被投影到立方体 [(-1, -1, -1), (1, 1, 1)] 八个顶点上
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1415

setPosition

setPosition(value: Vector3): Matrix4x4
设置位移
Parameters
- value: Vector3
  
  位移
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:68

setRotation

setRotation(rotation: Vector3, order?: RotationOrder): Matrix4x4
设置欧拉旋转角度。
Parameters
- rotation: Vector3
  
  欧拉旋转角度。
- order: RotationOrder = mathUtil.DefaultRotationOrder
  
  绕轴旋转的顺序。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:96

setScale

setScale(scale: Vector3): Matrix4x4
获取缩放值。
Parameters
- scale: Vector3
  
  缩放值。
Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:131

toArray

toArray(array?: number[] | Float32Array, index?: number, transpose?: boolean): number[] | Float32Array
将矩阵数据转换为数组
Parameters
- array: number[] | Float32Array = []
  
  保存矩阵数据的数组
- index: number = 0
  
  数组中的起始位置
- transpose: boolean = false
  
  是否转置
Returns number[] | Float32Array
- Defined in src/math/geom/Matrix4x4.ts:552

toMatrix3x3

toMatrix3x3(out?: Matrix3x3): Matrix3x3
转换为3x3矩阵
Parameters
- out: Matrix3x3 = ...
  
  3x3矩阵
Returns Matrix3x3
- Defined in src/math/geom/Matrix4x4.ts:1459

toString

toString(): string
以字符串返回矩阵的值

Returns string
- Defined in src/math/geom/Matrix4x4.ts:1482

toTRS

toTRS(position?: Vector3, rotation?: Vector3, scale?: Vector3, order?: RotationOrder): Vector3[]
把矩阵分解为位移旋转缩放。
Parameters
- position: Vector3 = ...
  
  位移
- rotation: Vector3 = ...
  
  旋转角度，按照指定旋转顺序旋转。
- scale: Vector3 = ...
  
  缩放。
- order: RotationOrder = mathUtil.DefaultRotationOrder
  
  旋转顺序。
Returns Vector3[]
- Defined in src/math/geom/Matrix4x4.ts:759

transformPoint3

transformPoint3(vIn: Vector3, vOut?: Vector3): Vector3
使用转换矩阵将 Vector3 对象从一个空间坐标转换到另一个空间坐标。

Returns
一个包含转换后的坐标的 Vector3 对象。
Parameters
- vIn: Vector3
  
  一个容纳要转换的坐标的 Vector3 对象。
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:1079

transformPoints

transformPoints(vIn: number[], vOut?: number[]): number[]
变换坐标数组数据
Parameters
- vIn: number[]
  
  被变换坐标数组数据
- vOut: number[] = []
  
  变换后的坐标数组数据
Returns number[]
- Defined in src/math/geom/Matrix4x4.ts:1183

transformRay

transformRay(inRay: Ray3, outRay?: Ray3): Ray3
使用转换矩阵将 Ray3 对象从一个空间坐标转换到另一个空间坐标。

Returns
转换后的Ray3。
Parameters
- inRay: Ray3
  
  被转换的Ray3。
- outRay: Ray3 = ...
  
  转换后的Ray3。
Returns Ray3
- Defined in src/math/geom/Matrix4x4.ts:1259

transformRotation

transformRotation(vIn: Vector3, vOut?: Vector3): Vector3
变换旋转角度
Parameters
- vIn: Vector3
  
  被变换的旋转角度
- vOut: Vector3 = ...
  
  变换后的旋转角度
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:1219

transformVector3

transformVector3(vIn: Vector3, vOut?: Vector3): Vector3
变换Vector3向量

与变换点不同，并不会受到矩阵平移分量的影响。
Parameters
- vIn: Vector3
  
  被变换的向量
- vOut: Vector3 = ...
  
  变换后的向量
Returns Vector3
- Defined in src/math/geom/Matrix4x4.ts:1114

transformVector4

transformVector4(vIn: Vector4, vOut?: Vector4): Vector4
变换Vector4向量
Parameters
- vIn: Vector4
  
  被变换的向量
- vOut: Vector4 = ...
  
  变换后的向量
Returns Vector4
- Defined in src/math/geom/Matrix4x4.ts:1144

transpose

transpose(): Matrix4x4
将当前 Matrix4x4 对象转换为一个矩阵，并将互换其中的行和列。

Returns Matrix4x4
- Defined in src/math/geom/Matrix4x4.ts:1270

Class Matrix4x4

See

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

rawData: NumberArray16 = ...

Returns Matrix4x4

Properties

elements

Accessors

determinant

Returns number

Methods

append

Parameters

lhs: Matrix4x4

Returns Matrix4x4

appendRotation

Parameters

axis: Vector3

degrees: number

Optional pivotPoint: Vector3

Returns Matrix4x4

appendScale

Parameters

sx: number

sy: number

sz: number

Returns Matrix4x4

appendTranslation

Parameters

x: number

y: number

z: number

Returns Matrix4x4

clone

Returns Matrix4x4

copy

Parameters

source: Matrix4x4

Returns Matrix4x4

equals

Parameters

matrix: Matrix4x4

precision: number = mathUtil.PRECISION

Returns boolean

fromArray

Parameters

array: number[]

index: number = 0

transpose: boolean = false

Returns Matrix4x4

fromAxisRotate

Parameters

axis: Vector3

degrees: number

Returns Matrix4x4

fromPosition

Parameters

x: number

y: number

z: number

Returns Matrix4x4

fromQuaternion

Parameters

q: Quaternion

Returns Matrix4x4

fromRotation

Parameters

rx: number

ry: number

rz: number

order: RotationOrder = mathUtil.DefaultRotationOrder

Returns Matrix4x4

`Optional` pivotPoint: Vector3

`Optional` upAxis: Vector3