Class Quat

四元数

Hierarchy

ValueType
- Quat

Index

Constructors

constructor

Properties

w
x
y
z
IDENTITY

Methods

Constructors

constructor

newQuat(other: Quat): Quat
newQuat(x?: undefined | number, y?: undefined | number, z?: undefined | number, w?: undefined | number): Quat

- Defined in cocos/core/math/quat.ts:680
Parameters
- other: Quat
Returns Quat
- Defined in cocos/core/math/quat.ts:682
Parameters
- Optional x: undefined | number
- Optional y: undefined | number
- Optional z: undefined | number
- Optional w: undefined | number
Returns Quat

Properties

w

w: number

w 分量。

x

x: number

x 分量。

y

y: number

y 分量。

z

z: number

z 分量。

Static IDENTITY

IDENTITY: {} = Object.freeze(new Quat())

Type declaration

Methods

clone

clone(): Quat

Overrides ValueType.clone
- Defined in cocos/core/math/quat.ts:705
克隆当前四元数。

Returns Quat

equals

equals(other: Quat, epsilon?: number): boolean

Overrides ValueType.equals
- Defined in cocos/core/math/quat.ts:746
判断当前四元数是否在误差范围内与指定向量相等。

Parameters
- other: Quat
  
  Comparative quaternion
- Default value epsilon: number = EPSILON
  
  The error allowed. It`s should be a non-negative number.
Returns boolean

Returns true' when the components of the two quaternions are equal within the specified error range; otherwise, returnsfalse'.

getEulerAngles

getEulerAngles(out: Vec3): IVec3Like

- Defined in cocos/core/math/quat.ts:768
将当前四元数转化为欧拉角（x-y-z）并赋值给出口向量。

Parameters
- out: Vec3
  
  the output vector
Returns IVec3Like

length

length(): number

- Defined in cocos/core/math/quat.ts:800
求四元数长度

Returns number

lengthSqr

lengthSqr(): number

- Defined in cocos/core/math/quat.ts:808
求四元数长度平方

Returns number

lerp

lerp(to: Quat, ratio: number): this

- Defined in cocos/core/math/quat.ts:778
根据指定的插值比率，从当前四元数到目标四元数之间做线性插值。

Parameters
- to: Quat
  
  The target quaternion
- ratio: number
  
  The interpolation coefficient. The range is [0,1].
Returns this

set

set(other: Quat): Quat
set(x?: undefined | number, y?: undefined | number, z?: undefined | number, w?: undefined | number): Quat

Overrides ValueType.set
- Defined in cocos/core/math/quat.ts:715
设置当前四元数使其与指定四元数相等。

Parameters
- other: Quat
  
  Specified quaternion
Returns Quat

this
Overrides ValueType.set
- Defined in cocos/core/math/quat.ts:722
设置当前四元数指定元素值。

Parameters
- Optional x: undefined | number
- Optional y: undefined | number
- Optional z: undefined | number
- Optional w: undefined | number
Returns Quat

this

slerp

slerp(to: Quat, ratio: number): this

- Defined in cocos/core/math/quat.ts:792
根据指定的插值比率，从当前四元数到目标四元数之间做球面插值。

Parameters
- to: Quat
  
  The target quaternion
- ratio: number
  
  The interpolation coefficient. The range is [0,1].
Returns this

strictEquals

strictEquals(other: Quat): boolean

- Defined in cocos/core/math/quat.ts:759
判断当前四元数是否与指定四元数相等。

Parameters
- other: Quat
  
  Comparative quaternion
Returns boolean

Returns true' when the components of the two quaternions are equal within the specified error range; otherwise, returnsfalse'.

toString

toString(): string

Inherited from ValueType.toString
- Defined in cocos/core/value-types/value-type.ts:95
返回当前值的字符串表示。本方法的基类版本返回空字符串。

Returns string

The string representation of the current object

Static calculateW

calculateW<Out>(out: Out, a: Out): Out

- Defined in cocos/core/math/quat.ts:273
根据 xyz 分量计算 w 分量，默认已归一化

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
Returns Out

Static clone

clone<Out>(a: Out): Quat

- Defined in cocos/core/math/quat.ts:51
获得指定四元数的拷贝

Type parameters
- Out: IQuatLike
Parameters
- a: Out
Returns Quat

Static conjugate

conjugate<Out>(out: Out, a: Out): Out

- Defined in cocos/core/math/quat.ts:382
求共轭四元数，对单位四元数与求逆等价，但更高效

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
Returns Out

Static copy

copy<Out, QuatLike>(out: Out, a: QuatLike): Out

- Defined in cocos/core/math/quat.ts:59
复制目标四元数

Type parameters
- Out: IQuatLike
- QuatLike: IQuatLike
Parameters
- out: Out
- a: QuatLike
Returns Out

Static dot

dot<Out>(a: Out, b: Out): number

- Defined in cocos/core/math/quat.ts:286
四元数点积（数量积）

Type parameters
- Out: IQuatLike
Parameters
- a: Out
- b: Out
Returns number

Static equals

equals(a: IQuatLike, b: IQuatLike, epsilon?: number): boolean

- Defined in cocos/core/math/quat.ts:651
排除浮点数误差的四元数近似等价判断

Parameters
- a: IQuatLike
- b: IQuatLike
- Default value epsilon: number = EPSILON
Returns boolean

Static fromArray

fromArray(out: IQuatLike, arr: IWritableArrayLike<number>, ofs?: number): IQuatLike

- Defined in cocos/core/math/quat.ts:631
数组转四元数

Parameters
- out: IQuatLike
- arr: IWritableArrayLike<number>
- Default value ofs: number = 0
  
  Array Start Offset
Returns IQuatLike

Static fromAxes

fromAxes<Out, VecLike>(out: Out, xAxis: VecLike, yAxis: VecLike, zAxis: VecLike): Out

- Defined in cocos/core/math/quat.ts:426
根据本地坐标轴朝向计算四元数，默认三向量都已归一化且相互垂直

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- xAxis: VecLike
- yAxis: VecLike
- zAxis: VecLike
Returns Out

Static fromAxisAngle

fromAxisAngle<Out, VecLike>(out: Out, axis: VecLike, rad: number): Out

- Defined in cocos/core/math/quat.ts:450
根据旋转轴和旋转弧度计算四元数

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- axis: VecLike
- rad: number
Returns Out

Static fromEuler

fromEuler<Out>(out: Out, x: number, y: number, z: number): Out

- Defined in cocos/core/math/quat.ts:513
根据欧拉角信息计算四元数，旋转顺序为 YZX

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- x: number
- y: number
- z: number
Returns Out

Static fromMat3

fromMat3<Out>(out: Out, m: Mat3): Out

- Defined in cocos/core/math/quat.ts:464
根据三维矩阵信息计算四元数，默认输入矩阵不含有缩放信息

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- m: Mat3
Returns Out

Static fromViewUp

fromViewUp<Out, VecLike>(out: Out, view: VecLike, up?: Vec3): Out

- Defined in cocos/core/math/quat.ts:441
根据视口的前方向和上方向计算四元数

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- view: VecLike
  
  The view direction, it`s must be normalized.
