Class Vec4

4 Dimensional Vector

Hierarchy

  • Float32Array
    • Vec4

Instance Methods

  • Returns IterableIterator<number>

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

    Returns IterableIterator<[number, number]>

  • Returns an list of keys in the array

    Returns IterableIterator<number>

  • Returns an list of values in the array

    Returns IterableIterator<number>

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

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

    Type Parameters

    • S extends number

    Parameters

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

      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.

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

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

          Returns value is S

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

  • Parameters

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

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

          Returns unknown

    • Optional thisArg: any

    Returns number

  • Returns the index of the last element in the array where predicate is true, and -1 otherwise.

    Parameters

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

      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.

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

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

          Returns unknown

    • 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

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

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

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

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

  • 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

  • Subtracts a Vec4 from this. Equivalent to Vec4.subtract(this, this, b);

    Returns

    this

    Parameters

    • b: Readonly<Vec4Like>

      The vector to subtract from this

    Returns Vec4

  • Multiplies this by a Vec4. Equivalent to Vec4.multiply(this, this, b);

    Returns

    this

    Parameters

    • b: Readonly<Vec4Like>

      The vector to multiply this by

    Returns Vec4

  • Divides this by a Vec4. Equivalent to Vec4.divide(this, this, b);

    Returns

    this

    Parameters

    • b: Readonly<Vec4Like>

      The vector to divide this by

    Returns Vec4

  • Scales this by a scalar number. Equivalent to Vec4.scale(this, this, b);

    Returns

    this

    Parameters

    • b: number

      Amount to scale this by

    Returns Vec4

  • Calculates this scaled by a scalar value then adds the result to this. Equivalent to Vec4.scaleAndAdd(this, this, b, scale);

    Returns

    this

    Parameters

    • b: Readonly<Vec4Like>

      The vector to add to this

    • scale: number

      The amount to scale b by before adding

    Returns Vec4

  • Calculates the euclidian distance between another Vec4 and this. Equivalent to Vec4.distance(this, b);

    Returns

    Distance between this and b

    Parameters

    • b: Readonly<Vec4Like>

      The vector to calculate the distance to

    Returns number

  • Calculates the squared euclidian distance between another Vec4 and this. Equivalent to Vec4.squaredDistance(this, b);

    Returns

    Squared distance between this and b

    Parameters

    • b: Readonly<Vec4Like>

      The vector to calculate the squared distance to

    Returns number

  • Negates the components of this. Equivalent to Vec4.negate(this, this);

    Returns

    this

    Returns Vec4

  • Inverts the components of this. Equivalent to Vec4.inverse(this, this);

    Returns

    this

    Returns Vec4

  • Sets each component of this to it's absolute value. Equivalent to Vec4.abs(this, this);

    Returns

    this

    Returns Vec4

  • Calculates the dot product of this and another Vec4. Equivalent to Vec4.dot(this, b);

    Returns

    Dot product of this and b

    Parameters

    • b: Readonly<Vec4Like>

      The second operand

    Returns number

  • Normalize this. Equivalent to Vec4.normalize(this, this);

    Returns

    this

    Returns Vec4

  • 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

  • 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

Static Methods

  • Creates a new Vec4 initialized with the given values

    Returns

    a new 4D vector

    Parameters

    • x: number

      X component

    • y: number

      Y component

    • z: number

      Z component

    • w: number

      W component

    Returns Vec4

  • Set the components of a Vec4 to the given values

    Returns

    out

    Parameters

    • out: Vec4Like

      the receiving vector

    • x: number

      X component

    • y: number

      Y component

    • z: number

      Z component

    • w: number

      W component

    Returns Vec4Like

  • Calculates the euclidian distance between two Vec4's

    Returns

    distance between a and b

    Parameters

    • a: Readonly<Vec4Like>

      the first operand

    • b: Readonly<Vec4Like>

      the second operand

    Returns number

  • Calculates the squared euclidian distance between two Vec4's

    Returns

    squared distance between a and b

    Parameters

    • a: Readonly<Vec4Like>

      the first operand

    • b: Readonly<Vec4Like>

      the second operand

    Returns number

  • Calculates the magnitude (length) of a Vec4

    Returns

    length of a

    Parameters

    • a: Readonly<Vec4Like>

      vector to calculate length of

    Returns number

  • Calculates the squared length of a Vec4

    Returns

    squared length of a

    Parameters

    • a: Readonly<Vec4Like>

      vector to calculate squared length of

    Returns number

  • Calculates the dot product of two Vec4's

    Returns

    dot product of a and b

    Parameters

    • a: Readonly<Vec4Like>

      the first operand

    • b: Readonly<Vec4Like>

      the second operand

    Returns number

  • Returns a string representation of a Vec4

    Returns

    string representation of the vector

    Parameters

    • a: Readonly<Vec4Like>

      vector to represent as a string

    Returns string

  • 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: Readonly<Vec4Like>

      The first vector.

    • b: Readonly<Vec4Like>

      The second vector.

    Returns boolean

  • 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: Readonly<Vec4Like>

      The first vector.

    • b: Readonly<Vec4Like>

      The second vector.

    Returns boolean

Properties

[toStringTag]: "Float32Array"
BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

buffer: ArrayBufferLike

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.

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

BYTE_LENGTH: number = ...

The number of bytes in a Vec4.

Constructors

  • Create a Vec4.

    Parameters

    • Rest ...values: number[] | [ArrayBufferLike | Readonly<Vec4Like>, number?]

    Returns Vec4

Vector components Accessors

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

    Returns number

  • set x(value: number): void
  • Parameters

    • value: number

    Returns void

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

    Returns number

  • set y(value: number): void
  • Parameters

    • value: number

    Returns void

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

    Returns number

  • set z(value: number): void
  • Parameters

    • value: number

    Returns void

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

    Returns number

  • set w(value: number): void
  • Parameters

    • value: number

    Returns void

Color components Accessors

  • get r(): number
  • The r component of the vector. Equivalent to this[0];

    Returns number

  • set r(value: number): void
  • Parameters

    • value: number

    Returns void

  • get g(): number
  • The g component of the vector. Equivalent to this[1];

    Returns number

  • set g(value: number): void
  • Parameters

    • value: number

    Returns void

  • get b(): number
  • The b component of the vector. Equivalent to this[2];

    Returns number

  • set b(value: number): void
  • Parameters

    • value: number

    Returns void

  • get a(): number
  • The a component of the vector. Equivalent to this[3];

    Returns number

  • set a(value: number): void
  • Parameters

    • value: number

    Returns void

Instance Accessors

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

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

    Returns number

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

    Returns string

Generated using TypeDoc