Class vec2

constructor

• new vec2(x: number, y: number): vec2

  Creates a new instance of a vec2.

  Parameters

  • x: number
  • y: number

  Returns vec2

g

length

lengthSquared

r

x

y

add

• add(vec: vec2): vec2

  Returns the vector plus vec.

  Parameters

  • vec: vec2

  Returns vec2

angleTo

• angleTo(vec: vec2): number

  Returns the angle between the vector and vec.

  Parameters

  • vec: vec2

  Returns number

clampLength

• clampLength(length: number): vec2

  Returns a copy of the vector with its length clamped to length.

  Parameters

  • length: number

  Returns vec2

distance

• distance(vec: vec2): number

  Returns the distance between the vector and the vector vec.

  Parameters

  • vec: vec2

  Returns number

distanceSquared

• distanceSquared(vec: vec2): number

  Like distance(), but returns the squared distance between vectors.

  Parameters

  • vec: vec2

  Returns number

div

• div(vec: vec2): vec2

  Returns the division of the vector by the vector vec.

  Parameters

  • vec: vec2

  Returns vec2

dot

• dot(vec: vec2): number

  Returns the dot product of the vector and vec.

  Parameters

  • vec: vec2

  Returns number

Staticdown

• down(): vec2

  Returns the vector (0, -1).

  Returns vec2

equal

• equal(vec: vec2): boolean

  Returns whether this is equal to vec.

  Parameters

  • vec: vec2

  Returns boolean

Staticleft

• left(): vec2

  Returns the vector (-1, 0).

  Returns vec2

Staticlerp

• lerp(vecA: vec2, vecB: vec2, t: number): vec2

  Linearly interpolates between the two vectors vecA and vecB by the factor t.

  Parameters

  • vecA: vec2
  • vecB: vec2
  • t: number

  Returns vec2

Staticmax

• max(vecA: vec2, vecB: vec2): vec2

  Returns a new vector containing the largest value of each component in the two vectors.

  Parameters

  • vecA: vec2
  • vecB: vec2

  Returns vec2

Staticmin

• min(vecA: vec2, vecB: vec2): vec2

  Returns a new vector containing the smallest value of each component in the two vectors.

  Parameters

  • vecA: vec2
  • vecB: vec2

  Returns vec2

moveTowards

• moveTowards(point: vec2, magnitude: number): vec2

  Returns a copy of the vector moved towards the point point by the amount magnitude.

  Parameters

  • point: vec2
  • magnitude: number

  Returns vec2

mult

• mult(vec: vec2): vec2

  Returns the component-wise multiplication product of the vector and vec.

  Parameters

  • vec: vec2

  Returns vec2

normalize

• normalize(): vec2

  Returns a copy of the vector with its length scaled to 1.

  Returns vec2

Staticone

• one(): vec2

  Returns the vector (1, 1).

  Returns vec2

project

• project(vec: vec2): vec2

  Returns a copy of the vector projected onto the vector vec.

  Parameters

  • vec: vec2

  Returns vec2

projectOnPlane

• projectOnPlane(normal: vec2): vec2

  Projects the vector onto the plane represented by the normal normal.

  Parameters

  • normal: vec2

  Returns vec2

StaticrandomDirection

• randomDirection(): vec2

  Generate a random 2D direction vector. This is equivalent to a random point on a unit-radius circle.

  Returns vec2

reflect

• reflect(vec: vec2): vec2

  Returns a copy of the vector reflected across the plane defined by the normal vec.

  Parameters

  • vec: vec2

  Returns vec2

Staticright

• right(): vec2

  Returns the vector (1, 0).

  Returns vec2

scale

• scale(vec: vec2): vec2

  Returns the component-wise multiplication product of the vector and vec.

  Parameters

  • vec: vec2

  Returns vec2

sub

• sub(vec: vec2): vec2

  Returns the vector minus vec.

  Parameters

  • vec: vec2

  Returns vec2

toString

• toString(): string

  Returns a string representation of the vector.

  Returns string

uniformScale

• uniformScale(scale: number): vec2

  Multiplies the components by the number scale.

  Parameters

  • scale: number

  Returns vec2

Staticup

• up(): vec2

  Returns the vector (0, 1).

  Returns vec2

Staticzero

• zero(): vec2

  Returns the vector (0, 0).

  Returns vec2