Class Quaternion

可用于表示旋转的四元数对象

Hierarchy

Quaternion

Index

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion
四元数描述三维空间中的旋转。四元数的数学定义为Q = xi + yj + z*k + w，其中(i,j,k)为虚基向量。(x,y,z)可以看作是一个与旋转轴相关的向量，而实际的乘法器w与旋转量相关。
Parameters
- x: number = 0
  
  虚基向量i的乘子
- y: number = 0
  
  虚基向量j的乘子
- z: number = 0
  
  虚基向量k的乘子
- w: number = 1
  
  实部的乘数
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:44

Properties

w

w: number = 1

实部的乘数

x

x: number = 0

虚基向量i的乘子

y

y: number = 0

虚基向量j的乘子

z

z: number = 0

虚基向量k的乘子

Accessors

magnitude

get magnitude(): number
返回四元数对象的大小

Returns number
- Defined in src/math/geom/Quaternion.ts:55

Methods

clone

clone(): Quaternion
克隆

Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:480

copy

copy(q: Quaternion): Quaternion
将源的值复制到此四元数
Parameters
- q: Quaternion
  
  要复制的四元数
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:555

equals

equals(v: Quaternion, precision?: number): boolean
与指定四元素比较是否相等。

Returns
相等返回true，否则false。
Parameters
- v: Quaternion
  
  比较的向量。
- precision: number = mathUtil.PRECISION
  
  允许误差。
Returns boolean
- Defined in src/math/geom/Quaternion.ts:671

fromArray

fromArray(array: ArrayLike<number>, offset?: number): Quaternion
Parameters
- array: ArrayLike<number>
- offset: number = 0
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:78

fromAxisAngle

fromAxisAngle(axis: Vector3, angle: number): Quaternion
用表示给定绕向量旋转的值填充四元数对象。
Parameters
- axis: Vector3
  
  要绕其旋转的轴
- angle: number
  
  以弧度为单位的旋转角度。
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:190

fromEuler

fromEuler(x: number, y: number, z: number, order?: RotationOrder): Quaternion
从欧拉角初始化四元素。

See
http://www.mathworks.com/matlabcentral/fileexchange/20696-function-to-convert-between-dcm-euler-angles-quaternions-and-euler-vectors/content/SpinCalc.m
Parameters
- x: number
  
  围绕X轴旋转角度。
- y: number
  
  围绕Y轴旋转角度。
- z: number
  
  围绕Z轴旋转角度。
- order: RotationOrder = mathUtil.DefaultRotationOrder
  
  X、Y、Z轴旋顺序。
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:604

fromMatrix

fromMatrix(matrix: Matrix4x4): Quaternion
从矩阵初始化四元素
Parameters
- matrix: Matrix4x4
  
  矩阵
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:468

fromUnitVectors

fromUnitVectors(u: Vector3, v: Vector3): Quaternion
给定两个单位向量，设置四元数值。得到的旋转将是将u旋转到v所需要的旋转。
Parameters
- u: Vector3
  
  表示起始方向的单位向量。
- v: Vector3
  
  表示终止方向的单位向量。
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:239

integrate

integrate(angularVelocity: Vector3, dt: number, angularFactor: Vector3): Quaternion
旋转一个绝对方向四元数给定一个角速度和一个时间步长
Parameters
- angularVelocity: Vector3
- dt: number
- angularFactor: Vector3
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:517

integrateTo

integrateTo(angularVelocity: Vector3, dt: number, angularFactor: Vector3, target?: Quaternion): Quaternion
旋转一个绝对方向四元数给定一个角速度和一个时间步长
Parameters
- angularVelocity: Vector3
- dt: number
- angularFactor: Vector3
- target: Quaternion = ...
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:545

inverse

inverse(): Quaternion
获取逆四元数（共轭四元数）

Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:151

inverseTo

inverseTo(target?: Quaternion): Quaternion
获取逆四元数（共轭四元数）
Parameters
- target: Quaternion = ...
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:165

lerp

lerp(qa: Quaternion, qb: Quaternion, t: number): void
线性求插值
Parameters
- qa: Quaternion
  
  第一个四元素
- qb: Quaternion
  
  第二个四元素
- t: number
  
  权重
Returns void
- Defined in src/math/geom/Quaternion.ts:367

mult

mult(q: Quaternion): Quaternion
四元数乘法
Parameters
- q: Quaternion
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:118