- Optional up: Vec3
  
  The view up direction, it`s must be normalized, default value is (0, 1, 0).
Returns Out

Static getAxisAngle

getAxisAngle<Out, VecLike>(outAxis: VecLike, q: Out): number

- Defined in cocos/core/math/quat.ts:128
获取四元数的旋转轴和旋转弧度

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- outAxis: VecLike
  
  output axis
- q: Out
  
  input quaternion
Returns number

radius of rotation

Static identity

identity<Out>(out: Out): Out

- Defined in cocos/core/math/quat.ts:83
将目标赋值为单位四元数

Type parameters
- Out: IQuatLike
Parameters
- out: Out
Returns Out

Static invert

invert<Out, QuatLike>(out: Out, a: QuatLike): Out

- Defined in cocos/core/math/quat.ts:365
四元数求逆

Type parameters
- Out: IQuatLike
- QuatLike: IQuatLike
Parameters
- out: Out
- a: QuatLike
Returns Out

Static len

len<Out>(a: Out): number

- Defined in cocos/core/math/quat.ts:394
求四元数长度

Type parameters
- Out: IQuatLike
Parameters
- a: Out
Returns number

Static lengthSqr

lengthSqr<Out>(a: Out): number

- Defined in cocos/core/math/quat.ts:402
求四元数长度平方

Type parameters
- Out: IQuatLike
Parameters
- a: Out
Returns number

Static lerp

lerp<Out>(out: Out, a: Out, b: Out, t: number): Out

- Defined in cocos/core/math/quat.ts:294
逐元素线性插值： A + t * (B - A)

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- b: Out
- t: number
Returns Out

Static multiply

multiply<Out, QuatLike_1, QuatLike_2>(out: Out, a: QuatLike_1, b: QuatLike_2): Out

- Defined in cocos/core/math/quat.ts:148
四元数乘法

Type parameters
- Out: IQuatLike
- QuatLike_1: IQuatLike
- QuatLike_2: IQuatLike
Parameters
- out: Out
- a: QuatLike_1
- b: QuatLike_2
Returns Out

Static multiplyScalar

multiplyScalar<Out>(out: Out, a: Out, b: number): Out

- Defined in cocos/core/math/quat.ts:164
四元数标量乘法

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- b: number
Returns Out

Static normalize

normalize<Out>(out: Out, a: Out): Out

- Defined in cocos/core/math/quat.ts:410
归一化四元数

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
Returns Out

Static rotateAround

rotateAround<Out, VecLike>(out: Out, rot: Out, axis: VecLike, rad: number): Out

- Defined in cocos/core/math/quat.ts:247
绕世界空间下指定轴旋转四元数

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- rot: Out
- axis: VecLike
  
  axis of rotation, normalized by default
- rad: number
  
  radius of rotation
Returns Out

Static rotateAroundLocal

rotateAroundLocal<Out, VecLike>(out: Out, rot: Out, axis: VecLike, rad: number): Out

- Defined in cocos/core/math/quat.ts:263
绕本地空间下指定轴旋转四元数

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- rot: Out
- axis: VecLike
  
  axis of rotation
- rad: number
  
  radius of rotation
Returns Out

Static rotateX

rotateX<Out>(out: Out, a: Out, rad: number): Out

- Defined in cocos/core/math/quat.ts:189
绕 X 轴旋转指定四元数

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- rad: number
  
  radius of rotation
Returns Out

Static rotateY

rotateY<Out>(out: Out, a: Out, rad: number): Out

- Defined in cocos/core/math/quat.ts:208
绕 Y 轴旋转指定四元数

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- rad: number
  
  radius of rotation
Returns Out

Static rotateZ

rotateZ<Out>(out: Out, a: Out, rad: number): Out

- Defined in cocos/core/math/quat.ts:227
绕 Z 轴旋转指定四元数

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- rad: number
  
  radius of rotation
Returns Out

Static rotationTo

rotationTo<Out, VecLike>(out: Out, a: VecLike, b: VecLike): Out

- Defined in cocos/core/math/quat.ts:95
设置四元数为两向量间的最短路径旋转，默认两向量都已归一化

Type parameters
- Out: IQuatLike
- VecLike: IVec3Like
Parameters
- out: Out
- a: VecLike
- b: VecLike
Returns Out

Static scaleAndAdd

scaleAndAdd<Out>(out: Out, a: Out, b: Out, scale: number): Out

- Defined in cocos/core/math/quat.ts:176
四元数乘加：A + B * scale

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- b: Out
- scale: number
Returns Out

Static set

set<Out>(out: Out, x: number, y: number, z: number, w: number): Out

- Defined in cocos/core/math/quat.ts:71
设置四元数值

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- x: number
- y: number
- z: number
- w: number
Returns Out

Static slerp

slerp<Out, QuatLike_1, QuatLike_2>(out: Out, a: QuatLike_1, b: QuatLike_2, t: number): Out

- Defined in cocos/core/math/quat.ts:306
四元数球面插值

Type parameters
- Out: IQuatLike
- QuatLike_1: IQuatLike
- QuatLike_2: IQuatLike
Parameters
- out: Out
- a: QuatLike_1
- b: QuatLike_2
- t: number
Returns Out

Static sqlerp

sqlerp<Out>(out: Out, a: Out, b: Out, c: Out, d: Out, t: number): Out

- Defined in cocos/core/math/quat.ts:354
带两个控制点的四元数球面插值

Type parameters
- Out: IQuatLike
Parameters
- out: Out
- a: Out
- b: Out
- c: Out
- d: Out
- t: number
Returns Out

Static strictEquals

strictEquals(a: IQuatLike, b: IQuatLike): boolean

- Defined in cocos/core/math/quat.ts:643
四元数等价判断

Parameters
- a: IQuatLike
- b: IQuatLike
Returns boolean

Static toArray

toArray<Out>(out: Out, q: IQuatLike, ofs?: number): Out

- Defined in cocos/core/math/quat.ts:618
四元数转数组

Type parameters
- Out: IWritableArrayLike<number>
Parameters
- out: Out
- q: IQuatLike
- Default value ofs: number = 0
  
  Array Start Offset
Returns Out

Static toAxisX

toAxisX(out: IVec3Like, q: IQuatLike): IVec3Like

- Defined in cocos/core/math/quat.ts:537
返回定义此四元数的坐标系 X 轴向量

Parameters
- out: IVec3Like
- q: IQuatLike
Returns IVec3Like

Static toAxisY

toAxisY(out: IVec3Like, q: IQuatLike): IVec3Like

- Defined in cocos/core/math/quat.ts:551
返回定义此四元数的坐标系 Y 轴向量

Parameters
- out: IVec3Like
- q: IQuatLike
Returns IVec3Like

Static toAxisZ

toAxisZ(out: IVec3Like, q: IQuatLike): IVec3Like

- Defined in cocos/core/math/quat.ts:566
返回定义此四元数的坐标系 Z 轴向量

Parameters
- out: IVec3Like
- q: IQuatLike
Returns IVec3Like

Static toEuler

toEuler(out: IVec3Like, q: IQuatLike, outerZ?: undefined | false | true): IVec3Like

- Defined in cocos/core/math/quat.ts:582
根据四元数计算欧拉角，返回角度 x, y 在 [-180, 180] 区间内, z 默认在 [-90, 90] 区间内，旋转顺序为 YZX

Parameters
- out: IVec3Like
- q: IQuatLike
- Optional outerZ: undefined | false | true
  
  change z value range to [-180, -90] U [90, 180]
Returns IVec3Like

Generated using TypeDoc