Class Quaternion

Hierarchy

Quaternion

Index

Constructors

constructor

Properties

DEFAULT

Accessors

w
x
y
z

Constructors

constructor

new Quaternion(raw?: Float32Array, offset?: number): Quaternion

- Defined in src/engine/math/quaternion.ts:88
Parameters
- Optional raw: Float32Array
- Optional offset: number
Returns Quaternion

Properties

Static Readonly DEFAULT

DEFAULT: DeepImmutableObject<Quaternion>

默认四元数，不要对该对象进行修改

readonly
static
memberof: Quaternion

Accessors

w

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

- Defined in src/engine/math/quaternion.ts:67
w值

memberof

Quaternion

Returns number
- Defined in src/engine/math/quaternion.ts:70
w值

Parameters
- val: number
Returns void

x

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

- Defined in src/engine/math/quaternion.ts:28
x值

memberof

Quaternion

Returns number
- Defined in src/engine/math/quaternion.ts:31
x值

Parameters
- val: number
Returns void

y

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

- Defined in src/engine/math/quaternion.ts:41
y值

memberof

Quaternion

Returns number
- Defined in src/engine/math/quaternion.ts:44
y值

Parameters
- val: number
Returns void

z

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

- Defined in src/engine/math/quaternion.ts:54
z值

memberof

Quaternion

Returns number
- Defined in src/engine/math/quaternion.ts:57
z值

Parameters
- val: number
Returns void

Methods

add

