Class Vec2

2D vector used for positions, velocities, forces, and other 2D quantities.

Supports object pooling via Vec2.get() / dispose(), weak references that auto-dispose after a single use, and immutability guards.

Converted from nape-compiled.js lines 23448–27180.

Index

Constructors

constructor

new Vec2(x?: number, y?: number): Vec2
Creates a Vec2 with the given components. Defaults to (0, 0).
Parameters
- x: number = 0
  The x component (default 0).
- y: number = 0
  The y component (default 0).
Returns Vec2
- Defined in src/geom/Vec2.ts:41

Accessors

angle

get angle(): number
Angle of the vector in radians, measured counter-clockwise from the +x axis. Returns 0 for the zero vector.

Returns number
- Defined in src/geom/Vec2.ts:471
set angle(value: number): void
Setting angle preserves the vector's magnitude and rotates it to the given angle.
Parameters
- value: number
  The desired angle in radians. Must not be NaN.
Returns void
- Defined in src/geom/Vec2.ts:488

length

get length(): number
Magnitude (Euclidean length) of the vector.

Returns number
- Defined in src/geom/Vec2.ts:435
set length(value: number): void
Setting length scales the vector to the given magnitude. Throws if the vector is zero-length.
Parameters
- value: number
  The desired magnitude. Must not be NaN.
Returns void
- Defined in src/geom/Vec2.ts:449

x

get x(): number
The x component.

Returns number
- Defined in src/geom/Vec2.ts:393
set x(value: number): void
The x component.
Parameters
- value: number
Returns void
- Defined in src/geom/Vec2.ts:400

y

get y(): number
The y component.

Returns number
- Defined in src/geom/Vec2.ts:414
set y(value: number): void
The y component.
Parameters
- value: number
Returns void
- Defined in src/geom/Vec2.ts:421

Methods

add

add(vector: Vec2, weak?: boolean): Vec2
Return a new Vec2 equal to this + other.
Parameters
- vector: Vec2
  The Vec2 to add.
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A new Vec2 with components (this.x + other.x, this.y + other.y).
- Defined in src/geom/Vec2.ts:701

addeq

addeq(vector: Vec2): this
Add another Vec2 to this in-place (this += other).
Parameters
- vector: Vec2
  The Vec2 to add.
Returns this
this for chaining.
- Defined in src/geom/Vec2.ts:791

addMul

addMul(vector: Vec2, scalar: number, weak?: boolean): Vec2
Return a new Vec2 equal to this + other × scalar.
Parameters
- vector: Vec2
  The Vec2 to scale and add.
- scalar: number
  The multiplier applied to vector before addition.
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A new Vec2 with components (this.x + vector.x * scalar, this.y + vector.y * scalar).
- Defined in src/geom/Vec2.ts:726

clone

clone(): Vec2
Return a new Vec2 with the same components. Alias for copy().

Returns Vec2
A new Vec2 with the same x and y values.
- Defined in src/geom/Vec2.ts:563

copy

copy(weak?: boolean): Vec2
Return a new Vec2 with the same components.
Parameters
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A copy of this vector.
- Defined in src/geom/Vec2.ts:595

cross

cross(vector: Vec2): number
2D cross product (this.x × other.y − this.y × other.x). Returns a scalar.
Parameters
- vector: Vec2
  The other Vec2.
Returns number
The scalar cross product.
- Defined in src/geom/Vec2.ts:880

dispose

dispose(): void
Return this Vec2 to the object pool. Throws if already disposed or immutable.

Returns void
- Defined in src/geom/Vec2.ts:913

dot

dot(vector: Vec2): number
Dot product of this and another Vec2.
Parameters
- vector: Vec2
  The other Vec2.
Returns number
this.x * other.x + this.y * other.y.
- Defined in src/geom/Vec2.ts:858

equals

