Class Quaternion

constructor

• new Quaternion(x?, y?, z?, w?): Quaternion

• 四元数描述三维空间中的旋转。四元数的数学定义为Q = xi + yj + z*k + w，其中(i,j,k)为虚基向量。(x,y,z)可以看作是一个与旋转轴相关的向量，而实际的乘法器w与旋转量相关。

  Parameters

  • Optional x: number

    虚基向量i的乘子

  • Optional y: number

    虚基向量j的乘子

  • Optional z: number

    虚基向量k的乘子

  • Optional w: number

    实部的乘数

  Returns Quaternion

w

x

y

z

magnitude

• get magnitude(): number

• 返回四元数对象的大小

  Returns number

clone

• clone(): Quaternion

• 克隆

  Returns Quaternion

copy

• copy(q): Quaternion

• 将源的值复制到此四元数

  Parameters

  • q: Quaternion

    要复制的四元数

  Returns Quaternion

equals

• equals(v, precision?): boolean

• 与指定四元素比较是否相等。

  Parameters

  • v: Quaternion

    比较的向量。

  • Optional precision: number

    允许误差。

  Returns boolean

  相等返回true，否则false。

fromArray

• fromArray(array, offset?): Quaternion

• Parameters

  • array: ArrayLike<number>

  • Optional offset: number

  Returns Quaternion

fromAxisAngle

• fromAxisAngle(axis, angle): Quaternion

• 用表示给定绕向量旋转的值填充四元数对象。

  Parameters

  • axis: Vector3

    要绕其旋转的轴

  • angle: number

    以弧度为单位的旋转角度。

  Returns Quaternion

fromEuler

• fromEuler(x, y, z, order?): Quaternion

• 从欧拉角初始化四元素。

  Parameters

  • x: number

    围绕X轴旋转角度。

  • y: number

    围绕Y轴旋转角度。

  • z: number

    围绕Z轴旋转角度。

  • Optional order: RotationOrder

    X、Y、Z轴旋顺序。

  Returns Quaternion

  See

  http://www.mathworks.com/matlabcentral/fileexchange/20696-function-to-convert-between-dcm-euler-angles-quaternions-and-euler-vectors/content/SpinCalc.m

fromMatrix

• fromMatrix(matrix): Quaternion

• 从矩阵初始化四元素

  Parameters

  • matrix: Matrix4x4

    矩阵

  Returns Quaternion

fromUnitVectors

• fromUnitVectors(u, v): Quaternion

• 给定两个单位向量，设置四元数值。得到的旋转将是将u旋转到v所需要的旋转。

  Parameters

  • u: Vector3

    表示起始方向的单位向量。

  • v: Vector3

    表示终止方向的单位向量。

  Returns Quaternion

integrate

• integrate(angularVelocity, dt, angularFactor): Quaternion

• 旋转一个绝对方向四元数给定一个角速度和一个时间步长

  Parameters

  • angularVelocity: Vector3

  • dt: number

  • angularFactor: Vector3

  Returns Quaternion

integrateTo

• integrateTo(angularVelocity, dt, angularFactor, target?): Quaternion

• 旋转一个绝对方向四元数给定一个角速度和一个时间步长

  Parameters

  • angularVelocity: Vector3

  • dt: number

  • angularFactor: Vector3

  • Optional target: Quaternion

  Returns Quaternion

inverse

• inverse(): Quaternion

• 获取逆四元数（共轭四元数）

  Returns Quaternion

inverseTo

• inverseTo(target?): Quaternion

• 获取逆四元数（共轭四元数）

  Parameters

  • Optional target: Quaternion

  Returns Quaternion

lerp

• lerp(qa, qb, t): void

• 线性求插值

  Parameters

  • qa: Quaternion

    第一个四元素

  • qb: Quaternion

    第二个四元素

  • t: number

    权重

  Returns void

mult

• mult(q): Quaternion

• 四元数乘法

  Parameters

  • q: Quaternion

  Returns Quaternion

multTo

• multTo(q, target?): Quaternion

• 四元数乘法

  Parameters

  • q: Quaternion

  • Optional target: Quaternion

  Returns Quaternion

multiplyVector

• multiplyVector(vector, target?): Quaternion

• Parameters

  • vector: Vector3

  • Optional target: Quaternion

  Returns Quaternion

normalize

• normalize(val?): Quaternion

• 四元数归一化

  Parameters

  • Optional val: number

  Returns Quaternion

normalizeFast

• normalizeFast(): Quaternion

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

  Returns Quaternion

  See

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

  Author

  unphased, https://github.com/unphased

random

• random(): Quaternion

• 随机四元数

  Returns Quaternion

rotatePoint

• rotatePoint(point, target?): Vector3

• 旋转一个顶点

  Parameters

  • point: Vector3

    被旋转的顶点

  • Optional target: Vector3

    旋转结果

  Returns Vector3

set

• set(x?, y?, z?, w?): Quaternion

• 设置四元数的值。

  Parameters

  • Optional x: number

    虚基向量i的乘子

  • Optional y: number

    虚基向量j的乘子

  • Optional z: number

    虚基向量k的乘子

  • Optional w: number

    实部的乘数

  Returns Quaternion

slerp

• slerp(qb, t): Quaternion

• 与目标四元数之间进行球面内插，提供了具有恒定角度变化率的旋转之间的内插。

  Parameters

  • qb: Quaternion

    目标四元素

  • t: number

    插值权值，一个介于0和1之间的值。

  Returns Quaternion

slerpTo

• slerpTo(qb, t, out?): Quaternion

• 与目标四元数之间进行球面内插，提供了具有恒定角度变化率的旋转之间的内插。

  Parameters

  • qb: Quaternion

    目标四元素

  • t: number

    插值权值，一个介于0和1之间的值。

  • Optional out: Quaternion

    保存插值结果

  Returns Quaternion

toArray

• toArray(array?, offset?): number[]

• 转换为数组

  Parameters

  • Optional array: number[]

  • Optional offset: number

  Returns number[]

toAxisAngle

• toAxisAngle(targetAxis?): (number | Vector3)[]

• 将四元数转换为轴/角表示形式

  Parameters

  • Optional targetAxis: Vector3

    要重用的向量对象，用于存储轴

  Returns (number | Vector3)[]

  一个数组，第一个元素是轴，第二个元素是弧度

toString

• toString(): string

• 转换为可读格式

  Returns string

vmult

• vmult(v, target?): Vector3

• Multiply the quaternion by a vector

  Parameters

  • v: Vector3

  • Optional target: Vector3

    Optional

  Returns Vector3