mathue
    Preparing search index...

    Class Vector1

    Implements

    Index

    Properties

    dimension: 1
    const v = new Vector1(2);
    console.log(v.dimension); // 1
    elements: [number]
    const v = new Vector1(2);
    console.log(v.elements); // [1]

    Accessors

    • get x(): number

      Returns number

      const v = new Vector1(2);
      console.log(v.x); // 2
    • set x(x: number): void

      Parameters

      • x: number

      Returns void

      const v = new Vector1(2);
      v.x = 3;
      console.log(v.x); // 3

    Constructors

    Factory Methods

    • Creates a zero vector instance

      Returns Vector1

      new zero vector instance

      const v = Vector1.zero();
      console.log(v.x); // 0
    • Creates a all ones vector instance

      Returns Vector1

      new one vector instance

      const v = Vector1.one();
      console.log(v.x); // 1

    Methods

    • Sets x component (mutate this)

      Parameters

      • x: number

      Returns Vector1

      this instance, for method chaining

    • Creates new instance has same element (pure)

      Returns Vector1

      new cloned vector instance

      const v = new Vector1(2);
      const c = v.clone();
      console.log(c.x); // 2
    • Determines if this vector is the zero vector

      Returns boolean

      true if this vector is exactly zero, false otherwise

      const zero = Vector1.zero();
      const one = Vector1.one();
      console.log(zero.isZero()); // true
      console.log(one.isZero()); // false
    • Sets element value (mutates this)

      Parameters

      • x: number

        element value

      Returns Vector1

      this instance, for method chaining

      const v = new Vector1(2);
      v.set(3);
      console.log(v.x); // 3
    • Copies element value from other vector (mutates this)

      Parameters

      Returns Vector1

      this instance, for method chaining

      const v1 = new Vector1(1);
      const v2 = new Vector1(2);
      v1.copy(v2);
      console.log(v1.x); // 2
      console.log(v2.x); // 2
    • Adds by other vector (mutates this)

      Parameters

      Returns Vector1

      this instance, for method chaining

      const v1 = new Vector1(2);
      const v2 = new Vector1(3);
      v1.add(v2);
      console.log(v1.x); // 5
      console.log(v2.x); // 3
    • Subtracts by other vector (mutates this)

      Parameters

      Returns Vector1

      this instance, for method chaining

      const v1 = new Vector1(2);
      const v2 = new Vector1(3);
      v1.subtract(v2);
      console.log(v1.x); // -1
      console.log(v2.x); // 3
    • Multiplies element by scalar (mutates this)

      Parameters

      • scalar: number

      Returns Vector1

      this instance, for method chaining

      const v = new Vector1(2);
      v.multiplyScalar(3);
      console.log(v.x); // 6
    • Divides element by scalar (mutates this)

      Parameters

      • scalar: number

      Returns Vector1

      this instance, for method chaining

      const v = new Vector1(6);
      v.divideScalar(2);
      console.log(v.x); // 3
    • Calculates the length of this vector

      Returns number

      the length of this vector (always non-negative)

      const v = new Vector1(2);
      console.log(v.length()); // 2
    • Normalizes this vector to length 1

      Returns Vector1

      this instance, for method chaining

      const v = new Vector1(-2);
      v.normalize();
      console.log(v.x); // -1