Create an identity quaternion.
The first component of this quaternion.
The second component of this quaternion.
The third component of this quaternion.
The fourth component of this quaternion.
Readonly
BYTES_The size in bytes of each element in the array.
Readonly
[toReadonly
bufferThe ArrayBuffer instance referenced by the array.
Readonly
byteThe length in bytes of the array.
Readonly
byteThe offset in bytes of the array.
Readonly
lengthThe length of the array.
Static
Readonly
BYTES_The size in bytes of each element in the array.
Get the magnitude (length) of this quaternion.
Get the squared magnitude (length) of this quaternion.
Add two quaternions of the same size.
The other quaternion.
The quaternion to store the result in.
The sum of the quaternions.
Calculate the fourth component of this unit quaternion from the first three, ignoring the existing fourth component.
The quaternion to store the result in.
The quaternion.
Copy the values from this quaternion to another one.
The quaternion to store the result in.
The copy.
Calculate the conjugate of this quaternion. If the quaternion is normalized, this is the same as the inverse but faster to calculate.
The quaternion to store the result in.
The conjugate.
Copy the values of another quaternion into this one.
The quaternion to copy.
This quaternion.
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
If target is negative, it is treated as length+target where length is the length of the array.
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional
end: numberIf not specified, length of the this object is used as its default value.
Calculate the dot product of this and another quaternion.
The other quaternion.
The dot product.
Determine whether or not this quaternion is roughly equivalent to another.
The other quaternion.
Whether or not the quaternions are equivalent.
Determines whether all the members of an array satisfy the specified test.
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.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Determine whether or not this quaternion is exactly equivalent to another.
The other quaternion.
Whether or not the quaternions are equivalent.
Calculate the exponential of this unit quaternion.
The quaternion to store the result in.
The exponential.
Changes all array elements from start
to end
index to a static value
and returns the modified array
value to fill array section with
Optional
start: numberindex to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional
end: numberindex to stop filling the array at. If end is negative, it is treated as length+end.
Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
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.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
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.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns the value of the last element in the array where predicate is true, and undefined otherwise.
findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Optional
thisArg: anyReturns the index of the last element in the array where predicate is true, and -1 otherwise.
findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Get the angular distance between this unit quaternion and another.
The other unit quaternion.
The angular distance in radians.
Determines whether an array includes a certain element, returning true or false as appropriate.
The element to search for.
Optional
fromIndex: numberThe position in this array at which to begin searching for searchElement.
Returns the index of the first occurrence of a value in an array.
The value to locate in the array.
Optional
fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Calculate the inverse of this quaternion. If the quaternion is normalized, the conjugate is the same but faster to calculate.
The quaternion to store the result in.
The inverse.
Adds all the elements of an array separated by the specified separator string.
Optional
separator: stringA 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 the index of the last occurrence of a value in an array.
The value to locate in the array.
Optional
fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Perform a linear interpolation between this and another quaternion.
The other quaternion.
The interpolation amount (in [0,1]
).
The quaternion to store the result in.
The interpolated quaternion.
Calculate the natural logarithm of this unit quaternion.
The quaternion to store the result in.
The natural logarithm.
Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Multiply this and another quaternion.
The other quaternion.
The quaternion to store the result in.
The product.
Normalize this quaternion.
The quaternion to store the result in.
The normalized quaternion.
Calculate a power of this unit quaternion.
The amount to scale the quaternion by.
The quaternion to store the result in.
The power.
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.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
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.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
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.
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.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
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.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
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.
Rotate this quaternion by the given angle around the X-axis.
The angle in radians.
The quaternion to store the result in.
The rotated quaternion.
Rotate this quaternion by the given angle around the Y-axis.
The angle in radians.
The quaternion to store the result in.
The rotated quaternion.
Rotate this quaternion by the given angle around the Z-axis.
The angle in radians.
The quaternion to store the result in.
The rotated quaternion.
Scale this quaternion by a scalar.
The scalar.
The quaternion to store the result in.
The scaled quaternion.
Set the axis and angle that represent this quaternion.
The axis and angle.
This quaternion.
Perform a spherical linear interpolation between this and another quaternion.
The other quaternion.
The interpolation amount in [0,1]
.
The quaternion to store the result in.
The interpolated quaternion.
Determines whether the specified callback function returns true for any element of an array.
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.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Sorts an array.
Optional
compareFn: ((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)
Perform a spherical linear interpolation with two control points between this and another quaternion.
The first control point.
The second control point.
The other quaternion.
The interpolation amount in [0,1]
.
The quaternion to store the result in.
The interpolated value.
Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.
Optional
begin: numberThe index of the beginning of the array.
Optional
end: numberThe index of the end of the array.
Copies and sorts the array.
Optional
compareFn: ((a: number, b: number) => number)Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending order.
const myNums = Float32Array.from([11.25, 2, -22.5, 1]);
myNums.toSorted((a, b) => a - b) // Float32Array(4) [-22.5, 1, 2, 11.5]
Copies the array and inserts the given number at the provided index.
The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.
The value to insert into the copied array.
A copy of the original array with the inserted value.
Static
fromCreates an array from an array-like or iterable object.
An array-like or iterable object to convert to an array.
Creates an array from an array-like or iterable object.
Creates an array from an array-like or iterable object.
An array-like or iterable object to convert to an array.
Optional
mapfn: ((v: number, k: number) => number)A mapping function to call on every element of the array.
Optional
thisArg: anyValue of 'this' used to invoke the mapfn.
Static
fromCreate a quaternion with values corresponding to the given orthonormal set of vectors.
The vector representing the viewing direction.
The vector representing the local "right" direction.
The vector representing the local "up" direction.
The quaternion to store the result in.
The quaternion.
Static
fromCreate a quaternion from equivalent x-y-z Tait-Bryan angles
The x angle.
The y angle.
The z angle.
The quaternion to store the result in.
The quaternion.
Static
fromCreate a quaternion from a three-by-three rotation matrix.
The matrix.
The quaternion to store the result in.
The quaternion.
Static
fromCreate a quaternion with the given values.
The first component.
The second component.
The third component.
The fourth component.
The quaternion to store the result in.
A new quaternion.
Static
of
A complex number that is commonly used to describe rotations.
See
Quaternion