equals(other: Vec2, epsilon?: number): boolean
Check whether this Vec2 is component-wise equal to another, within an optional epsilon tolerance.
Parameters
- other: Vec2
  The Vec2 to compare against.
- epsilon: number = 0
  Maximum allowed difference per component (default 0).
Returns boolean
true if both components differ by at most epsilon.
- Defined in src/geom/Vec2.ts:574

lsq

lsq(): number
Returns the squared magnitude. Faster than length as it avoids a square root.

Returns number
x² + y².
- Defined in src/geom/Vec2.ts:513

mul

mul(scalar: number, weak?: boolean): Vec2
Return a new Vec2 equal to this × scalar.
Parameters
- scalar: number
  The multiplier.
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A new Vec2 with components (this.x * scalar, this.y * scalar).
- Defined in src/geom/Vec2.ts:774

muleq

muleq(scalar: number): this
Multiply this Vec2 by a scalar in-place (this ×= scalar).
Parameters
- scalar: number
  The multiplier.
Returns this
this for chaining.
- Defined in src/geom/Vec2.ts:839

normalise

normalise(): this
Normalise this vector to unit length in-place. Throws for zero-length vectors.

Returns this
this for chaining.
- Defined in src/geom/Vec2.ts:658

perp

perp(weak?: boolean): Vec2
Return the perpendicular vector, rotated 90° counter-clockwise.
Parameters
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A new Vec2 with components (-this.y, this.x).
- Defined in src/geom/Vec2.ts:901

reflect

reflect(vec: Vec2, weak?: boolean): Vec2
Reflect vec about this vector as a normal axis.
Parameters
- vec: Vec2
  The Vec2 to reflect.
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A new Vec2 that is the reflection of vec about this vector.
- Defined in src/geom/Vec2.ts:633

rotate

rotate(angle: number): this
Rotate this vector by angle radians in-place.
Parameters
- angle: number
  The rotation angle in radians.
Returns this
this for chaining.
- Defined in src/geom/Vec2.ts:609

set

set(vector: Vec2): this
Copy another Vec2's components into this vector in-place.
Parameters
- vector: Vec2
  The source Vec2 to copy from.
Returns this
this for chaining.
- Defined in src/geom/Vec2.ts:527

setxy

setxy(x: number, y: number): this
Set both components at once in-place.
Parameters
- x: number
  The new x component.
- y: number
  The new y component.
Returns this
this for chaining.
- Defined in src/geom/Vec2.ts:551

sub

sub(vector: Vec2, weak?: boolean): Vec2
Return a new Vec2 equal to this − other.
Parameters
- vector: Vec2
  The Vec2 to subtract.
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A new Vec2 with components (this.x - other.x, this.y - other.y).
- Defined in src/geom/Vec2.ts:750

subeq

subeq(vector: Vec2): this
Subtract another Vec2 from this in-place (this -= other).
Parameters
- vector: Vec2
  The Vec2 to subtract.
Returns this
this for chaining.
- Defined in src/geom/Vec2.ts:815

toString

toString(): string
String representation in the form { x: … y: … }.

Returns string
A human-readable string of this vector's components.
- Defined in src/geom/Vec2.ts:948

unit

unit(weak?: boolean): Vec2
Return a new unit-length vector with the same direction. Throws for zero-length vectors.
Parameters
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A normalised copy of this vector.
- Defined in src/geom/Vec2.ts:681

`Static`distance

distance(a: Vec2, b: Vec2): number
Euclidean distance between two Vec2s.
Parameters
- a: Vec2
  The first Vec2.
- b: Vec2
  The second Vec2.
Returns number
The distance sqrt((a.x - b.x)² + (a.y - b.y)²).
- Defined in src/geom/Vec2.ts:364

`Static`dsq

dsq(a: Vec2, b: Vec2): number
Squared Euclidean distance between two Vec2s. Avoids a square root when only comparison is needed.
Parameters
- a: Vec2
  The first Vec2.
- b: Vec2
  The second Vec2.
