Options
All
• Public
• Public/Protected
• All

# Class Quat

## Constructors

### constructor

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

## Properties

w: number

w 分量。

x: number

x 分量。

y: number

y 分量。

z: number

z 分量。

### Static IDENTITY

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

## Methods

### equals

• equals(other: Quat, epsilon?: number): boolean
• 判断当前四元数是否在误差范围内与指定向量相等。

#### 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, returns`false'.

### getEulerAngles

• 将当前四元数转化为欧拉角（x-y-z）并赋值给出口向量。

#### Parameters

• ##### out: Vec3

the output vector

### length

• length(): number

### lengthSqr

• lengthSqr(): number

### lerp

• lerp(to: Quat, ratio: number): this
• 根据指定的插值比率，从当前四元数到目标四元数之间做线性插值。

#### Parameters

• ##### to: Quat

The target quaternion

• ##### ratio: number

The interpolation coefficient. The range is [0,1].

### set

• set(other: Quat): Quat
• set(x?: undefined | number, y?: undefined | number, z?: undefined | number, w?: undefined | number): Quat
• 设置当前四元数使其与指定四元数相等。

#### Parameters

• ##### other: Quat

Specified quaternion

#### Returns Quat

`this`

• 设置当前四元数指定元素值。

#### Returns Quat

`this`

### slerp

• slerp(to: Quat, ratio: number): this
• 根据指定的插值比率，从当前四元数到目标四元数之间做球面插值。

#### Parameters

• ##### to: Quat

The target quaternion

• ##### ratio: number

The interpolation coefficient. The range is [0,1].

### strictEquals

• strictEquals(other: Quat): boolean
• 判断当前四元数是否与指定四元数相等。

#### Parameters

• ##### other: Quat

Comparative quaternion

#### Returns boolean

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

### toString

• toString(): string

### Static calculateW

• calculateW<Out>(out: Out, a: Out): Out
• 根据 xyz 分量计算 w 分量，默认已归一化

### Static clone

• clone<Out>(a: Out): Quat
• 获得指定四元数的拷贝

### Static conjugate

• conjugate<Out>(out: Out, a: Out): Out
• 求共轭四元数，对单位四元数与求逆等价，但更高效

### Static copy

• copy<Out, QuatLike>(out: Out, a: QuatLike): Out
• 复制目标四元数

### Static dot

• dot<Out>(a: Out, b: Out): number
• 四元数点积（数量积）

### Static equals

• 排除浮点数误差的四元数近似等价判断

### Static fromAngleZ

• fromAngleZ<Out>(out: Out, z: number): Out
• 根据 2D 角度（0, 0, z）计算四元数

#### Parameters

• ##### out: Out

Output quaternion

• ##### z: number

Angle to rotate around Z axis in degrees.

### Static fromArray

• 数组转四元数

#### Parameters

• ##### Default value ofs: number = 0

Array Start Offset

### Static fromAxes

• fromAxes<Out, VecLike>