Class Quaternion

Quaternion representation containing x, y, z, and w components. Used for interpolation and smooth, gimbal-lock-free 3D rotations.

Index

Constructors

Methods

clone copy fromEuler identity multiply normalize set slerp toMat4 multiply slerp

Properties

w x y z

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion
Create a new Quaternion
Parameters
- Optionalx: number = 0
  X component
- Optionaly: number = 0
  Y component
- Optionalz: number = 0
  Z component
- Optionalw: number = 1
  W component
Returns Quaternion
- Defined in math/quaternion.ts:28

Methods

clone

clone(): Quaternion
Clone this Quaternion

Returns Quaternion
A new Quaternion with identical values
- Defined in math/quaternion.ts:80

copy

copy(q: Quaternion): this
Copy components from another Quaternion into this one
Parameters
- q: Quaternion
  The Quaternion to copy from
Returns this
The current Quaternion (for chaining)
- Defined in math/quaternion.ts:68

fromEuler

fromEuler(x: number, y: number, z: number): this
Sets this Quaternion from Euler angles (pitch, yaw, roll) in radians
Parameters
- x: number
  Pitch (rotation around X in radians)
- y: number
  Yaw (rotation around Y in radians)
- z: number
  Roll (rotation around Z in radians)
Returns this
The current Quaternion (for chaining)
- Defined in math/quaternion.ts:160

identity

identity(): this
Set this Quaternion to the identity rotation (0, 0, 0, 1)

Returns this
The current Quaternion (for chaining)
- Defined in math/quaternion.ts:55

multiply

multiply(b: Quaternion): this
Multiplies this quaternion by another (in-place)
Parameters
- b: Quaternion
  The other Quaternion
Returns this
The current Quaternion (for chaining)
- Defined in math/quaternion.ts:106

normalize

normalize(): this
Normalizes this Quaternion in-place

Returns this
The current Quaternion (for chaining)
- Defined in math/quaternion.ts:88

set

set(x: number, y: number, z: number, w: number): this
Sets the components of this Quaternion
Parameters
- x: number
  X component
- y: number
  Y component
- z: number
  Z component
- w: number
  W component
Returns this
The current Quaternion (for chaining)
- Defined in math/quaternion.ts:43

slerp

slerp(target: Quaternion, t: number): this
Spherical Linear Interpolation (slerp) between this and a target quaternion in-place.
Parameters
- target: Quaternion
  The destination rotation
- t: number
  Interpolation factor (0.0 to 1.0)
Returns this
The current Quaternion (for chaining)
- Defined in math/quaternion.ts:186

toMat4

toMat4(out?: Mat4): Mat4
Converts this Quaternion to a 4x4 rotation matrix
Parameters
- Optionalout: Mat4 = ...
  Optional matrix to store result
Returns Mat4
The rotation matrix
- Defined in math/quaternion.ts:254

`Static`multiply

multiply(a: Quaternion, b: Quaternion, out?: Quaternion): Quaternion
Multiplies two Quaternions and outputs the result into another
Parameters
- a: Quaternion
  First Quaternion
- b: Quaternion
  Second Quaternion
- Optionalout: Quaternion = ...
  Optional Quaternion to store result
Returns Quaternion
The multiplied result
- Defined in math/quaternion.ts:131

`Static`slerp

slerp(a: Quaternion, b: Quaternion, t: number, out?: Quaternion): Quaternion
Spherical Linear Interpolation (slerp) between two quaternions
Parameters
- a: Quaternion
  Start rotation
- b: Quaternion
  Target rotation
- t: number
  Interpolation factor
- Optionalout: Quaternion = ...
  Optional destination Quaternion
Returns Quaternion
The interpolated Quaternion
- Defined in math/quaternion.ts:239

Properties

w

w: number

x

x: number

y

y: number

z

z: number