Class Quat

Quaternion

Hierarchy

Float32Array
- Quat

Indexable

[index: number]: number

Index

Accessors

mag

get mag(): number
Alias for Quat.magnitude

Returns number

magnitude

get magnitude(): number
The magnitude (length) of this. Equivalent to Quat.magnitude(this);

Magnitude is used because the length attribute is already defined by TypedArrays to mean the number of elements in the array.

Returns number

str

get str(): string
A string representation of this Equivalent to Quat.str(this);

Returns string

Constructor

constructor

new Quat(
...values: number[] | [ArrayBufferLike | Readonly<Vec4Like>, number?],
): Quat
Create a Quat.
Parameters
- ...values: number[] | [ArrayBufferLike | Readonly<Vec4Like>, number?]
Returns Quat
Overrides Float32Array.constructor

Methods

copy

copy(a: Readonly<Vec4Like>): this
Copy the values from another Quat into this.
Parameters
- a: Readonly<Vec4Like>
  the source quaternion
Returns this
this

dot

dot(b: Readonly<Vec4Like>): number
Calculates the dot product of this and another Quat Equivalent to Quat.dot(this, b);
Parameters
- b: Readonly<Vec4Like>
  the second operand
Returns number
dot product of this and b

identity

identity(): this
Set this to the identity quaternion Equivalent to Quat.identity(this)

Returns this
this

invert

invert(): this
Inverts this Equivalent to Quat.invert(this, this);

Returns this
this

mul

mul(b: Readonly<Vec4Like>): this
Alias for Quat.multiply
Parameters
- b: Readonly<Vec4Like>
Returns this

multiply

multiply(b: Readonly<Vec4Like>): this
Multiplies this by a Quat. Equivalent to Quat.multiply(this, this, b);
Parameters
- b: Readonly<Vec4Like>
  The vector to multiply this by
Returns this
this

rotateX

rotateX(rad: number): this
Rotates this by the given angle about the X axis Equivalent to Quat.rotateX(this, this, rad);
Parameters
- rad: number
  angle (in radians) to rotate
Returns this
this

rotateY

rotateY(rad: number): this
Rotates this by the given angle about the Y axis Equivalent to Quat.rotateY(this, this, rad);
Parameters
- rad: number
  angle (in radians) to rotate
Returns this
this

rotateZ

rotateZ(rad: number): this
Rotates this by the given angle about the Z axis Equivalent to Quat.rotateZ(this, this, rad);
Parameters
- rad: number
  angle (in radians) to rotate
Returns this
this

scale

scale(scale: number): Vec4Like
Scales this by a scalar number Equivalent to Quat.scale(this, this, scale);
Parameters
- scale: number
  amount to scale the vector by
Returns Vec4Like
this

Other

`Readonly`[toStringTag]

"[toStringTag]": "Float32Array"

`Readonly`buffer

buffer: ArrayBuffer

The ArrayBuffer instance referenced by the array.

`Readonly`byteLength

byteLength: number

The length in bytes of the array.

`Readonly`byteOffset

byteOffset: number

The offset in bytes of the array.

`Readonly`BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

`Readonly`length

length: number

The length of the array.

`Static` `Readonly`BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

[iterator]

"[iterator]"(): ArrayIterator<number>
Returns ArrayIterator<number>
Inherited from Float32Array.[iterator]

at

at(index: number): number
Returns the item located at the specified index.
Parameters
- index: number
  The zero-based index of the desired code unit. A negative index will count back from the last item.
Returns number
Inherited from Float32Array.at

copyWithin

copyWithin(target: number, start: number, end?: number): this
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
Parameters
- target: number
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optionalend: number
  If not specified, length of the this object is used as its default value.
Returns this
Inherited from Float32Array.copyWithin

entries

entries(): ArrayIterator<[number, number]>
Returns an array of key, value pairs for every entry in the array

Returns ArrayIterator<[number, number]>
Inherited from Float32Array.entries

every

every(
predicate: (value: number, index: number, array: this) => unknown,
thisArg?: any,
): boolean
Determines whether all the members of an array satisfy the specified test.
Parameters
- predicate: (value: number, index: number, array: this) => unknown
  A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
Inherited from Float32Array.every

fill

fill(value: number, start?: number, end?: number): this
Changes all array elements from start to end index to a static value and returns the modified array
Parameters
- value: number
  value to fill array section with
- Optionalstart: number
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optionalend: number
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this
Inherited from Float32Array.fill

