Class vec2

2D vector with x and y components, used for 2D positions, directions, and math operations.

Constructors

constructor

new vec2(x: number, y: number): vec2
Constructs a vec2 with the given x and y values.
Parameters
- x: number
- y: number
Returns vec2

Properties

g

g: number

Alias for the y component.

length

length: number

Magnitude of the vector.

lengthSquared

lengthSquared: number

Squared magnitude of the vector.

r

r: number

Alias for the x component.

x

x: number

Horizontal component of the vector.

y

y: number

Vertical component of the vector.

Methods

add

add(vec: vec2): vec2
Returns a new vec2 that is the sum of this and the given vector.
Parameters
- vec: vec2
Returns vec2

addInPlace

addInPlace(vec: vec2): void
Adds the given vector to this vector in place.
Parameters
- vec: vec2
Returns void

angleTo

angleTo(vec: vec2): number
Returns the angle in radians between this vector and the given vector.
Parameters
- vec: vec2
Returns number

clampLength

clampLength(length: number): vec2
Returns a new vec2 with its length clamped to the given maximum.
Parameters
- length: number
Returns vec2

clampLengthInPlace

clampLengthInPlace(length: number): void
Clamps the length of this vector to the given maximum in place.
Parameters
- length: number
Returns void

clone

clone(): vec2
Returns a new vec2 with the same x and y values.

Returns vec2

copyFrom

copyFrom(source: vec2 | vec3 | vec4): void
Copies x and y values from the given vector into this vector.
Parameters
- source: vec2 | vec3 | vec4
Returns void

distance

distance(vec: vec2): number
Returns the distance between this vector and the given vector.
Parameters
- vec: vec2
Returns number

distanceSquared

distanceSquared(vec: vec2): number
Returns the squared distance between this vector and the given vector.
Parameters
- vec: vec2
Returns number

div

div(vec: vec2): vec2
Returns a new vec2 that is this vector divided component-wise by the given vector.
Parameters
- vec: vec2
Returns vec2

divInPlace

divInPlace(vec: vec2): void
Divides this vector component-wise by the given vector in place.
Parameters
- vec: vec2
Returns void

dot

dot(vec: vec2): number
Returns the dot product of this vector and the given vector.
Parameters
- vec: vec2
Returns number

`Static`down

down(): vec2
Static vec2 pointing in the negative y direction (0, -1).

Returns vec2

equal

equal(vec: vec2): boolean
Returns true if this vector and the given vector have equal x and y values.
Parameters
- vec: vec2
Returns boolean

fill

fill(scalar: number): void
Sets all components of this vector to the given scalar value.
Parameters
- scalar: number
Returns void

`Static`left

left(): vec2
Static vec2 pointing in the negative x direction (-1, 0).

Returns vec2

`Static`lerp

lerp(from: vec2, to: vec2, t: number): vec2
Returns a new vec2 linearly interpolated between two vectors by the given factor.
Parameters
- from: vec2
- to: vec2
- t: number
Returns vec2

lerpInPlace

lerpInPlace(target: vec2, t: number): void
Linearly interpolates this vector toward the target vector by the given factor in place.
Parameters
- target: vec2
- t: number
Returns void

`Static`max

max(a: vec2, b: vec2): vec2
Returns a vec2 with the component-wise maximum of two vectors.
Parameters
- a: vec2
- b: vec2
Returns vec2

`Static`min

min(a: vec2, b: vec2): vec2
Returns a vec2 with the component-wise minimum of two vectors.
Parameters
- a: vec2
- b: vec2
Returns vec2

moveTowards

moveTowards(target: vec2, step: number): vec2
Returns a new vec2 moved from this vector toward the target by at most the given max distance.
Parameters
- target: vec2
- step: number
Returns vec2

moveTowardsInPlace

moveTowardsInPlace(point: vec2, magnitude: number): void
Moves this vector toward the target by at most the given max distance in place.
Parameters
- point: vec2
- magnitude: number
Returns void

mult

mult(vec: vec2): vec2
Returns a new vec2 that is this vector multiplied component-wise by the given vector.
Parameters
- vec: vec2
Returns vec2

multInPlace

multInPlace(vec: vec2): void
Multiplies this vector component-wise by the given vector in place.
Parameters
- vec: vec2
Returns void

normalize

normalize(): vec2
Returns a new vec2 with the same direction but unit length.

Returns vec2

normalizeInPlace

normalizeInPlace(): void
Normalizes this vector to unit length in place.

Returns void

`Static`one

one(): vec2
Static vec2 with all components set to 1.

Returns vec2

project

project(onto: vec2): vec2
Returns the projection of this vector onto the given vector.
Parameters
- onto: vec2
Returns vec2

projectInPlace

projectInPlace(onto: vec2): void
Projects this vector onto the given vector in place.
Parameters
- onto: vec2
Returns void

projectOnPlane

projectOnPlane(planeNormal: vec2): vec2
Returns this vector projected onto the plane defined by the given normal.
Parameters
- planeNormal: vec2
Returns vec2

projectOnPlaneInPlace

projectOnPlaneInPlace(planeNormal: vec2): void
Projects this vector onto the plane defined by the given normal in place.
Parameters
- planeNormal: vec2
Returns void

`Static`randomUnitVector

randomUnitVector(): vec2
Returns a random unit vec2.

Returns vec2

reflect

reflect(planeNormal: vec2): vec2
Returns the reflection of this vector off the surface defined by the given normal.
Parameters
- planeNormal: vec2
Returns vec2

reflectInPlace

reflectInPlace(planeNormal: vec2): void
Reflects this vector off the surface defined by the given normal in place.
Parameters
- planeNormal: vec2
Returns void

`Static`right

right(): vec2
Static vec2 pointing in the positive x direction (1, 0).

Returns vec2

scale

scale(vec: vec2): vec2
Returns a new vec2 scaled by the given scalar.
Parameters
- vec: vec2
Returns vec2

scaleInPlace

scaleInPlace(vec: vec2): void
Scales this vector by the given scalar in place.
Parameters
- vec: vec2
Returns void

setRandomUnitVector

setRandomUnitVector(): void
Sets this vector to a random unit vector.

Returns void

setXY

setXY(x?: number, y?: number): void
Sets the x and y components of this vector.
Parameters
- Optionalx: number
- Optionaly: number
Returns void

sub

sub(vec: vec2): vec2
Returns a new vec2 that is this vector minus the given vector.
Parameters
- vec: vec2
Returns vec2

subInPlace

subInPlace(vec: vec2): void
Subtracts the given vector from this vector in place.
Parameters
- vec: vec2
Returns void

toString

toString(): string
Returns a string representation of this vector.

Returns string

uniformScale

uniformScale(scale: number): vec2
Returns a new vec2 uniformly scaled by the given scalar.
Parameters
- scale: number
Returns vec2

uniformScaleInPlace

uniformScaleInPlace(scale: number): void
Uniformly scales this vector by the given scalar in place.
Parameters
- scale: number
Returns void

`Static`up

up(): vec2
Static vec2 pointing in the positive y direction (0, 1).

Returns vec2

`Static`zero

zero(): vec2
Static vec2 with all components set to 0.

Returns vec2