类 Quaternion

En

The Quaternion class is used to create quaternions.

Zh

Quaternion 类用于创建四元数。

实现

IClone

构造函数

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion
参数
- x: number = 0
  The x value of the quaternion. Default is 0.
- y: number = 0
  The y value of the quaternion. Default is 0.
- z: number = 0
  The z value of the quaternion. Default is 0.
- w: number = 1
  The w value of the quaternion. Default is 1.
返回 Quaternion
En
Constructor method, initializes the default value.

Zh
构造方法,初始化为默认值。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:347

属性

w

w: number

En

W-axis coordinate.

Zh

W轴坐标。

x

x: number

En

X-axis coordinate.

Zh

X轴坐标。

y

y: number

En

Y-axis coordinate.

Zh

Y轴坐标。

z

z: number

En

Z-axis coordinate.

Zh

Z轴坐标。

`静态` `只读`DEFAULT

DEFAULT: Readonly<Quaternion> = ...

En

Default quaternion, read-only.

Zh

默认四元数，只读。

`静态` `只读`NAN

NAN: Readonly<Quaternion> = ...

En

Invalid quaternion, read-only.

Zh

无效四元数，只读。

方法

clone

clone(): any
返回 any
A new quaternion with the same values as this one.

En
Clone the quaternion.

Zh
克隆四元数。
实现了 IClone.clone
- 定义于 src/layaAir/laya/maths/Quaternion.ts:605

cloneTo

cloneTo(destObject: Quaternion): void
参数
- destObject: Quaternion
  The destination object.
返回 void
En
Clone the quaternion to a destination object.

Zh
克隆四元数到目标对象。
实现了 IClone.cloneTo
- 定义于 src/layaAir/laya/maths/Quaternion.ts:589

equals

equals(b: Quaternion): boolean
参数
- b: Quaternion
  The quaternion to compare with.
返回 boolean
En
Determines if two quaternions are equal.

Zh
如果四元数相等则返回true，否则返回false。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:617

fromArray

fromArray(array: any[], offset?: number): void
参数
- array: any[]
  The source array.
- offset: number = 0
  The start offset in the array. Default is 0.
返回 void
En
Copy values from an array.

Zh
从数组中拷贝值。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:576

getYawPitchRoll

getYawPitchRoll(out: Vector3): void
参数
- out: Vector3
  The output Vector3 to store the Euler angles.
返回 void
En
Decompose the quaternion into Euler angles (in the order of Yaw, Pitch, Roll). Note: This method may produce sudden flips when rotating around the X axis beyond ±90 degrees.

Zh
将四元数分解为欧拉角（按Yaw、Pitch、Roll的顺序）。注意：当绕X轴旋转超过±90度时，此方法可能会产生突然的翻转。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:495

identity

identity(): void
返回 void
En
Set the quaternion to identity quaternion.

Zh
将四元数设置为单位四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:561

invert

invert(out: Quaternion): void
参数
- out: Quaternion
  The output inverted quaternion.
返回 void
En
Calculate the inverse of the quaternion.

Zh
计算四元数的逆。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:545

length

length(): number
返回 number
The length of the quaternion.

En
Calculate the length of the quaternion.

Zh
计算四元数的长度。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:427

lengthSquared

lengthSquared(): number
返回 number
The squared length of the quaternion.

En
Calculates the squared length of the quaternion.

Zh
计算四元数长度的平方。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:675

normalize

normalize(out: Quaternion): void
参数
- out: Quaternion
  The output normalized quaternion.
返回 void
En
Normalize the quaternion.

Zh
归一化四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:410

rotateX

rotateX(rad: number, out: Quaternion): void
参数
- rad: number
  The angle of rotation.
- out: Quaternion
  The output rotated quaternion.
返回 void
En
Rotate the quaternion around the X axis.

Zh
根据绕X轴的角度旋转四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:439

rotateY

rotateY(rad: number, out: Quaternion): void
参数
- rad: number
  The angle of rotation.
- out: Quaternion
  The output rotated quaternion.