filter

filter(
predicate: (value: number, index: number, array: this) => any,
thisArg?: any,
): Float32Array<ArrayBuffer>
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
- predicate: (value: number, index: number, array: this) => any
  A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.filter

find

find(
predicate: (value: number, index: number, obj: this) => boolean,
thisArg?: any,
): number
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
- predicate: (value: number, index: number, obj: this) => boolean
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
- OptionalthisArg: any
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
Inherited from Float32Array.find

findIndex

findIndex(
predicate: (value: number, index: number, obj: this) => boolean,
thisArg?: any,
): number
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
- predicate: (value: number, index: number, obj: this) => boolean
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
- OptionalthisArg: any
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
Inherited from Float32Array.findIndex

forEach

forEach(
callbackfn: (value: number, index: number, array: this) => void,
thisArg?: any,
): void
Performs the specified action for each element in an array.
Parameters
- callbackfn: (value: number, index: number, array: this) => void
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
Inherited from Float32Array.forEach

includes

includes(searchElement: number, fromIndex?: number): boolean
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
- searchElement: number
  The element to search for.
- OptionalfromIndex: number
  The position in this array at which to begin searching for searchElement.
Returns boolean
Inherited from Float32Array.includes

indexOf

indexOf(searchElement: number, fromIndex?: number): number
Returns the index of the first occurrence of a value in an array.
Parameters
- searchElement: number
  The value to locate in the array.
- OptionalfromIndex: number
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
Inherited from Float32Array.indexOf

join

join(separator?: string): string
Adds all the elements of an array separated by the specified separator string.
Parameters
- Optionalseparator: string
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string
Inherited from Float32Array.join

keys

keys(): ArrayIterator<number>
Returns an list of keys in the array

Returns ArrayIterator<number>
Inherited from Float32Array.keys

lastIndexOf

lastIndexOf(searchElement: number, fromIndex?: number): number
Returns the index of the last occurrence of a value in an array.
Parameters
- searchElement: number
  The value to locate in the array.
- OptionalfromIndex: number
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
Inherited from Float32Array.lastIndexOf

map

map(
callbackfn: (value: number, index: number, array: this) => number,
thisArg?: any,
): Float32Array<ArrayBuffer>
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Parameters
- callbackfn: (value: number, index: number, array: this) => number
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.map

reduce

reduce(
    callbackfn: (
        previousValue: number,
        currentValue: number,
        currentIndex: number,
        array: this,
    ) => number,
): number
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
- callbackfn: (
      previousValue: number,
      currentValue: number,
      currentIndex: number,
      array: this,
  ) => number
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Returns number
Inherited from Float32Array.reduce
reduce(
    callbackfn: (
        previousValue: number,
        currentValue: number,
        currentIndex: number,
        array: this,
    ) => number,
    initialValue: number,
): number
Parameters
- callbackfn: (
      previousValue: number,
      currentValue: number,
      currentIndex: number,
      array: this,
  ) => number
- initialValue: number
Returns number
Inherited from Float32Array.reduce
reduce<U>(
    callbackfn: (
        previousValue: U,
        currentValue: number,
        currentIndex: number,
        array: this,
    ) => U,
    initialValue: U,
): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type Parameters
- U
Parameters
- callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
- initialValue: U
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
Inherited from Float32Array.reduce

reduceRight

reduceRight(
    callbackfn: (
        previousValue: number,
        currentValue: number,
        currentIndex: number,
        array: this,
    ) => number,
): number
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
- callbackfn: (
      previousValue: number,
      currentValue: number,
      currentIndex: number,
      array: this,
  ) => number
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Returns number
Inherited from Float32Array.reduceRight
reduceRight(
    callbackfn: (
        previousValue: number,
        currentValue: number,
        currentIndex: number,
        array: this,
    ) => number,
    initialValue: number,
): number
Parameters
- callbackfn: (
      previousValue: number,
      currentValue: number,
      currentIndex: number,
      array: this,
  ) => number
- initialValue: number
Returns number
Inherited from Float32Array.reduceRight
reduceRight<U>(
    callbackfn: (
        previousValue: U,
        currentValue: number,
        currentIndex: number,
        array: this,
    ) => U,
    initialValue: U,
): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type Parameters
- U
Parameters
- callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
- initialValue: U
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
Inherited from Float32Array.reduceRight

reverse

reverse(): this
Reverses the elements in an Array.

Returns this
Inherited from Float32Array.reverse

set

