A 2D vector on a plane.

Hierarchy

Constructors

Properties

_x: number = 0
_y: number = 0

Accessors

  • get size(): number
  • The size (magnitude) of the Vector

    Returns number

  • set size(newLength): void
  • Setting the size mutates the current vector

    Parameters

    • newLength: number

    Returns void

    Warning

    Can be used to set the size of the vector, be very careful using this, mutating vectors can cause hard to find bugs

  • get x(): number
  • Get the x component of the vector

    Returns number

  • set x(val): void
  • Set the x component, THIS MUTATES the current vector. It is usually better to create a new vector.

    Parameters

    • val: number

    Returns void

    Warning

    Be very careful setting components on shared vectors, mutating shared vectors can cause hard to find bugs

  • get y(): number
  • Get the y component of the vector

    Returns number

  • set y(val): void
  • Set the y component, THIS MUTATES the current vector. It is usually better to create a new vector.

    Parameters

    • val: number

    Returns void

    Warning

    Be very careful setting components on shared vectors, mutating shared vectors can cause hard to find bugs

Methods

  • Adds one vector to this one modifying the original

    Parameters

    Returns Vector

    Warning

    Be very careful using this, mutating vectors can cause hard to find bugs

  • Performs a 2D cross product with scalar. 2D cross products with a scalar return a vector.

    Parameters

    • v: number

      The scalar to cross

    Returns Vector

  • Performs a 2D cross product with another vector. 2D cross products return a scalar value not a vector.

    Parameters

    Returns number

  • The distance to another vector. If no other Vector is specified, this will return the [[magnitude]].

    Parameters

    • Optional v: Vector

      The other vector. Leave blank to use origin vector.

    Returns number

  • Compares this point against another and tests for equality

    Parameters

    • vector: Vector

      The other point to compare to

    • tolerance: number = 0.001

      Amount of euclidean distance off we are willing to tolerate

    Returns boolean

  • Scales this vector by a factor of size and modifies the original

    Parameters

    • size: number

    Returns Vector

    Warning

    Be very careful using this, mutating vectors can cause hard to find bugs

  • Sets the x and y components at once, THIS MUTATES the current vector. It is usually better to create a new vector.

    Parameters

    • x: number
    • y: number

    Returns void

    Warning

    Be very careful using this, mutating vectors can cause hard to find bugs

  • Subtracts a vector from another, if you subtract vector B.sub(A) the resulting vector points from A -> B

    Parameters

    • v: Vector

      The vector to subtract

    Returns Vector

  • Subtracts a vector from this one modifying the original

    Parameters

    • v: Vector

      The vector to subtract

    Returns Vector

    Warning

    Be very careful using this, mutating vectors can cause hard to find bugs

  • Returns a string representation of the vector.

    Parameters

    • Optional fixed: number

    Returns string

  • Returns a vector of unit length in the direction of the specified angle in Radians.

    Parameters

    • angle: number

      The angle to generate the vector

    Returns Vector

  • Checks if vector is not null, undefined, or if any of its components are NaN or Infinity.

    Parameters

    Returns boolean