add(quat: DeepImmutableObject<Quaternion>, dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:279
四元数相加

memberof

Quaternion

Parameters
- quat: DeepImmutableObject<Quaternion>
  
  目标四元数
- Optional dst: Quaternion
Returns Quaternion

计算结果

angleTo

angleTo(q: DeepImmutableObject<Quaternion>): number

- Defined in src/engine/math/quaternion.ts:376
相对角度

Parameters
- q: DeepImmutableObject<Quaternion>
Returns number

clone

clone(): Quaternion

- Defined in src/engine/math/quaternion.ts:399
拷贝四元数

memberof

Quaternion

Returns Quaternion

拷贝后的对象

dot

dot(q: DeepImmutableObject<Quaternion>): number

- Defined in src/engine/math/quaternion.ts:321
点乘

Parameters
- q: DeepImmutableObject<Quaternion>
Returns number

equal

equal(quat: DeepImmutableObject<Quaternion>): boolean

- Defined in src/engine/math/quaternion.ts:436
判断与目标四元数的值是否相等

memberof

Quaternion

Parameters
- quat: DeepImmutableObject<Quaternion>
  
  目标四元数
Returns boolean

fromPhysics

fromPhysics(v: RawQuaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:448
Parameters
- v: RawQuaternion
Returns Quaternion

invert

invert(dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:266
四元数反转

memberof

Quaternion

Parameters
- Optional dst: Quaternion
Returns Quaternion

计算结果

isDefault

isDefault(): boolean

- Defined in src/engine/math/quaternion.ts:411
四元数是否为默认四元数（表示零旋转）

memberof

Quaternion

Returns boolean

length

length(): number

- Defined in src/engine/math/quaternion.ts:325
Returns number

multiply

multiply(quat: DeepImmutableObject<Quaternion>, dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:305
四元数相乘

memberof

Quaternion

Parameters
- quat: DeepImmutableObject<Quaternion>
  
  目标四元数
- Optional dst: Quaternion
Returns Quaternion

计算结果

normalize

normalize(): Quaternion

- Defined in src/engine/math/quaternion.ts:329
Returns Quaternion

premultiply

premultiply(q: DeepImmutableObject<Quaternion>): Quaternion

- Defined in src/engine/math/quaternion.ts:311
Parameters
- q: DeepImmutableObject<Quaternion>
Returns Quaternion

rotateTowards

rotateTowards(q: any, step: any): Quaternion

- Defined in src/engine/math/quaternion.ts:386
转向对应的角度

Parameters
- q: any
- step: any
Returns Quaternion

set

set(quat: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:222
拷贝目标四元数的值到自身

memberof

Quaternion

Parameters
- quat: Quaternion
  
  目标四元数
Returns Quaternion

自身

setFromUnitVectors

setFromUnitVectors(vFrom: any, vTo: any): Quaternion

- Defined in src/engine/math/quaternion.ts:346
Parameters
- vFrom: any
- vTo: any
Returns Quaternion

setValue

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

- Defined in src/engine/math/quaternion.ts:236
设置四元数的值

memberof

Quaternion

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

自身

slerp

slerp(right: DeepImmutableObject<Quaternion>, t: number, dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:253
球面插值

memberof

Quaternion

Parameters
- right: DeepImmutableObject<Quaternion>
  
  目标四元数
- t: number
  
  插值系数，越接近 1 则结果越接近目标
- Optional dst: Quaternion
Returns Quaternion

计算结果

sub

sub(quat: DeepImmutableObject<Quaternion>, dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:292
四元数相减

memberof

Quaternion

Parameters
- quat: DeepImmutableObject<Quaternion>
  
  目标四元数
- Optional dst: Quaternion
Returns Quaternion

计算结果

toEulerAngles

toEulerAngles(dst?: Vector3): Vector3

- Defined in src/engine/math/quaternion.ts:423
将该四元数转换成欧拉角，x代表Pitch,y代表Yaw,z代表Roll
旋转的顺序为YXZ

memberof

Quaternion

Parameters
- Optional dst: Vector3
Returns Vector3

计算结果

toPhysics

toPhysics(): RawQuaternion

- Defined in src/engine/math/quaternion.ts:467
created by shanexyzhou
生成物理引擎内的RawQuaternion

Returns RawQuaternion

Static clearPhysicsPool

clearPhysicsPool(): void

- Defined in src/engine/math/quaternion.ts:457
Returns void

Static createFromArray

createFromArray(array: number[]): Quaternion

- Defined in src/engine/math/quaternion.ts:181
使用一个数组创建
此操作会拷贝一份数组

static

memberof

Quaternion

Parameters
- array: number[]
  
  数据源，长度必须为4，否则会抛出异常
Returns Quaternion

Static createFromAxisAngle

createFromAxisAngle(axis: DeepImmutableObject<Vector3>, rad: number, dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:131
从轴向旋转创建

static

memberof

Quaternion

Parameters
- axis: DeepImmutableObject<Vector3>
  
  旋转轴
- rad: number
  
  旋转幅度
- Optional dst: Quaternion
Returns Quaternion

计算结果

Static createFromMatrix4

createFromMatrix4(mat: DeepImmutableObject<Matrix4>, dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:116
从旋转矩阵创建

static

memberof

Quaternion

Parameters
- mat: DeepImmutableObject<Matrix4>
- Optional dst: Quaternion
Returns Quaternion

Static createFromNumber

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

- Defined in src/engine/math/quaternion.ts:164
使用数值创建

static

memberof

Quaternion

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

创建出来的四元数

Static createFromTypedArray

createFromTypedArray(array: Float32Array, offset?: number): Quaternion

- Defined in src/engine/math/quaternion.ts:197
使用某个已有的typedArray创建
此操作不会拷贝数据，而是在原来的内存区域上操作

static

memberof

Quaternion

Parameters
- array: Float32Array
  
  数据源
- offset: number = 0
Returns Quaternion

Static createFromUnitVectors

createFromUnitVectors(vFrom: Vector3, vTo: Vector3): Quaternion

- Defined in src/engine/math/quaternion.ts:210
通过俩个向量创建四元数

Parameters
- vFrom: Vector3
- vTo: Vector3
Returns Quaternion

Static fromEulerAngles

fromEulerAngles(euler: DeepImmutableObject<Vector3>, dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:101
从欧拉角创建四元数

static

memberof

Quaternion

Parameters
- euler: DeepImmutableObject<Vector3>
  
  欧拉角，x代表pitch，y代表yaw，z代表roll
- Optional dst: Quaternion
Returns Quaternion

Static fromPhysics

fromPhysics(v: RawQuaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:444
created by shanexyzhou
从物理引擎内的RawQuaternion生成Quaternion

Parameters
- v: RawQuaternion
Returns Quaternion

Static lookRotation

lookRotation(forward: DeepImmutableObject<Vector3>, up: DeepImmutableObject<Vector3>, dst?: Quaternion): Quaternion

- Defined in src/engine/math/quaternion.ts:147
由视角方向创建四元数

static

memberof

Quaternion

Parameters
- forward: DeepImmutableObject<Vector3>
  
  前方向
- up: DeepImmutableObject<Vector3>
  
  上方向
- Optional dst: Quaternion
Returns Quaternion

计算结果

Generated using TypeDoc