multTo

multTo(q: Quaternion, target?: Quaternion): Quaternion
四元数乘法
Parameters
- q: Quaternion
- target: Quaternion = ...
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:143

multiplyVector

multiplyVector(vector: Vector3, target?: Quaternion): Quaternion
Parameters
- vector: Vector3
- target: Quaternion = ...
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:170

normalize

normalize(val?: number): Quaternion
四元数归一化
Parameters
- val: number = 1
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:403

normalizeFast

normalizeFast(): Quaternion
四元数归一化的近似。当quat已经几乎标准化时，效果最好。

See
http://jsperf.com/fast-quaternion-normalization

Author
unphased, https://github.com/unphased

Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:433

random

random(): Quaternion
随机四元数

Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:91

rotatePoint

rotatePoint(point: Vector3, target?: Vector3): Vector3
旋转一个顶点
Parameters
- point: Vector3
  
  被旋转的顶点
- target: Vector3 = ...
  
  旋转结果
Returns Vector3
- Defined in src/math/geom/Quaternion.ts:491

set

set(x?: number, y?: number, z?: number, w?: number): Quaternion
设置四元数的值。
Parameters
- x: number = 0
  
  虚基向量i的乘子
- y: number = 0
  
  虚基向量j的乘子
- z: number = 0
  
  虚基向量k的乘子
- w: number = 1
  
  实部的乘数
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:68

slerp

slerp(qb: Quaternion, t: number): Quaternion
与目标四元数之间进行球面内插，提供了具有恒定角度变化率的旋转之间的内插。
Parameters
- qb: Quaternion
  
  目标四元素
- t: number
  
  插值权值，一个介于0和1之间的值。
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:281

slerpTo

slerpTo(qb: Quaternion, t: number, out?: Quaternion): Quaternion
与目标四元数之间进行球面内插，提供了具有恒定角度变化率的旋转之间的内插。
Parameters
- qb: Quaternion
  
  目标四元素
- t: number
  
  插值权值，一个介于0和1之间的值。
- out: Quaternion = ...
  
  保存插值结果
Returns Quaternion
- Defined in src/math/geom/Quaternion.ts:354

toArray

toArray(array?: number[], offset?: number): number[]
转换为数组
Parameters
- Optional array: number[]
- offset: number = 0
Returns number[]
- Defined in src/math/geom/Quaternion.ts:102

toAxisAngle

toAxisAngle(targetAxis?: Vector3): (number | Vector3)[]
将四元数转换为轴/角表示形式

Returns
一个数组，第一个元素是轴，第二个元素是弧度
Parameters
- targetAxis: Vector3 = ...
  
  要重用的向量对象，用于存储轴
Returns (number | Vector3)[]
- Defined in src/math/geom/Quaternion.ts:210

toString

toString(): string
转换为可读格式

Returns string
- Defined in src/math/geom/Quaternion.ts:458

vmult

vmult(v: Vector3, target?: Vector3): Vector3
Multiply the quaternion by a vector
Parameters
- v: Vector3
- target: Vector3 = ...
  
  Optional
Returns Vector3
- Defined in src/math/geom/Quaternion.ts:570

Class Quaternion

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

x: number = 0

y: number = 0

z: number = 0

w: number = 1

Returns Quaternion

Properties

w

x

y

z

Accessors

magnitude

Returns number

Methods

clone

Returns Quaternion

copy

Parameters

q: Quaternion

Returns Quaternion

equals

Returns

Parameters

v: Quaternion

precision: number = mathUtil.PRECISION

Returns boolean

fromArray

Parameters

array: ArrayLike<number>

offset: number = 0

Returns Quaternion

fromAxisAngle

Parameters

axis: Vector3

angle: number

Returns Quaternion

fromEuler

See

Parameters

x: number

y: number

z: number

order: RotationOrder = mathUtil.DefaultRotationOrder

Returns Quaternion

fromMatrix

Parameters

matrix: Matrix4x4

Returns Quaternion

fromUnitVectors

Parameters

u: Vector3

v: Vector3

Returns Quaternion

integrate

Parameters

angularVelocity: Vector3

dt: number

angularFactor: Vector3

Returns Quaternion

integrateTo

Parameters

angularVelocity: Vector3

dt: number

angularFactor: Vector3

target: Quaternion = ...

Returns Quaternion

inverse

Returns Quaternion

inverseTo

Parameters

`Optional` array: number[]