Options
All
  • Public
  • Public/Protected
  • All
Menu

A 2D vector on a plane.

Hierarchy

Implements

Index

Constructors

  • new Vector(x: number, y: number): Vector
  • Parameters

    • x: number

      X component of the Vector

    • y: number

      Y component of the Vector

    Returns Vector

Properties

_x: number = 0
_y: number = 0

Accessors

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

    Returns number

  • Setting the size mutates the current vector

    warning

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

    Parameters

    • newLength: number

    Returns void

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

    Returns number

  • Set the x component, THIS MUTATES the current vector. It is usually better to create a new vector.

    warning

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

    Parameters

    • val: number

    Returns void

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

    Returns number

  • Set the y component, THIS MUTATES the current vector. It is usually better to create a new vector.

    warning

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

    Parameters

    • val: number

    Returns void

Methods

  • Adds one vector to this one modifying the original

    warning

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

    Parameters

    Returns Vector

  • 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

    • v: Vector

      The vector to cross

    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

  • Performs a dot product with another vector

    Parameters

    Returns number

  • equals(vector: Vector, tolerance?: number): boolean
  • 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

  • Returns the normal vector to this one, same as the perpendicular of length 1

    Returns Vector

  • Rotates the current vector around a point by a certain number of degrees in radians

    Parameters

    • angle: number
    • Optional anchor: Vector

    Returns Vector

  • scaleEqual(size: number): Vector
  • Scales this vector by a factor of size and modifies the original

    warning

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

    Parameters

    • size: number

    Returns Vector

  • setTo(x: number, y: number): void
  • Sets the x and y components at once, THIS MUTATES the current vector. It is usually better to create a new vector.

    warning

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

    Parameters

    • x: number
    • y: number

    Returns void

  • squareDistance(v?: Vector): number
  • 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

    warning

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

    Parameters

    • v: Vector

      The vector to subtract

    Returns Vector

  • toAngle(): number
  • toString(fixed?: number): string
  • Returns a string representation of the vector.

    Parameters

    • Optional fixed: number

    Returns string

  • fromAngle(angle: number): Vector
  • 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