set(array: ArrayLike<number>, offset?: number): void
Sets a value or an array of values.
Parameters
- array: ArrayLike<number>
  A typed or untyped array of values to set.
- Optionaloffset: number
  The index in the current array at which the values are to be written.
Returns void
Inherited from Float32Array.set

slice

slice(start?: number, end?: number): Float32Array<ArrayBuffer>
Returns a section of an array.
Parameters
- Optionalstart: number
  The beginning of the specified portion of the array.
- Optionalend: number
  The end of the specified portion of the array. This is exclusive of the element at the index 'end'.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.slice

some

some(
predicate: (value: number, index: number, array: this) => unknown,
thisArg?: any,
): boolean
Determines whether the specified callback function returns true for any element of an array.
Parameters
- predicate: (value: number, index: number, array: this) => unknown
  A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
- OptionalthisArg: any
  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
Inherited from Float32Array.some

sort

sort(compareFn?: (a: number, b: number) => number): this
Sorts an array.
Parameters
- OptionalcompareFn: (a: number, b: number) => number
  Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.
  
  [11,2,22,1].sort((a, b) => a - b)
Returns this
Inherited from Float32Array.sort

subarray

subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>
Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.
Parameters
- Optionalbegin: number
  The index of the beginning of the array.
- Optionalend: number
  The index of the end of the array.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.subarray

toLocaleString

toLocaleString(): string
Converts a number to a string by using the current locale.

Returns string
Inherited from Float32Array.toLocaleString
toLocaleString(
locales: string | string[],
options?: NumberFormatOptions,
): string
Parameters
- locales: string | string[]
- Optionaloptions: NumberFormatOptions
Returns string
Inherited from Float32Array.toLocaleString

toString

toString(): string
Returns a string representation of an array.

Returns string
Inherited from Float32Array.toString

valueOf

valueOf(): this
Returns the primitive value of the specified object.

Returns this
Inherited from Float32Array.valueOf

values

values(): ArrayIterator<number>
Returns an list of values in the array

Returns ArrayIterator<number>
Inherited from Float32Array.values

`Static`from

from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>
Creates an array from an array-like or iterable object.
Parameters
- arrayLike: ArrayLike<number>
  An array-like object to convert to an array.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.from
from<T>(
    arrayLike: ArrayLike<T>,
    mapfn: (v: T, k: number) => number,
    thisArg?: any,
): Float32Array<ArrayBuffer>
Creates an array from an array-like or iterable object.
Type Parameters
- T
Parameters
- arrayLike: ArrayLike<T>
  An array-like object to convert to an array.
- mapfn: (v: T, k: number) => number
  A mapping function to call on every element of the array.
- OptionalthisArg: any
  Value of 'this' used to invoke the mapfn.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.from
from(elements: Iterable<number>): Float32Array<ArrayBuffer>
Creates an array from an array-like or iterable object.
Parameters
- elements: Iterable<number>
  An iterable object to convert to an array.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.from
from<T>(
    elements: Iterable<T>,
    mapfn?: (v: T, k: number) => number,
    thisArg?: any,
): Float32Array<ArrayBuffer>
Creates an array from an array-like or iterable object.
Type Parameters
- T
Parameters
- elements: Iterable<T>
  An iterable object to convert to an array.
- Optionalmapfn: (v: T, k: number) => number
  A mapping function to call on every element of the array.
- OptionalthisArg: any
  Value of 'this' used to invoke the mapfn.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.from

`Static`of

of(...items: number[]): Float32Array<ArrayBuffer>
Returns a new array from a set of elements.
Parameters
- ...items: number[]
  A set of elements to include in the new array object.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.of

Quaternion Components

w

get w(): number
The w component of the quaternion. Equivalent to this[3];

Returns number
set w(value: number): void
Parameters
- value: number
Returns void

x

get x(): number
The x component of the quaternion. Equivalent to this[0];

Returns number
set x(value: number): void
Parameters
- value: number
Returns void

y

get y(): number
The y component of the quaternion. Equivalent to this[1];

Returns number
set y(value: number): void
Parameters
- value: number
Returns void

z

get z(): number
The z component of the quaternion. Equivalent to this[2];

Returns number
set z(value: number): void
Parameters
- value: number
Returns void

Static

`Static`BYTE_LENGTH

get BYTE_LENGTH(): number
Returns number
The number of bytes in a Quat.

`Static`add

add(out: Vec4Like, a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): Vec4Like
Adds two Quat's
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  the first operand
- b: Readonly<Vec4Like>
  the second operand