返回 void
En
Rotate the quaternion around the Y axis by a specified angle.

Zh
根据绕Y轴的指定角度旋转四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:458

rotateZ

rotateZ(rad: number, out: Quaternion): void
参数
- rad: number
  The angle of rotation.
- out: Quaternion
  The output rotated quaternion.
返回 void
En
Rotate the quaternion around the Z axis by a specified angle.

Zh
根据绕Z轴的指定角度旋转四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:477

scaling

scaling(scaling: number, out: Quaternion): void
参数
- scaling: number
  The scalar value to scale by.
- out: Quaternion
  The output quaternion.
返回 void
En
Scale the quaternion by a scalar value.

Zh
根据缩放值缩放四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:397

set

set(x: number, y: number, z: number, w: number): Quaternion
参数
- x: number
  The X value.
- y: number
  The Y value.
- z: number
  The Z value.
- w: number
  The W value.
返回 Quaternion
The quaternion itself.

En
Set the values of the quaternion and return itself.

Zh
设置四元数的值并返回自身。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:384

setValue

setValue(x: number, y: number, z: number, w: number): void
参数
- x: number
  The X value.
- y: number
  The Y value.
- z: number
  The Z value.
- w: number
  The W value.
返回 void
En
Set the values of the quaternion.

Zh
设置四元数的值。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:366

`静态`add

add(left: Quaternion, right: Quaternion, out: Quaternion): void
参数
- left: Quaternion
  The left quaternion.
- right: Quaternion
  The right quaternion.
- out: Quaternion
  The output quaternion.
返回 void
En
Calculate the sum of two quaternions.

Zh
计算两个四元数的和。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:290

`静态`createFromAxisAngle

createFromAxisAngle(axis: Vector3, rad: number, out: Quaternion): void
参数
- axis: Vector3
  The axis vector.
- rad: number
  The angle in radians.
- out: Quaternion
  The output quaternion.
返回 void
En
Calculate a quaternion from the specified axis and angle.

Zh
从指定的轴和角度计算四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:142

`静态`createFromMatrix4x4

createFromMatrix4x4(mat: Matrix4x4, out: Quaternion): void
参数
- mat: Matrix4x4
  The rotation matrix.
- out: Quaternion
  The output quaternion.
返回 void
En
Calculate a quaternion from a rotation matrix.

Zh
从旋转矩阵计算四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:159

`静态`createFromYawPitchRoll

createFromYawPitchRoll(
    yaw: number,
    pitch: number,
    roll: number,
    out: Quaternion,
): void
参数
- yaw: number
  The yaw value
- pitch: number
  The pitch value
- roll: number
  The roll value
- out: Quaternion
  The output quaternion
返回 void
En
Generate a quaternion from Euler angles (order is Yaw, Pitch, Roll)

Zh
从欧拉角生成四元数（顺序为Yaw、Pitch、Roll）
- 定义于 src/layaAir/laya/maths/Quaternion.ts:39

`静态`dot

dot(left: Quaternion, right: Quaternion): number
参数
- left: Quaternion
  The left quaternion.
- right: Quaternion
  The right quaternion.
返回 number
The dot product.

En
Calculate the dot product of two quaternions.

Zh
计算两个四元数的点积。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:307

`静态`forwardLookAt

forwardLookAt(eye: Vector3, target: Vector3, up: Vector3, out: Quaternion): void
参数
- eye: Vector3
  The position of the observer.
- target: Vector3
  The target position to look at.
- up: Vector3
  The up vector.
- out: Quaternion
  The output quaternion.
返回 void
En
Calculates a look-at quaternion (suitable for GameObject).

Zh
计算观察四元数（适用于游戏对象）。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:664

`静态`invert

invert(value: Quaternion, out: Quaternion): void
参数
- value: Quaternion
  The input quaternion.
- out: Quaternion
  The output inverse quaternion.
返回 void
En
Calculates the inverse of a quaternion.

Zh
计算四元数的逆四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:687

`静态`lerp

