Hierarchy

  • Float32Array
    • vec3

Constructors

  • Parameters

    • length: number

    Returns vec3

  • Parameters

    Returns vec3

  • Parameters

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

    Returns vec3

  • Parameters

    Returns vec3

  • Returns vec3

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.

typeVec3: 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 vec3

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

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

  • 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 vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Get the angle between two 3D vectors

    Returns

    The angle in radians

    Parameters

    • a: number[] | vec3

      The first operand

    • b: number[] | vec3

      The second operand

    Returns number

  • Performs a bezier interpolation with two control points

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    • c: number[] | vec3

      the third operand

    • d: number[] | vec3

      the fourth operand

    • t: number

      interpolation amount between the two inputs

    Returns vec3

  • Math.ceil the components of a vec3

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      vector to ceil

    Returns vec3

  • Creates a new vec3 initialized with values from an existing vector

    Returns

    a new 3D vector

    Parameters

    • a: number[] | vec3

      vector to clone

    Returns vec3

  • Copy the values from one vec3 to another

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the source vector

    Returns vec3

  • Creates a new, empty vec3

    Returns

    a new 3D vector

    Returns vec3

  • Computes the cross product of two vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Calculates the euclidian distance between two vec3's

    Returns

    distance between a and b

    Parameters

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns number

  • Calculates the euclidian distance between two vec3's

    Returns

    distance between a and b

    Parameters

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns number

  • Divides two vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Divides two vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Calculates the dot product of two vec3's

    Returns

    dot product of a and b

    Parameters

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns number

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

    Returns

    True if the vectors are equal, false otherwise.

    Parameters

    • a: number[] | vec3

      The first vector.

    • b: number[] | vec3

      The second vector.

    Returns boolean

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

    Returns

    True if the vectors are equal, false otherwise.

    Parameters

    • a: number[] | vec3

      The first vector.

    • b: number[] | vec3

      The second vector.

    Returns boolean

  • Math.floor the components of a vec3

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      vector to floor

    Returns vec3

  • Perform some operation over an array of vec3s.

    Returns

    a

    Function

    Parameters

    • a: Float32Array

      the array of vectors to iterate over

    • stride: number

      Number of elements between the start of each vec3. If 0 assumes tightly packed

    • offset: number

      Number of elements to skip at the beginning of the array

    • count: number

      Number of vec3s to iterate over. If 0 iterates over entire array

    • fn: ((a: number[] | vec3, b: number[] | vec3, arg: any) => void)

      Function to call for each vector in the array

        • (a: number[] | vec3, b: number[] | vec3, arg: any): void
        • Parameters

          • a: number[] | vec3
          • b: number[] | vec3
          • arg: any

          Returns void

    • arg: any

      additional argument to pass to fn

    Returns Float32Array

  • Perform some operation over an array of vec3s.

    Returns

    a

    Function

    Parameters

    • a: Float32Array

      the array of vectors to iterate over

    • stride: number

      Number of elements between the start of each vec3. If 0 assumes tightly packed

    • offset: number

      Number of elements to skip at the beginning of the array

    • count: number

      Number of vec3s to iterate over. If 0 iterates over entire array

    • fn: ((a: number[] | vec3, b: number[] | vec3) => void)

      Function to call for each vector in the array

        • (a: number[] | vec3, b: number[] | vec3): void
        • Parameters

          Returns void

    Returns Float32Array

  • 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 new vec3 initialized with the given values

    Returns

    a new 3D vector

    Parameters

    • x: number

      X component

    • y: number

      Y component

    • z: number

      Z component

    Returns vec3

  • Performs a hermite interpolation with two control points

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    • c: number[] | vec3

      the third operand

    • d: number[] | vec3

      the fourth operand

    • t: number

      interpolation amount between the two inputs

    Returns vec3

  • Returns the inverse of the components of a vec3

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      vector to invert

    Returns vec3

  • Calculates the length of a vec3

    Returns

    length of a

    Parameters

    • a: number[] | vec3

      vector to calculate length of

    Returns number

  • Calculates the length of a vec3

    Returns

    length of a

    Parameters

    • a: number[] | vec3

      vector to calculate length of

    Returns number

  • Performs a linear interpolation between two vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    • t: number

      interpolation amount between the two inputs

    Returns vec3

  • Returns the maximum of two vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Returns the minimum of two vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Multiplies two vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Multiplies two vec3's

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Negates the components of a vec3

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      vector to negate

    Returns vec3

  • Normalize a vec3

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      vector to normalize

    Returns vec3

  • 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

  • Generates a random unit vector

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    Returns vec3

  • Generates a random vector with the given scale

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • Optional scale: number

      Length of the resulting vector. If omitted, a unit vector will be returned

    Returns vec3

  • Rotate a 3D vector around the x-axis

    Returns

    out

    Parameters

    • out: vec3

      The receiving vec3

    • a: number[] | vec3

      The vec3 point to rotate

    • b: number[] | vec3

      The origin of the rotation

    • c: number

      The angle of rotation

    Returns vec3

  • Rotate a 3D vector around the y-axis

    Returns

    out

    Parameters

    • out: vec3

      The receiving vec3

    • a: number[] | vec3

      The vec3 point to rotate

    • b: number[] | vec3

      The origin of the rotation

    • c: number

      The angle of rotation

    Returns vec3

  • Rotate a 3D vector around the z-axis

    Returns

    out

    Parameters

    • out: vec3

      The receiving vec3

    • a: number[] | vec3

      The vec3 point to rotate

    • b: number[] | vec3

      The origin of the rotation

    • c: number

      The angle of rotation

    Returns vec3

  • Math.round the components of a vec3

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      vector to round

    Returns vec3

  • Scales a vec3 by a scalar number

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the vector to scale

    • b: number

      amount to scale the vector by

    Returns vec3

  • Adds two vec3's after scaling the second operand by a scalar value

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    • scale: number

      the amount to scale b by before adding

    Returns vec3

  • Set the components of a vec3 to the given values

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • x: number

      X component

    • y: number

      Y component

    • z: number

      Z component

    Returns vec3

  • Calculates the squared euclidian distance between two vec3's

    Returns

    squared distance between a and b

    Parameters

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns number

  • Calculates the squared length of a vec3

    Returns

    squared length of a

    Parameters

    • a: number[] | vec3

      vector to calculate squared length of

    Returns number

  • Calculates the squared euclidian distance between two vec3's

    Returns

    squared distance between a and b

    Parameters

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns number

  • Calculates the squared length of a vec3

    Returns

    squared length of a

    Parameters

    • a: number[] | vec3

      vector to calculate squared length of

    Returns number

  • Returns a string representation of a vector

    Returns

    string representation of the vector

    Parameters

    • a: number[] | vec3

      vector to represent as a string

    Returns string

  • Subtracts vector b from vector a

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Subtracts vector b from vector a

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the first operand

    • b: number[] | vec3

      the second operand

    Returns vec3

  • Transforms the vec3 with a mat3.

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the vector to transform

    • m: mat3

      the 3x3 matrix to transform with

    Returns vec3

  • Transforms the vec3 with a mat4. 4th vector component is implicitly '1'

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the vector to transform

    • m: mat4

      matrix to transform with

    Returns vec3

  • Transforms the vec3 with a quat

    Returns

    out

    Parameters

    • out: vec3

      the receiving vector

    • a: number[] | vec3

      the vector to transform

    • q: quat

      quaternion to transform with

    Returns vec3

Generated using TypeDoc