Class Vector

constructor

• new Vector(
      magnitude: number,
      angle: Angle,
      options: undefined | { digits: undefined | number },
  ): Vector

  Parameters

  • magnitude: number

    The vector's original magnitude. (This can be modified after Vector construction.)
  • angle: Angle

    The vector's original angle. (This can be modified after Vector construction.)
  • options: undefined | { digits: undefined | number }

    Vector options. Set to undefined to disable all options.

    • undefined
    • { digits: undefined | number }

      • digits: undefined | number

        Number of digits to round all values to. Set to undefined to disable rounding.

  Returns Vector

angle

magnitude

Readonlyoptions

toComponents

• toComponents(): { x: number; y: number }

  Splits the vector into its X and Y components.

  Returns { x: number; y: number }

StaticfromComponents

• fromComponents(
      __namedParameters: Coords,
      options: undefined | { digits: undefined | number },
  ): Vector

  Create a new Vector instance from its X and Y components.

  Parameters

  • __namedParameters: Coords
  • options: undefined | { digits: undefined | number }
    • undefined
    • { digits: undefined | number }

      • digits: undefined | number

        Number of digits to round all values to. Set to undefined to disable rounding.

  Returns Vector

StaticfromPoints

• fromPoints(
      point1: Coords,
      point2: Coords,
      options: undefined | { digits: undefined | number },
  ): Vector

  Create a new Vector instance by calculating the distance and angle between two points.

  Parameters

  • point1: Coords
  • point2: Coords
  • options: undefined | { digits: undefined | number }
    • undefined
    • { digits: undefined | number }

      • digits: undefined | number

        Number of digits to round all values to. Set to undefined to disable rounding.

  Returns Vector