Class Quaternion

Hierarchy

Quaternion

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

- Defined in glb/dist/math/Quaternion.d.ts:29
四元数 [xsin(θ/2), ysin(θ/2), z*sin(θ/2), cos(θ/2)]

Parameters
- Optional x: number
  
  x分量，默认为0
- Optional y: number
  
  y分量，默认为0
- Optional z: number
  
  z分量，默认为0
- Optional w: number
  
  分量，默认为1
Returns Quaternion

Properties

Protected _w

_w: number

Protected _x

_x: number

Protected _y

_y: number

Protected _z

_z: number

Accessors

isQuaternion

get isQuaternion(): boolean

- Defined in glb/dist/math/Quaternion.d.ts:30
Returns boolean

w

get w(): number
set w(value: number): void

- Defined in glb/dist/math/Quaternion.d.ts:16
Returns number
- Defined in glb/dist/math/Quaternion.d.ts:17
Parameters
- value: number
Returns void

x

get x(): number
set x(value: number): void

- Defined in glb/dist/math/Quaternion.d.ts:7
Returns number
- Defined in glb/dist/math/Quaternion.d.ts:8
Parameters
- value: number
Returns void

y

get y(): number
set y(value: number): void

- Defined in glb/dist/math/Quaternion.d.ts:10
Returns number
- Defined in glb/dist/math/Quaternion.d.ts:11
Parameters
- value: number
Returns void

z

get z(): number
set z(value: number): void

- Defined in glb/dist/math/Quaternion.d.ts:13
Returns number
- Defined in glb/dist/math/Quaternion.d.ts:14
Parameters
- value: number
Returns void

Methods

add

add(a: Quaternion, b?: Quaternion): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:93
四元数相加

Parameters
- a: Quaternion
- Optional b: Quaternion
  
  若b未传入，则计算this + a
Returns Quaternion

angleTo

angleTo(b: Quaternion): number

- Defined in glb/dist/math/Quaternion.d.ts:105
计算this与b直接的角度差（以弧度值返回）

Parameters
- b: Quaternion
Returns number
若this或b有一个无法转单位四元数，则返回null

clone

clone(): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:56
克隆

Returns Quaternion

conjugate

conjugate(): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:70
共轭

Returns Quaternion

copy

copy(target: Quaternion): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:52
复制

Parameters
- target: Quaternion
  
  被复制的四元数
Returns Quaternion

dot

dot(b: Quaternion): number

- Defined in glb/dist/math/Quaternion.d.ts:83
点积: 计算this·b

Parameters
- b: Quaternion
Returns number

identity

identity(): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:66
单位四元数

Returns Quaternion

invert

invert(): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:109
取逆

Returns Quaternion

isEqual

isEqual(target: Quaternion): boolean

- Defined in glb/dist/math/Quaternion.d.ts:62
判等

Parameters
- target: Quaternion
  
  被比较的Quaternion
Returns boolean
是否相等，相等返回true，否则返回false

length

length(): number

- Defined in glb/dist/math/Quaternion.d.ts:74
长度

Returns number

multiply

multiply(a: Quaternion, b?: Quaternion): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:99
四元数相乘

Parameters
- a: Quaternion
  
  左乘数
- Optional b: Quaternion
  
  右乘数，若不传，则计算this = this x a，传则计算this = a x b
Returns Quaternion

normalize

normalize(): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:87
归一化

Returns Quaternion

set

set(x: number, y: number, z: number, w: number): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:21
更新赋值

Parameters
- x: number
- y: number
- z: number
- w: number
Returns Quaternion

setFromAxisRadian

setFromAxisRadian(axis: Vector3, rad: number): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:47
根据指定旋转轴和旋转弧度值设置四元数

Parameters
- axis: Vector3
  
  旋转轴
- rad: number
  
  旋转弧度值
Returns Quaternion

setFromEuler

setFromEuler(x: number, y: number, z: number, order: EulerOrder): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:124
根据欧拉角设置四元数

memberof
Quaternion

Parameters
- x: number
  
  roll 角度
- y: number
  
  pitch 角度
- z: number
  
  yaw 角度
- order: EulerOrder
  
  旋转执行顺序
Returns Quaternion

setFromMatrix3

setFromMatrix3(m: Matrix3): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:35
根据3x3矩阵生成四元数

Parameters
- m: Matrix3
  
  旋转矩阵
Returns Quaternion

setFromMatrix4

setFromMatrix4(m: Matrix4): Quaternion

- Defined in glb/dist/math/Quaternion.d.ts:40
从4x4矩阵中生成四元数

Parameters
- m: Matrix4
  
  4x4矩阵
Returns Quaternion

squaredLength

squaredLength(): number

- Defined in glb/dist/math/Quaternion.d.ts:78
平方长度

Returns number

toArrays

toArrays(): number[]

- Defined in glb/dist/math/Quaternion.d.ts:113
转为数组[this.x, this.y, this.z, this.w]

Returns number[]

toEuler

toEuler(): number[]

- Defined in glb/dist/math/Quaternion.d.ts:125
Returns number[]

toYawPitchRoll

toYawPitchRoll(): number[]

- Defined in glb/dist/math/Quaternion.d.ts:131
Get the euler of this quaternion.

Returns number[]
Euler x->yaw y->pitch z->roll

Generated using TypeDoc