Quaternion

Defined in: client/api.d.ts:1735

Mutable quaternion exposed as Core.Quaternion for three-dimensional rotations. Components are scalar-first (w, x, y, z), matching GLM — not the x, y, z, w order some libraries use.

Constructors

Constructor

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

Defined in: client/api.d.ts:1743

Creates a quaternion in scalar-first w, x, y, z component order. Watch the trap: the scalar w is the first argument, unlike the x, y, z, w order used by some other libraries.

Parameters

w

number

Initial scalar component (comes first — this is not x, y, z, w order).

x

number

Initial X imaginary component.

y

number

Initial Y imaginary component.

z

number

Initial Z imaginary component.

Returns

Quaternion

Methods

clone()

clone(): Quaternion

Defined in: client/api.d.ts:1842

Creates an independent copy of this quaternion.

Returns

Quaternion

New quaternion with the same components.

---

conjugate()

conjugate(): Quaternion

Defined in: client/api.d.ts:1792

Computes the conjugate without changing this quaternion.

Returns

Quaternion

New conjugated quaternion.

---

dot()

dot(other): number

Defined in: client/api.d.ts:1813

Computes the quaternion dot product.

Parameters

other

Quaternion

Quaternion used for the dot product.

Returns

number

Scalar dot product.

---

inverse()

inverse(): Quaternion

Defined in: client/api.d.ts:1798

Computes the inverse rotation without changing this quaternion.

Returns

Quaternion

New inverse quaternion.

---

mul()

mul(other): this

Defined in: client/api.d.ts:1780

Composes this rotation with another quaternion in place.

Parameters

other

Quaternion

Rotation composed after this quaternion.

Returns

this

This mutated quaternion for chaining.

---

normalize()

normalize(): this

Defined in: client/api.d.ts:1786

Normalizes this quaternion in place; a zero quaternion becomes the identity rotation instead of NaN.

Returns

this

This unit quaternion for chaining.

---

rotateVector()

rotateVector(vector): Vector3

Defined in: client/api.d.ts:1820

Applies this rotation to a vector without mutating either value.

Parameters

vector

Vector3

Vector to rotate.

Returns

Vector3

New rotated vector.

---

set()

set(w, x, y, z): this

Defined in: client/api.d.ts:1836

Replaces all quaternion components in place.

Parameters

w

number

Replacement scalar component.

x

number

Replacement X imaginary component.

y

number

Replacement Y imaginary component.

z

number

Replacement Z imaginary component.

Returns

this

This mutated quaternion for chaining.

---

slerp()

slerp(target, t): this

Defined in: client/api.d.ts:1806

Spherically interpolates this quaternion toward a target in place.

Parameters

target

Quaternion

Destination rotation.

t

number

Interpolation factor; 0 keeps the current rotation and 1 reaches target.

Returns

this

This mutated quaternion for chaining.

---

toEuler()

toEuler(): Vector3

Defined in: client/api.d.ts:1826

Converts this rotation to Euler angles in radians.

Returns

Vector3

Pitch, yaw, and roll as a Vector3.

---

toJSON()

toJSON(): object

Defined in: client/api.d.ts:1854

Converts this quaternion to a plain object for JSON.stringify.

Returns

object

Object containing the current components.

w

w: number

x

x: number

y

y: number

z

z: number

---

toString()

toString(): string

Defined in: client/api.d.ts:1848

Formats this quaternion for logging and debugging.

Returns

string

Text in Quaternion(w, x, y, z) form.

---

fromAxisAngle()

static fromAxisAngle(axis, angle): Quaternion

Defined in: client/api.d.ts:1877

Creates a rotation around an axis.

Parameters

axis

Vector3

Rotation axis; it is normalized internally.

angle

number

Rotation angle in radians.

Returns

Quaternion

New axis-angle rotation quaternion.

---

fromEuler()

static fromEuler(pitch, yaw, roll): Quaternion

Defined in: client/api.d.ts:1869

Creates a rotation from Euler angles.

Parameters

pitch

number

Pitch angle in radians.

yaw

number

Yaw angle in radians.

roll

number

Roll angle in radians.

Returns

Quaternion

New rotation quaternion.

---

identity()

static identity(): Quaternion

Defined in: client/api.d.ts:1860

Creates the identity rotation.

Returns

Quaternion

New Quaternion(1, 0, 0, 0).

Properties

length

readonly length: number

Defined in: client/api.d.ts:1768

Read-only magnitude (norm) of this quaternion; 1 for a unit rotation.

---

lengthSquared

readonly lengthSquared: number

Defined in: client/api.d.ts:1773

Read-only squared magnitude, avoiding a square-root calculation.

---

w

w: number

Defined in: client/api.d.ts:1748

Mutable scalar component.

---

x

x: number

Defined in: client/api.d.ts:1753

Mutable X imaginary component.

---

y

y: number

Defined in: client/api.d.ts:1758

Mutable Y imaginary component.

---

z

z: number

Defined in: client/api.d.ts:1763

Mutable Z imaginary component.