@tspro/ts-utils-lib
    Preparing search index...

    Class Vec

    Vec is a generic vector class with two or more coordinates.

    // Example usage:
    const a = new Vec(1, 2);
    const b = new Vec(3, 4);

    console.log(a.add(b).toString()); // Vec(4, 6)
    console.log(a.add(3, 3).toString()); // Vec(4, 5)
    console.log(a.mul(2).toString()); // Vec(2, 4)
    console.log(a.equals(b)); // false
    console.log(a.clone().equals(a)); // true
    Index

    Constructors

    • Parameters

      • ...coords: number[]

      Returns Vec

    Properties

    coords: number[]

    Accessors

    • get dim(): number

      Returns number

    • get length(): number

      Returns number

    • get x(): number

      Returns number

    • get y(): number

      Returns number

    • get z(): number

      Returns number

    Methods

    • Returns ArrayIterator<number>

    • Parameters

      Returns Vec

    • Parameters

      • ...coords: number[]

      Returns Vec

    • Parameters

      • OptionalminLength: number
      • OptionalmaxLength: number
      • OptionaldefaultDir: Vec

      Returns Vec

    • Parameters

      Returns number

    • Parameters

      • scalar: number

      Returns Vec

    • Parameters

      Returns number

    • Parameters

      Returns boolean

    • Returns number

    • Parameters

      • scalar: number

      Returns Vec

    • Parameters

      Returns Vec

    • Parameters

      • ...coords: number[]

      Returns Vec

    • Parameters

      • len: number

      Returns Vec

    • Returns { x: number; y: number; z: number }

    • Returns string

    • Parameters

      • x: number
      • y: number

      Returns Vec

    • Parameters

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

      Returns Vec

    • Parameters

      • dim: number

      Returns Vec