Class Quat2

Dual Quaternion

Hierarchy

Float32Array
- Quat2

Indexable

[index: number]: number

Accessors

str

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

Returns string

Constructor

constructor

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

Methods

copy

copy(a: Readonly<Quat2Like>): this
Copy the values from another Quat2 into this.
Parameters
- a: Readonly<Quat2Like>
  the source dual quaternion
Returns this
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 or iterable 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 or iterable 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(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>
Creates an array from an array-like or iterable object.
Parameters
- arrayLike: Iterable<number, any, any>
  An array-like or iterable object to convert to an array.
Returns Float32Array<ArrayBuffer>
Inherited from Float32Array.from
from<T>(
    arrayLike: Iterable<T, any, any>,
    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: Iterable<T, any, any>
  An array-like or 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

Static

`Static`BYTE_LENGTH

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

`Static`add

add(out: Quat2Like, a: Readonly<Quat2Like>, b: Readonly<Quat2Like>): Quat2Like
Adds two Quat2s
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  the first operand
- b: Readonly<Quat2Like>
  the second operand
Returns Quat2Like
out

`Static`clone

clone(a: Quat2Like): Quat2
Creates a Quat2 quat initialized with values from an existing quaternion
Parameters
- a: Quat2Like
  dual quaternion to clone
Returns Quat2
a new dual quaternion

`Static`conjugate

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

`Static`copy

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

`Static`create

create(): Quat2
Creates a new identity Quat2

Returns Quat2
a new dual quaternion [real -> rotation, dual -> translation]

`Static`dot

dot(a: Readonly<Quat2Like>, b: Readonly<Quat2Like>): number
Calculates the dot product of two Quat2s (The dot product of the real parts)
Parameters
- a: Readonly<Quat2Like>
  the first operand
- b: Readonly<Quat2Like>
  the second operand
Returns number
dot product of a and b

`Static`equals

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

`Static`exactEquals

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

`Static`fromMat4

fromMat4(out: Quat2Like, a: Readonly<Mat4Like>): Quat2Like
Sets a Quat2 from a quaternion
Parameters
- out: Quat2Like
  dual quaternion receiving operation result
- a: Readonly<Mat4Like>
  the matrix
Returns Quat2Like
out

`Static`fromRotation

fromRotation(out: Quat2Like, q: Readonly<Vec4Like>): Quat2Like
Sets a Quat2 from a quaternion
Parameters
- out: Quat2Like
  dual quaternion receiving operation result
- q: Readonly<Vec4Like>
  a normalized quaternion
Returns Quat2Like
out

`Static`fromRotationTranslation

fromRotationTranslation(
    out: Quat2Like,
    q: Readonly<Vec4Like>,
    t: Readonly<Vec3Like>,
): Quat2Like
Sets a Quat2 from a quaternion and a translation
Parameters
- out: Quat2Like
  dual quaternion receiving operation result
- q: Readonly<Vec4Like>
  a normalized quaternion
- t: Readonly<Vec3Like>
  translation vector
Returns Quat2Like
out

`Static`fromRotationTranslationValues

fromRotationTranslationValues(
    x1: number,
    y1: number,
    z1: number,
    w1: number,
    x2: number,
    y2: number,
    z2: number,
): Quat2
Creates a new Quat2 from the given values (quat and translation)
Parameters
- x1: number
  X component (rotation)
- y1: number
  Y component (rotation)
- z1: number
  Z component (rotation)
- w1: number
  W component (rotation)
- x2: number
  X component (translation)
- y2: number
  Y component (translation)
- z2: number
  Z component (translation)
Returns Quat2
a new dual quaternion

`Static`fromTranslation

fromTranslation(out: Quat2Like, t: Readonly<Vec3Like>): Quat2Like
Sets a Quat2 from a translation
Parameters
- out: Quat2Like
  dual quaternion receiving operation result
- t: Readonly<Vec3Like>
  translation vector
Returns Quat2Like
out

`Static`fromValues

fromValues(
    x1: number,
    y1: number,
    z1: number,
    w1: number,
    x2: number,
    y2: number,
    z2: number,
    w2: number,
): Quat2
Creates a new Quat2 initialized with the given values
Parameters
- x1: number
  1st X component
- y1: number
  1st Y component
- z1: number
  1st Z component
- w1: number
  1st W component
- x2: number
  2nd X component
- y2: number
  2nd Y component
- z2: number
  2nd Z component
- w2: number
  2nd W component
Returns Quat2
a new dual quaternion

`Static`getDual

getDual(out: Vec4Like, a: Readonly<Quat2Like>): Vec4Like
Gets the dual part of a dual quat
Parameters
- out: Vec4Like
  dual part
- a: Readonly<Quat2Like>
  Dual Quaternion
Returns Vec4Like
out

`Static`getReal

getReal(out: Vec4Like, a: Readonly<Quat2Like>): Vec4Like
Gets the real part of a dual quat
Parameters
- out: Vec4Like
  real part
- a: Readonly<Quat2Like>
  Dual Quaternion
Returns Vec4Like
out

`Static`getTranslation

getTranslation(out: Vec3Like, a: Readonly<Quat2Like>): Vec3Like
Gets the translation of a normalized Quat2
Parameters
- out: Vec3Like
  the receiving translation vector
- a: Readonly<Quat2Like>
  Dual Quaternion to be decomposed
Returns Vec3Like
out

`Static`identity

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

`Static`invert

invert(out: Quat2Like, a: Readonly<Quat2Like>): Quat2Like
Calculates the inverse of a Quat2. If they are normalized, conjugate is cheaper
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  dual quat to calculate inverse of
Returns Quat2Like
out

`Static`len

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

`Static`length

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

`Static`lerp

lerp(
    out: Quat2Like,
    a: Readonly<Quat2Like>,
    b: Readonly<Quat2Like>,
    t: number,
): Quat2Like
Performs a linear interpolation between two Quat2s NOTE: The resulting dual quaternions won't always be normalized (The error is most noticeable when t = 0.5)
Parameters
- out: Quat2Like
  the receiving dual quat
- a: Readonly<Quat2Like>
  the first operand
- b: Readonly<Quat2Like>
  the second operand
- t: number
  interpolation amount, in the range [0-1], between the two inputs
Returns Quat2Like
out

`Static`mag

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

`Static`magnitude

magnitude(a: Readonly<Quat2Like>): number
Calculates the magnitude (length) of a Quat2
Parameters
- a: Readonly<Quat2Like>
  dual quaternion to calculate length of
Returns number
length of a

`Static`mul

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

`Static`multiply

multiply(
    out: Quat2Like,
    a: Readonly<Quat2Like>,
    b: Readonly<Quat2Like>,
): Quat2Like
Multiplies two Quat2s
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  the first operand
- b: Readonly<Quat2Like>
  the second operand
Returns Quat2Like
out

`Static`normalize

normalize(out: Quat2Like, a: Readonly<Quat2Like>): Quat2Like
Normalize a Quat2
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  dual quaternion to normalize
Returns Quat2Like
out

`Static`rotateAroundAxis

rotateAroundAxis(
    out: Quat2Like,
    a: Readonly<Quat2Like>,
    axis: Readonly<Vec3Like>,
    rad: number,
): Quat2Like
Rotates a Quat2 around a given axis. Does the normalization automatically
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  the dual quaternion to rotate
- axis: Readonly<Vec3Like>
  the axis to rotate around
- rad: number
  how far the rotation should be
Returns Quat2Like
out

`Static`rotateByQuatAppend

rotateByQuatAppend(
    out: Quat2Like,
    a: Readonly<Quat2Like>,
    q: Readonly<Vec4Like>,
): Quat2Like
Rotates a Quat2 by a given quaternion (a * q)
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  the dual quaternion to rotate
- q: Readonly<Vec4Like>
  quaternion to rotate by
Returns Quat2Like
out

`Static`rotateByQuatPrepend

rotateByQuatPrepend(
    out: Quat2Like,
    q: Readonly<Vec4Like>,
    a: Readonly<Quat2Like>,
): Quat2Like
Rotates a Quat2 by a given quaternion (q * a)
Parameters
- out: Quat2Like
  the receiving dual quaternion
- q: Readonly<Vec4Like>
  quaternion to rotate by
- a: Readonly<Quat2Like>
  the dual quaternion to rotate
Returns Quat2Like
out

`Static`rotateX

rotateX(out: Quat2Like, a: Readonly<Quat2Like>, rad: number): Quat2Like
Rotates a Quat2 around the X axis
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  the dual quaternion to rotate
- rad: number
  angle (in radians) to rotate
Returns Quat2Like
out

`Static`rotateY

rotateY(out: Quat2Like, a: Readonly<Quat2Like>, rad: number): Quat2Like
Rotates a Quat2 around the Y axis
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  the dual quaternion to rotate
- rad: number
  angle (in radians) to rotate
Returns Quat2Like
out

`Static`rotateZ

rotateZ(out: Quat2Like, a: Readonly<Quat2Like>, rad: number): Quat2Like
Rotates a Quat2 around the Z axis
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  the dual quaternion to rotate
- rad: number
  angle (in radians) to rotate
Returns Quat2Like
out

`Static`scale

scale(out: Quat2Like, a: Readonly<Quat2Like>, b: number): Quat2Like
Scales a Quat2 by a scalar value
Parameters
- out: Quat2Like
  the receiving dual quaterion
- a: Readonly<Quat2Like>
  the dual quaternion to scale
- b: number
  scalar value to scale the dual quaterion by
Returns Quat2Like
out

`Static`set

set(
    out: Quat2Like,
    x1: number,
    y1: number,
    z1: number,
    w1: number,
    x2: number,
    y2: number,
    z2: number,
    w2: number,
): Quat2Like
Set the components of a Quat2 to the given values
Parameters
- out: Quat2Like
  the receiving vector
- x1: number
  1st X component
- y1: number
  1st Y component
- z1: number
  1st Z component
- w1: number
  1st W component
- x2: number
  2nd X component
- y2: number
  2nd Y component
- z2: number
  2nd Z component
- w2: number
  2nd W component
Returns Quat2Like
out

`Static`setDual

setDual(out: Quat2Like, a: Readonly<Vec4Like>): Quat2Like
Set the dual component of a Quat2 to the given quaternion
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Vec4Like>
  a quaternion representing the dual part
Returns Quat2Like
out

`Static`setReal

setReal(out: Quat2Like, a: Readonly<Vec4Like>): Quat2Like
Set the real component of a Quat2 to the given quaternion
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Vec4Like>
  a quaternion representing the real part
Returns Quat2Like
out

`Static`sqrLen

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

`Static`squaredLength

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

`Static`str

str(a: Readonly<Quat2Like>): string
Returns a string representation of a Quat2
Parameters
- a: Readonly<Quat2Like>
  dual quaternion to represent as a string
Returns string
string representation of the vector

`Static`translate

translate(
    out: Quat2Like,
    a: Readonly<Quat2Like>,
    v: Readonly<Vec3Like>,
): Quat2Like
Translates a Quat2 by the given vector
Parameters
- out: Quat2Like
  the receiving dual quaternion
- a: Readonly<Quat2Like>
  the dual quaternion to translate
- v: Readonly<Vec3Like>
  vector to translate by
Returns Quat2Like
out

Class Quat2

Hierarchy

Indexable

Index

Accessors

Constructor

Methods

Other

Static

Accessors

str

Returns string

Constructor

constructor

Parameters

Returns Quat2

Methods

copy

Parameters

Returns this

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

findIndex

Parameters

Returns number

forEach

Parameters

Returns void

includes

Parameters

Returns boolean

indexOf

Parameters

Returns number

join

Parameters

Returns string

keys

Returns ArrayIterator<number>

lastIndexOf

Parameters

Returns number

map

Parameters

Returns Float32Array<ArrayBuffer>

reduce

Parameters

Returns number

Parameters

Returns number

Type Parameters

Parameters

`Readonly`[toStringTag]

`Readonly`buffer

`Readonly`byteLength

`Readonly`byteOffset

`Readonly`BYTES_PER_ELEMENT

`Readonly`length

`Static` `Readonly`BYTES_PER_ELEMENT

`Static`from

`Static`of

`Static`BYTE_LENGTH

`Static`add

`Static`clone

`Static`conjugate

`Static`copy

`Static`create

`Static`dot