Returns Vec4Like
out

`Static`calculateW

calculateW(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like
Calculates the W component of a quat from the X, Y, and Z components. Assumes that quaternion is 1 unit in length. Any existing W component will be ignored.
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  quat to calculate W component of
Returns Vec4Like
out

`Static`clone

clone(a: Readonly<Vec4Like>): Quat
Creates a new quat initialized with values from an existing quaternion
Parameters
- a: Readonly<Vec4Like>
  quaternion to clone
Returns Quat
a new quaternion

`Static`conjugate

conjugate(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like
Calculates the conjugate of a quat If the quaternion is normalized, this function is faster than quat.inverse and produces the same result.
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  quat to calculate conjugate of
Returns Vec4Like
out

`Static`copy

copy(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like
Copy the values from one quat to another
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  the source quaternion
Returns Vec4Like
out

`Static`create

create(): Quat
Creates a new identity quat

Returns Quat
a new quaternion

`Static`dot

dot(a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): number
Calculates the dot product of two quat's
Parameters
- a: Readonly<Vec4Like>
  the first operand
- b: Readonly<Vec4Like>
  the second operand
Returns number
dot product of a and b

`Static`equals

equals(a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): boolean
Returns whether the quaternions have approximately the same elements in the same position.
Parameters
- a: Readonly<Vec4Like>
  The first vector.
- b: Readonly<Vec4Like>
  The second vector.
Returns boolean
True if the vectors are equal, false otherwise.

`Static`exactEquals

exactEquals(a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): boolean
Returns whether the quaternions have exactly the same elements in the same position (when compared with ===)
Parameters
- a: Readonly<Vec4Like>
  The first quaternion.
- b: Readonly<Vec4Like>
  The second quaternion.
Returns boolean
True if the vectors are equal, false otherwise.

`Static`exp

exp(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like
Calculate the exponential of a unit quaternion.
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  quat to calculate the exponential of
Returns Vec4Like
out

`Static`fromEuler

fromEuler(
    out: Vec4Like,
    x: number,
    y: number,
    z: number,
    order?: string,
): Vec4Like
Creates a quaternion from the given euler angle x, y, z.
Parameters
- out: Vec4Like
  the receiving quaternion
- x: number
  Angle to rotate around X axis in degrees.
- y: number
  Angle to rotate around Y axis in degrees.
- z: number
  Angle to rotate around Z axis in degrees.
- Optionalorder: string
  Intrinsic order for conversion, default is zyx.
Returns Vec4Like
out

`Static`fromMat3

fromMat3(out: Vec4Like, m: Readonly<Mat3Like>): Vec4Like
Creates a quaternion from the given 3x3 rotation matrix.

NOTE: The resultant quaternion is not normalized, so you should be sure to re-normalize the quaternion yourself where necessary.
Parameters
- out: Vec4Like
  the receiving quaternion
- m: Readonly<Mat3Like>
  rotation matrix
Returns Vec4Like
out

`Static`fromValues

fromValues(x: number, y: number, z: number, w: number): Quat
Creates a new quat initialized with the given values
Parameters
- x: number
  X component
- y: number
  Y component
- z: number
  Z component
- w: number
  W component
Returns Quat
a new quaternion

`Static`getAngle

getAngle(a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): number
Gets the angular distance between two unit quaternions
Parameters
- a: Readonly<Vec4Like>
  Origin unit quaternion
- b: Readonly<Vec4Like>
  Destination unit quaternion
Returns number
Angle, in radians, between the two quaternions

`Static`getAxisAngle

getAxisAngle(out_axis: Vec3Like, q: Readonly<Vec4Like>): number
Gets the rotation axis and angle for a given quaternion. If a quaternion is created with setAxisAngle, this method will return the same values as provided in the original parameter list OR functionally equivalent values. Example: The quaternion formed by axis [0, 0, 1] and angle -90 is the same as the quaternion formed by [0, 0, 1] and 270. This method favors the latter.
Parameters
- out_axis: Vec3Like
  Vector receiving the axis of rotation
- q: Readonly<Vec4Like>
  Quaternion to be decomposed
Returns number
Angle, in radians, of the rotation

`Static`identity

identity(out: Vec4Like): Vec4Like
Set a quat to the identity quaternion
Parameters
- out: Vec4Like
  the receiving quaternion
Returns Vec4Like
out

`Static`invert

invert(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like
Calculates the inverse of a quat
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  quat to calculate inverse of
Returns Vec4Like
out

`Static`len

len(a: Readonly<Vec4Like>): number
Alias for Quat.magnitude
Parameters
- a: Readonly<Vec4Like>
Returns number
Deprecated
Use Quat.mag

`Static`length

length(a: Readonly<Vec4Like>): number
Alias for Quat.magnitude
Parameters
- a: Readonly<Vec4Like>
Returns number
Deprecated
Use Quat.magnitude to avoid conflicts with builtin length methods/attribs

`Static`lerp

lerp(
    out: Vec4Like,
    a: Readonly<Vec4Like>,
    b: Readonly<Vec4Like>,
    t: number,
): Vec4Like
Performs a linear interpolation between two quat's
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  the first operand
- b: Readonly<Vec4Like>
  the second operand
- t: number
  interpolation amount, in the range [0-1], between the two inputs
Returns Vec4Like
out

`Static`ln

ln(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like
Calculate the natural logarithm of a unit quaternion.
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  quat to calculate the exponential of
Returns Vec4Like
out

`Static`mag

mag(a: Readonly<Vec4Like>): number
Alias for Quat.magnitude
Parameters
- a: Readonly<Vec4Like>
Returns number

`Static`magnitude

magnitude(a: Readonly<Vec4Like>): number
Calculates the magnitude (length) of a Quat
Parameters
- a: Readonly<Vec4Like>
  quaternion to calculate length of
Returns number
length of a

`Static`mul

mul(out: Vec4Like, a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): Vec4Like
Alias for Quat.multiply
Parameters
- out: Vec4Like
- a: Readonly<Vec4Like>
- b: Readonly<Vec4Like>
Returns Vec4Like

`Static`multiply

multiply(out: Vec4Like, a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): Vec4Like
Multiplies two quaternions.
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  the first operand
- b: Readonly<Vec4Like>
  the second operand
Returns Vec4Like
out

`Static`normalize

normalize(out: Vec4Like, a: Readonly<Vec4Like>): Vec4Like
Normalize a Quat
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  quaternion to normalize
Returns Vec4Like
out

`Static`pow

pow(out: Vec4Like, a: Readonly<Vec4Like>, b: number): Vec4Like
Calculate the scalar power of a unit quaternion.
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  quat to calculate the exponential of
- b: number
  amount to scale the quaternion by
Returns Vec4Like
out

`Static`rotateX

rotateX(out: Vec4Like, a: Readonly<Vec4Like>, rad: number): Vec4Like
Rotates a quaternion by the given angle about the X axis
Parameters
- out: Vec4Like
  quat receiving operation result
- a: Readonly<Vec4Like>
  quat to rotate
- rad: number
  angle (in radians) to rotate
Returns Vec4Like
out

`Static`rotateY

rotateY(out: Vec4Like, a: Readonly<Vec4Like>, rad: number): Vec4Like
Rotates a quaternion by the given angle about the Y axis
Parameters
- out: Vec4Like
  quat receiving operation result
- a: Readonly<Vec4Like>
  quat to rotate
- rad: number
  angle (in radians) to rotate
Returns Vec4Like
out

`Static`rotateZ

rotateZ(out: Vec4Like, a: Readonly<Vec4Like>, rad: number): Vec4Like
Rotates a quaternion by the given angle about the Z axis
Parameters
- out: Vec4Like
  quat receiving operation result
- a: Readonly<Vec4Like>
  quat to rotate
- rad: number
  angle (in radians) to rotate
Returns Vec4Like
out

`Static`rotationTo

rotationTo(
    out: Vec4Like,
    a: Readonly<Vec3Like>,
    b: Readonly<Vec3Like>,
): Vec4Like
Sets a quaternion to represent the shortest rotation from one vector to another.

Both vectors are assumed to be unit length.
Parameters
- out: Vec4Like
  the receiving quaternion.
- a: Readonly<Vec3Like>
  the initial vector
- b: Readonly<Vec3Like>
  the destination vector
Returns Vec4Like
out

`Static`scale

scale(out: Vec4Like, a: Readonly<Vec4Like>, scale: number): Vec4Like
Scales a quat by a scalar number
Parameters
- out: Vec4Like
  the receiving vector
- a: Readonly<Vec4Like>
  the vector to scale
- scale: number
Returns Vec4Like
out

`Static`set

set(out: Vec4Like, x: number, y: number, z: number, w: number): Vec4Like
Set the components of a Quat to the given values
Parameters
- out: Vec4Like
  the receiving quaternion
- x: number
  X component
- y: number
  Y component
- z: number
  Z component
- w: number
  W component
Returns Vec4Like
out

`Static`setAxes

setAxes(
    out: Vec4Like,
    view: Readonly<Vec3Like>,
    right: Readonly<Vec3Like>,
    up: Readonly<Vec3Like>,
): Vec4Like
Sets the specified quaternion with values corresponding to the given axes. Each axis is a vec3 and is expected to be unit length and perpendicular to all other specified axes.
Parameters
- out: Vec4Like
  The receiving quaternion
- view: Readonly<Vec3Like>
  the vector representing the viewing direction
- right: Readonly<Vec3Like>
  the vector representing the local right direction
- up: Readonly<Vec3Like>
  the vector representing the local up direction
Returns Vec4Like
out

`Static`setAxisAngle

setAxisAngle(out: Vec4Like, axis: Readonly<Vec3Like>, rad: number): Vec4Like
Sets a quat from the given angle and rotation axis, then returns it.
Parameters
- out: Vec4Like
  the receiving quaternion
- axis: Readonly<Vec3Like>
  the axis around which to rotate
- rad: number
  the angle in radians
Returns Vec4Like
out

`Static`slerp

slerp(
    out: Vec4Like,
    a: Readonly<Vec4Like>,
    b: Readonly<Vec4Like>,
    t: number,
): Vec4Like
Performs a spherical linear interpolation between two quat
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  the first operand
- b: Readonly<Vec4Like>
  the second operand
- t: number
  interpolation amount, in the range [0-1], between the two inputs
Returns Vec4Like
out

`Static`sqlerp

sqlerp(
    out: Vec4Like,
    a: Readonly<Vec4Like>,
    b: Readonly<Vec4Like>,
    c: Readonly<Vec4Like>,
    d: Readonly<Vec4Like>,
    t: number,
): Vec4Like
Performs a spherical linear interpolation with two control points
Parameters
- out: Vec4Like
  the receiving quaternion
- a: Readonly<Vec4Like>
  the first operand
- b: Readonly<Vec4Like>
  the second operand
- c: Readonly<Vec4Like>
  the third operand
- d: Readonly<Vec4Like>
  the fourth operand
- t: number
  interpolation amount, in the range [0-1], between the two inputs
Returns Vec4Like
out

`Static`sqrLen

sqrLen(a: Readonly<Vec4Like>): number
Alias for Quat.squaredLength
Parameters
- a: Readonly<Vec4Like>
Returns number

`Static`squaredLength

squaredLength(a: Readonly<Vec4Like>): number
Calculates the squared length of a Quat
Parameters
- a: Readonly<Vec4Like>
  quaternion to calculate squared length of
Returns number
squared length of a

`Static`str

str(a: Readonly<Vec4Like>): string
Returns a string representation of a quatenion
Parameters
- a: Readonly<Vec4Like>
  vector to represent as a string
Returns string
string representation of the vector

Class Quat

Hierarchy

Indexable

Index

Accessors

Constructor

Methods

Other

Quaternion Components

Static

Accessors

mag

Returns number

magnitude

Returns number

str

Returns string

Constructor

constructor

Parameters

Returns Quat

Methods

copy

Parameters

Returns this

dot

Parameters

Returns number

identity

Returns this

invert

Returns this

mul

Parameters

Returns this

multiply

Parameters

Returns this

rotateX

Parameters

Returns this

rotateY

Parameters

Returns this

rotateZ

Parameters

Returns this

scale

Parameters

Returns Vec4Like

Other

Readonly[toStringTag]

Readonlybuffer

ReadonlybyteLength

ReadonlybyteOffset

ReadonlyBYTES_PER_ELEMENT

Readonlylength

Static ReadonlyBYTES_PER_ELEMENT

[iterator]

Returns ArrayIterator<number>

at

Parameters

Returns number

copyWithin

Parameters

Returns this

entries

Returns ArrayIterator<[number, number]>

every

Parameters

Returns boolean

fill

Parameters

Returns this

filter

Parameters

Returns Float32Array<ArrayBuffer>

find

Parameters

Returns number

`Readonly`[toStringTag]

`Readonly`buffer

`Readonly`byteLength

`Readonly`byteOffset

`Readonly`BYTES_PER_ELEMENT

`Readonly`length

`Static` `Readonly`BYTES_PER_ELEMENT

`Static`from