Class Vector

constructor

• new Vector(): Vector

  Returns Vector

x

y

Staticadd

• add(vectorA: Vector, vectorB: Vector, output?: Vector): Vector

  Adds the two vectors.

  Parameters

  • vectorA: Vector
  • vectorB: Vector
  • Optionaloutput: Vector

  Returns Vector

  A new vector of vectorA and vectorB added

  Method

  add

Staticangle

• angle(vectorA: Vector, vectorB: Vector): number

  Returns the angle in radians between the two vectors relative to the x-axis.

  Parameters

  • vectorA: Vector
  • vectorB: Vector

  Returns number

  The angle in radians

  Method

  angle

Staticclone

• clone(vector: Vector): Vector

  Returns a new vector with x and y copied from the given vector.

  Parameters

  • vector: Vector

  Returns Vector

  A new cloned vector

  Method

  clone

Staticcreate

• create(x?: number, y?: number): Vector

  Creates a new vector.

  Parameters

  • Optionalx: number
  • Optionaly: number

  Returns Vector

  A new vector

  Method

  create

Staticcross

• cross(vectorA: Vector, vectorB: Vector): number

  Returns the cross-product of two vectors.

  Parameters

  • vectorA: Vector
  • vectorB: Vector

  Returns number

  The cross product of the two vectors

  Method

  cross

Staticcross3

• cross3(vectorA: Vector, vectorB: Vector, vectorC: Vector): number

  Returns the cross-product of three vectors.

  Parameters

  • vectorA: Vector
  • vectorB: Vector
  • vectorC: Vector

  Returns number

  The cross product of the three vectors

  Method

  cross3

Staticdiv

• div(vector: Vector, scalar: number): Vector

  Divides a vector and a scalar.

  Parameters

  • vector: Vector
  • scalar: number

  Returns Vector

  A new vector divided by scalar

  Method

  div

Staticdot

• dot(vectorA: Vector, vectorB: Vector): Number

  Returns the dot-product of two vectors.

  Parameters

  • vectorA: Vector
  • vectorB: Vector

  Returns Number

  The dot product of the two vectors

  Method

  dot

Staticmagnitude

• magnitude(vector: Vector): number

  Returns the magnitude (length) of a vector.

  Parameters

  • vector: Vector

  Returns number

  The magnitude of the vector

  Method

  magnitude

StaticmagnitudeSquared

• magnitudeSquared(vector: Vector): number

  Returns the magnitude (length) of a vector (therefore saving a sqrt operation).

  Parameters

  • vector: Vector

  Returns number

  The squared magnitude of the vector

  Method

  magnitudeSquared

Staticmult

• mult(vector: Vector, scalar: number): Vector

  Multiplies a vector and a scalar.

  Parameters

  • vector: Vector
  • scalar: number

  Returns Vector

  A new vector multiplied by scalar

  Method

  mult

Staticneg

• neg(vector: Vector): Vector

  Negates both components of a vector such that it points in the opposite direction.

  Parameters

  • vector: Vector

  Returns Vector

  The negated vector

  Method

  neg

Staticnormalise

• normalise(vector: Vector): Vector

  Normalises a vector (such that its magnitude is 1).

  Parameters

  • vector: Vector

  Returns Vector

  A new vector normalised

  Method

  normalise

Staticperp

• perp(vector: Vector, negate?: boolean): Vector

  Returns the perpendicular vector. Set negate to true for the perpendicular in the opposite direction.

  Parameters

  • vector: Vector
  • Optionalnegate: boolean

  Returns Vector

  The perpendicular vector

  Method

  perp

Staticrotate

• rotate(vector: Vector, angle: number): Vector

  Rotates the vector about (0, 0) by specified angle.

  Parameters

  • vector: Vector
  • angle: number

  Returns Vector

  A new vector rotated about (0, 0)

  Method

  rotate

StaticrotateAbout

• rotateAbout(
      vector: Vector,
      angle: number,
      point: Vector,
      output?: Vector,
  ): Vector

  Rotates the vector about a specified point by specified angle.

  Parameters

  • vector: Vector
  • angle: number
  • point: Vector
  • Optionaloutput: Vector

  Returns Vector

  A new vector rotated about the point

  Method

  rotateAbout

Staticsub

• sub(vectorA: Vector, vectorB: Vector, optional?: Vector): Vector

  Subtracts the two vectors.

  Parameters

  • vectorA: Vector
  • vectorB: Vector
  • Optionaloptional: Vector

  Returns Vector

  A new vector of vectorA and vectorB subtracted

  Method

  sub