Hierarchy

  • Float32Array
    • quat

Constructors

  • Parameters

    • length: number

    Returns quat

  • Parameters

    Returns quat

  • Parameters

    • buffer: ArrayBufferLike
    • Optional byteOffset: number
    • Optional length: number

    Returns quat

  • Parameters

    Returns quat

  • Returns quat

Properties

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

[toStringTag]: "Float32Array"

The ArrayBuffer instance referenced by the array.

byteLength: number

The length in bytes of the array.

byteOffset: number

The offset in bytes of the array.

length: number

The length of the array.

typeQuat: number
BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

Methods

  • Returns IterableIterator<number>

  • 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.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns quat

  • Returns an array of key, value pairs for every entry in the array

    Returns IterableIterator<[number, number]>

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: ((value: number, index: number, array: Float32Array) => 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.

        • (value: number, index: number, array: Float32Array): unknown
        • Parameters

          • value: number
          • index: number
          • array: Float32Array

          Returns unknown

    • Optional thisArg: 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

  • 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

    • Optional start: 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.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns quat

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • predicate: ((value: number, index: number, array: Float32Array) => any)

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

        • (value: number, index: number, array: Float32Array): any
        • Parameters

          • value: number
          • index: number
          • array: Float32Array

          Returns any

    • Optional thisArg: 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

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Parameters

    • predicate: ((value: number, index: number, obj: Float32Array) => 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.

        • (value: number, index: number, obj: Float32Array): boolean
        • Parameters

          • value: number
          • index: number
          • obj: Float32Array

          Returns boolean

    • Optional thisArg: 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 undefined | 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: Float32Array) => 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.

        • (value: number, index: number, obj: Float32Array): boolean
        • Parameters

          • value: number
          • index: number
          • obj: Float32Array

          Returns boolean

    • Optional thisArg: 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

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: ((value: number, index: number, array: Float32Array) => void)

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: number, index: number, array: Float32Array): void
        • Parameters

          • value: number
          • index: number
          • array: Float32Array

          Returns void

    • Optional thisArg: 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

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: number

      The element to search for.

    • Optional fromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: number

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: 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

  • Returns an list of keys in the array

    Returns IterableIterator<number>

  • Returns the index of the last occurrence of a value in an array.

    Parameters

    • searchElement: number

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

  • 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: Float32Array) => number)

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: number, index: number, array: Float32Array): number
        • Parameters

          • value: number
          • index: number
          • array: Float32Array

          Returns number

    • Optional thisArg: 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

  • 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: Float32Array) => number)

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: number, currentValue: number, currentIndex: number, array: Float32Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Float32Array

          Returns number

    Returns number

  • Parameters

    • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
        • (previousValue: number, currentValue: number, currentIndex: number, array: Float32Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Float32Array

          Returns number

    • initialValue: number

    Returns 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.

    Type Parameters

    • U

    Parameters

    • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: number, currentIndex: number, array: Float32Array): U
        • Parameters

          • previousValue: U
          • currentValue: number
          • currentIndex: number
          • array: Float32Array

          Returns U

    • 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

  • 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: Float32Array) => number)

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: number, currentValue: number, currentIndex: number, array: Float32Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Float32Array

          Returns number

    Returns number

  • Parameters

    • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
        • (previousValue: number, currentValue: number, currentIndex: number, array: Float32Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Float32Array

          Returns number

    • initialValue: number

    Returns 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.

    Type Parameters

    • U

    Parameters

    • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: number, currentIndex: number, array: Float32Array): U
        • Parameters

          • previousValue: U
          • currentValue: number
          • currentIndex: number
          • array: Float32Array

          Returns U

    • 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

  • Reverses the elements in an Array.

    Returns Float32Array

  • Sets a value or an array of values.

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

    • Optional offset: number

      The index in the current array at which the values are to be written.

    Returns void

  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns Float32Array

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: ((value: number, index: number, array: Float32Array) => 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.

        • (value: number, index: number, array: Float32Array): unknown
        • Parameters

          • value: number
          • index: number
          • array: Float32Array

          Returns unknown

    • Optional thisArg: 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

  • Sorts an array.

    Parameters

    • 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)
      
        • (a: number, b: number): number
        • Parameters

          • a: number
          • b: number

          Returns number

    Returns quat

  • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

    Parameters

    • Optional begin: number

      The index of the beginning of the array.

    • Optional end: number

      The index of the end of the array.

    Returns Float32Array

  • Converts a number to a string by using the current locale.

    Returns string

  • Returns a string representation of an array.

    Returns string

  • Returns the primitive value of the specified object.

    Returns Float32Array

  • Returns an list of values in the array

    Returns IterableIterator<number>

  • Adds two quat's

    Returns

    out

    Function

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      the first operand

    • b: quat

      the second operand

    Returns quat

  • 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.

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      quat to calculate W component of

    Returns quat

  • Creates a new quat initialized with values from an existing quaternion

    Returns

    a new quaternion

    Function

    Parameters

    • a: quat

      quaternion to clone

    Returns quat

  • Calculates the conjugate of a quat If the quaternion is normalized, this function is faster than quat.inverse and produces the same result.

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      quat to calculate conjugate of

    Returns quat

  • Copy the values from one quat to another

    Returns

    out

    Function

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      the source quaternion

    Returns quat

  • Creates a new identity quat

    Returns

    a new quaternion

    Returns quat

  • Calculates the dot product of two quat's

    Returns

    dot product of a and b

    Function

    Parameters

    • a: quat

      the first operand

    • b: quat

      the second operand

    Returns number

  • Returns whether or not the quaternions have approximately the same elements in the same position.

    Returns

    True if the quaternions are equal, false otherwise.

    Parameters

    • a: quat

      The first vector.

    • b: quat

      The second vector.

    Returns boolean

  • Returns whether or not the quaternions have exactly the same elements in the same position (when compared with ===)

    Returns

    True if the quaternions are equal, false otherwise.

    Parameters

    • a: quat

      The first vector.

    • b: quat

      The second vector.

    Returns boolean

  • 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

  • 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.

        • (v: T, k: number): number
        • Parameters

          • v: T
          • k: number

          Returns number

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns Float32Array

  • Creates an array from an array-like or iterable object.

    Parameters

    • arrayLike: Iterable<number>

      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.

        • (v: number, k: number): number
        • Parameters

          • v: number
          • k: number

          Returns number

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns Float32Array

  • Creates a quaternion from the given euler angle x, y, z.

    Returns

    out

    Parameters

    • out: quat

      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.

    Returns quat

  • Creates a quaternion from the given 3x3 rotation matrix.

    NOTE: The resultant quaternion is not normalized, so you should be sure to renormalize the quaternion yourself where necessary.

    Returns

    out

    Function

    Parameters

    • out: quat

      the receiving quaternion

    • m: mat3

      rotation matrix

    Returns quat

  • Creates a new quat initialized with the given values

    Returns

    a new quaternion

    Function

    Parameters

    • x: number

      X component

    • y: number

      Y component

    • z: number

      Z component

    • w: number

      W component

    Returns quat

  • 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 providied 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.

    Returns

    Angle, in radians, of the rotation

    Parameters

    • out_axis: number[] | vec3

      Vector receiving the axis of rotation

    • q: quat

      Quaternion to be decomposed

    Returns number

  • Set a quat to the identity quaternion

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    Returns quat

  • Calculates the inverse of a quat

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      quat to calculate inverse of

    Returns quat

  • Calculates the length of a quat

    Returns

    length of a

    Function

    Parameters

    • a: quat

      vector to calculate length of

    Returns number

  • Calculates the length of a quat

    Returns

    length of a

    Function

    Parameters

    • a: quat

      vector to calculate length of

    Returns number

  • Performs a linear interpolation between two quat's

    Returns

    out

    Function

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      the first operand

    • b: quat

      the second operand

    • t: number

      interpolation amount between the two inputs

    Returns quat

  • Multiplies two quat's

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      the first operand

    • b: quat

      the second operand

    Returns quat

  • Multiplies two quat's

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      the first operand

    • b: quat

      the second operand

    Returns quat

  • Normalize a quat

    Returns

    out

    Function

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      quaternion to normalize

    Returns quat

  • Returns a new array from a set of elements.

    Parameters

    • Rest ...items: number[]

      A set of elements to include in the new array object.

    Returns Float32Array

  • Rotates a quaternion by the given angle about the X axis

    Returns

    out

    Parameters

    • out: quat

      quat receiving operation result

    • a: quat

      quat to rotate

    • rad: number

      angle (in radians) to rotate

    Returns quat

  • Rotates a quaternion by the given angle about the Y axis

    Returns

    out

    Parameters

    • out: quat

      quat receiving operation result

    • a: quat

      quat to rotate

    • rad: number

      angle (in radians) to rotate

    Returns quat

  • Rotates a quaternion by the given angle about the Z axis

    Returns

    out

    Parameters

    • out: quat

      quat receiving operation result

    • a: quat

      quat to rotate

    • rad: number

      angle (in radians) to rotate

    Returns quat

  • Sets a quaternion to represent the shortest rotation from one vector to another.

    Both vectors are assumed to be unit length.

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion.

    • a: number[] | vec3

      the initial vector

    • b: number[] | vec3

      the destination vector

    Returns quat

  • Sets a quaternion to represent the shortest rotation from one vector to another.

    Both vectors are assumed to be unit length.

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion.

    • a: number[] | vec3

      the initial vector

    • b: number[] | vec3

      the destination vector

    Returns quat

  • Scales a quat by a scalar number

    Returns

    out

    Function

    Parameters

    • out: quat

      the receiving vector

    • a: quat

      the vector to scale

    • b: number

      amount to scale the vector by

    Returns quat

  • Set the components of a quat to the given values

    Returns

    out

    Function

    Parameters

    • out: quat

      the receiving quaternion

    • x: number

      X component

    • y: number

      Y component

    • z: number

      Z component

    • w: number

      W component

    Returns quat

  • 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.

    Returns

    out

    Parameters

    • out: quat
    • view: number[] | vec3

      the vector representing the viewing direction

    • right: number[] | vec3

      the vector representing the local "right" direction

    • up: number[] | vec3

      the vector representing the local "up" direction

    Returns quat

  • 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.

    Returns

    out

    Parameters

    • out: quat

      the receiving quat

    • view: number[] | vec3

      the vector representing the viewing direction

    • right: number[] | vec3

      the vector representing the local "right" direction

    • up: number[] | vec3

      the vector representing the local "up" direction

    Returns quat

  • Sets a quat from the given angle and rotation axis, then returns it.

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    • axis: number[] | vec3

      the axis around which to rotate

    • rad: number

      the angle in radians

    Returns quat

  • Performs a spherical linear interpolation between two quat

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      the first operand

    • b: quat

      the second operand

    • t: number

      interpolation amount between the two inputs

    Returns quat

  • Performs a spherical linear interpolation with two control points

    Returns

    out

    Parameters

    • out: quat

      the receiving quaternion

    • a: quat

      the first operand

    • b: quat

      the second operand

    • c: quat

      the third operand

    • d: quat

      the fourth operand

    • t: number

      interpolation amount

    Returns quat

  • Calculates the squared length of a quat

    Returns

    squared length of a

    Function

    Parameters

    • a: quat

      vector to calculate squared length of

    Returns number

  • Calculates the squared length of a quat

    Returns

    squared length of a

    Function

    Parameters

    • a: quat

      vector to calculate squared length of

    Returns number

  • Returns a string representation of a quaternion

    Returns

    string representation of the quat

    Parameters

    • a: quat

      quat to represent as a string

    Returns string

Generated using TypeDoc