lerp(left: Quaternion, right: Quaternion, amount: number, out: Quaternion): void
参数
- left: Quaternion
  The left quaternion.
- right: Quaternion
  The right quaternion.
- amount: number
  The interpolation factor, ranging from 0 to 1.
- out: Quaternion
  The output quaternion.
返回 void
En
Calculate the linear interpolation between two quaternions.

Zh
计算两个四元数的线性插值。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:265

`静态`lookAt

lookAt(eye: Vector3, target: Vector3, up: Vector3, out: Quaternion): void
参数
- eye: Vector3
  The position of the observer.
- target: Vector3
  The target position to look at.
- up: Vector3
  The up vector.
- out: Quaternion
  The output quaternion.
返回 void
En
Calculates a look-at quaternion (suitable for Camera and Light).

Zh
计算观察四元数（适用于相机和灯光）。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:647

`静态`multiply

multiply(left: Quaternion, right: Quaternion, out: Quaternion): void
参数
- left: Quaternion
  The left quaternion
- right: Quaternion
  The right quaternion
- out: Quaternion
  The output quaternion
返回 void
En
Multiply two quaternions

Zh
计算两个四元数相乘
- 定义于 src/layaAir/laya/maths/Quaternion.ts:68

`静态`rotationAxisAngle

rotationAxisAngle(axis: Vector3, rad: number, out: Quaternion): void
参数
- axis: Vector3
  The rotation axis
- rad: number
  The rotation angle in radians
- out: Quaternion
  The output quaternion after rotation
返回 void
En
Calculate a quaternion that rotates around an arbitrary axis.

Zh
计算绕任意轴旋转的四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:97

`静态`rotationLookAt

rotationLookAt(forward: Vector3, up: Vector3, out: Quaternion): void
参数
- forward: Vector3
  The forward direction.
- up: Vector3
  The up vector.
- out: Quaternion
  The output quaternion.
返回 void
En
Calculates a rotation quaternion to look at a direction.

Zh
计算旋转观察四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:631

`静态`rotationMatrix

rotationMatrix(matrix3x3: Matrix3x3, out: Quaternion): void
参数
- matrix3x3: Matrix3x3
  The 3x3 rotation matrix.
- out: Quaternion
  The output quaternion.
返回 void
En
Creates a quaternion from a 3x3 rotation matrix.

Zh
通过一个3x3旋转矩阵创建一个四元数。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:707

`静态`slerp

slerp(
    left: Quaternion,
    right: Quaternion,
    t: number,
    out: Quaternion,
): Quaternion
参数
- left: Quaternion
  The left quaternion.
- right: Quaternion
  The right quaternion.
- t: number
  The interpolation factor, ranging from 0 to 1.
- out: Quaternion
  The output quaternion.
返回 Quaternion
The output quaternion.

En
Spherical linear interpolation between two quaternions.

Zh
两个四元数之间的球面线性插值。
- 定义于 src/layaAir/laya/maths/Quaternion.ts:216

类 Quaternion

En

Zh

实现

索引

构造函数

属性

方法

构造函数

constructor

参数

返回 Quaternion

En

Zh

属性

w

En

Zh

x

En

Zh

y

En

Zh

z

En

Zh

静态 只读DEFAULT

En

Zh

静态 只读NAN

En

Zh

方法

clone

返回 any

En

Zh

cloneTo

参数

返回 void

En

Zh

equals

参数

返回 boolean

En

Zh

fromArray

参数

返回 void

En

Zh

getYawPitchRoll

参数

返回 void

En

Zh

identity

返回 void

En

Zh

invert

参数

返回 void

En

Zh

length

返回 number

En

Zh

lengthSquared

返回 number

En

Zh

normalize

参数

返回 void

En

Zh

`静态` `只读`DEFAULT

`静态` `只读`NAN

`静态`add

`静态`createFromAxisAngle

`静态`createFromMatrix4x4

`静态`createFromYawPitchRoll

`静态`dot

`静态`forwardLookAt

`静态`invert

`静态`lerp