mathue
    Preparing search index...

    Class Vector4

    Implements

    Index

    Properties

    dimension: 4
    const v = new Vector4(0, 1, 2, 3);
    console.log(v.dimension); // 4
    elements: [number, number, number, number]
    const v = new Vector4(0, 1, 2, 3);
    console.log(v.elements); // [0, 1, 2, 3]

    Accessors

    • get x(): number

      Returns number

      const v = new Vector4(0, 1, 2, 3);
      console.log(v.x); // 0
    • set x(x: number): void

      Parameters

      • x: number

      Returns void

      const v = new Vector4(0, 1, 2, 3);
      v.x = 5;
      console.log(v.x); // 5
    • get y(): number

      Returns number

      const v = new Vector4(0, 1, 2, 3);
      console.log(v.y); // 1
    • set y(y: number): void

      Parameters

      • y: number

      Returns void

      const v = new Vector4(0, 1, 2, 3);
      v.y = 5;
      console.log(v.y); // 5
    • get z(): number

      Returns number

      const v = new Vector4(0, 1, 2, 3);
      console.log(v.z); // 2
    • set z(z: number): void

      Parameters

      • z: number

      Returns void

      const v = new Vector4(0, 1, 2, 3);
      v.z = 5;
      console.log(v.z); // 5
    • get w(): number

      Returns number

      const v = new Vector4(0, 1, 2, 3);
      console.log(v.w); // 3
    • set w(w: number): void

      Parameters

      • w: number

      Returns void

      const v = new Vector4(0, 1, 2, 3);
      v.w = 5;
      console.log(v.w); // 5

    Constructors

    • Parameters

      • x: number
      • y: number
      • z: number
      • w: number

      Returns Vector4

      const v = new Vector4(0, 1, 2, 3);
      

    Factory Methods

    • Creates a zero vector instance

      Returns Vector4

      new zero vector instance

      const v = Vector4.zero();
      console.log(v); // (0, 0, 0, 0)
    • Creates all ones vector instance

      Returns Vector4

      new all ones vector instance

      const v = Vector4.one();
      console.log(v); // (1, 1, 1, 1)

    Methods

    • Sets x component (mutate this)

      Parameters

      • x: number

      Returns Vector4

      this instance, for method chaining

    • Sets y component (mutate this)

      Parameters

      • y: number

      Returns Vector4

      this instance, for method chaining

    • Sets z component (mutate this)

      Parameters

      • z: number

      Returns Vector4

      this instance, for method chaining

    • Sets w component (mutate this)

      Parameters

      • w: number

      Returns Vector4

      this instance, for method chaining

    • Creates new instance has same elements (pure)

      Returns Vector4

      new cloned vector instance

      const v = new Vector4(0, 1, 2, 3);
      const c = v.clone();
      console.log(c); // (0, 1, 2, 3);
    • Determines if this vector is the zero vector (all components are zero)

      Returns boolean

      true if this vector is exactly zero, false otherwise

      const zero = Vector4.zero();
      const ones = Vector4.one();
      console.log(zero.isZero()); // true
      console.log(ones.isZero()); // false
    • Sets all elements (mutates this)

      Parameters

      • x: number
      • y: number
      • z: number
      • w: number

      Returns void

      this instance, for method chaining

      const v = new Vector4(0, 1, 2, 3);
      v.set(5, 6, 7, 8);
      console.log(v); // (5, 6, 7, 8)
    • Copies all elements from other vector (mutates this)

      Parameters

      Returns void

      this instance, for method chaining

      const v1 = new Vector4(0, 1, 2, 3);
      const v2 = new Vector4(5, 6, 7, 8);
      v1.copy(v2);
      console.log(v1); // (5, 6, 7, 8)
      console.log(v2); // (5, 6, 7, 8)
    • Adds by other vector (mutates this)

      Parameters

      Returns Vector4

      this instance, for method chaining

      const v1 = new Vector4(0, 1, 2, 3);
      const v2 = new Vector4(5, 6, 7, 8);
      v1.add(v2);
      console.log(v1); // (5, 7, 9, 11)
      console.log(v2); // (5, 6, 7, 8)
    • Subtracts by other vector (mutates this)

      Parameters

      Returns Vector4

      this instance, for method chaining

      const v1 = new Vector4(0, 1, 2, 3);
      const v2 = new Vector4(5, 6, 7, 8);
      v1.subtract(v2);
      console.log(v1); // (-5, -5, -5, -5)
      console.log(v2); // (5, 6, 7, 8)
    • Multiplies all elements by scalar (mutates this)

      Parameters

      • scalar: number

      Returns Vector4

      this instance, for method chaining

      const v = new Vector4(0, 1, 2, 3);
      v.multiplyScalar(2);
      console.log(v); // (0, 2, 4, 6)
    • Divides all elements by scalar (mutates this)

      Parameters

      • scalar: number

      Returns Vector4

      this instance, for method chaining

      const v = new Vector4(0, 1, 2, 3);
      v.divideScalar(2);
      console.log(v); // (0, 0.5, 1, 1.5)
    • Calculates the length of this vector (pure)

      Returns number

      the length of this vector (always non-negative)

      const v = new Vector4(1, 2, 2, 4);
      console.log(v.length()); // 5
    • Normalizes this vector to length 1 (mutates this)

      Returns Vector4

      this instance, for method chaining

      const v = new Vector4(1, 2, 2, 4);
      v.normalize();
      console.log(v); // (1/5, 2/5, 2/5, 4/5)