Returns number
The squared distance (a.x - b.x)² + (a.y - b.y)².
- Defined in src/geom/Vec2.ts:333

`Static`eq

eq(a: Vec2, b: Vec2, epsilon?: number): boolean
Check whether two Vec2s are component-wise equal, within an optional epsilon tolerance. Disposes weak arguments after comparison.
Parameters
- a: Vec2
  The first Vec2.
- b: Vec2
  The second Vec2.
- epsilon: number = 0
  Maximum allowed difference per component (default 0).
Returns boolean
true if both components differ by at most epsilon.
- Defined in src/geom/Vec2.ts:302

`Static`fromAngle

fromAngle(radians: number, weak?: boolean): Vec2
Create a unit Vec2 pointing in the given direction (angle in radians). Equivalent to Vec2.fromPolar(1, radians).
Parameters
- radians: number
  The angle in radians, measured counter-clockwise from the +x axis.
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A unit Vec2 at the given angle.
- Defined in src/geom/Vec2.ts:256

`Static`fromPolar

fromPolar(length: number, angle: number, weak?: boolean): Vec2
Create a Vec2 from polar coordinates (length and angle in radians).
Parameters
- length: number
  The magnitude of the resulting vector.
- angle: number
  The angle in radians, measured counter-clockwise from the +x axis.
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A new Vec2 with components (length * cos(angle), length * sin(angle)).
Example
```
const v = Vec2.fromPolar(1, Math.PI / 4); // 45-degree unit vector
```
- Defined in src/geom/Vec2.ts:236

`Static`get

get(x?: number, y?: number, weak?: boolean): Vec2
Allocate a Vec2 from the public object pool. If weak is true, the vector auto-disposes after a single API call.
Parameters
- x: number = 0
  The x component (default 0).
- y: number = 0
  The y component (default 0).
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A pooled or newly created Vec2.
Example
```
const v = Vec2.get(3, 4);
// use v ...
v.dispose();
```
- Defined in src/geom/Vec2.ts:205

`Static`lerp

lerp(a: Vec2, b: Vec2, t: number, weak?: boolean): Vec2
Linearly interpolate between two Vec2s. Returns a + t * (b - a). Disposes weak arguments after use.
Parameters
- a: Vec2
  The start Vec2 (t = 0).
- b: Vec2
  The end Vec2 (t = 1).
- t: number
  The interpolation factor (typically 0–1, but not clamped).
- weak: boolean = false
  If true, the returned Vec2 is auto-disposed after one use (default false).
Returns Vec2
A new Vec2 at the interpolated position.
- Defined in src/geom/Vec2.ts:270

`Static`weak

weak(x?: number, y?: number): Vec2
Allocate a weak Vec2 (auto-disposes after a single use).
Parameters
- x: number = 0
  The x component (default 0).
- y: number = 0
  The y component (default 0).
Returns Vec2
A weak, pooled Vec2 that is automatically disposed after one API call.
- Defined in src/geom/Vec2.ts:219

Class Vec2

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Vec2

Accessors

angle

Returns number

Parameters

Returns void

length

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

add

Parameters

Returns Vec2

addeq

Parameters

Returns this

addMul

Parameters

Returns Vec2

clone

Returns Vec2

copy

Parameters

Returns Vec2

cross

Parameters

Returns number

dispose

Returns void

dot

Parameters

Returns number

equals

Parameters

Returns boolean

lsq

Returns number

mul

Parameters

Returns Vec2

muleq

Parameters

Returns this

normalise

Returns this

perp

Parameters

Returns Vec2

reflect

Parameters

Returns Vec2

rotate

Parameters

Returns this

set

Parameters

Returns this

setxy

Parameters

Returns this

sub

Parameters

Returns Vec2

`Static`distance

`Static`dsq

`Static`eq

`Static`fromAngle

`Static`fromPolar

`Static`get

`Static`lerp

`Static`weak