Class Vec2

constructor

• new Vec2(x?: number | Vector2, y?: number): Vec2

  Parameters

  • x: number | Vector2 = 0
  • Optionaly: number

  Returns Vec2

x

y

abs

• abs(): Vec2

  Set each component to its absolute value. Mutates and returns this.

  Returns Vec2

add

• add(v: Vector2): Vec2

  Per-axis add. Mutates and returns this.

  Parameters

  • v: Vector2

  Returns Vec2

• add(x: number, y?: number): Vec2

  Per-axis add. Mutates and returns this.

  Parameters

  • x: number
  • Optionaly: number

  Returns Vec2

angle

• angle(other?: Vector2): number

  Angle in radians. No arg: angle of this from origin. With other: angle from this toward other.

  Parameters

  • Optionalother: Vector2

  Returns number

ceil

• ceil(): Vec2

  Round each component up. Mutates and returns this.

  Returns Vec2

clamp

• clamp(x: [number, number], y?: [number, number]): Vec2

  Clamp each axis to its [min, max] range. y defaults to x. Mutates and returns this.

  Parameters

  • x: [number, number]
  • y: [number, number] = x

  Returns Vec2

clone

• clone(): Vec2

  New Vec2 with the same components.

  Returns Vec2

distance

• distance(other: Vector2): number

  Euclidean distance to other.

  Parameters

  • other: Vector2

  Returns number

distanceManhattan

• distanceManhattan(other: Vector2): number

  Manhattan distance (|dx| + |dy|) to other.

  Parameters

  • other: Vector2

  Returns number

div

• div(v: Vector2): Vec2

  Per-axis divide. Mutates and returns this.

  Parameters

  • v: Vector2

  Returns Vec2

• div(x: number, y?: number): Vec2

  Per-axis divide. Mutates and returns this.

  Parameters

  • x: number
  • Optionaly: number

  Returns Vec2

dotProduct

• dotProduct(other: Vector2): number

  Dot product with other.

  Parameters

  • other: Vector2

  Returns number

equals

• equals(v: Vector2): boolean

  Approximate equality (within approxEqual tolerance). Scalar broadcasts.

  Parameters

  • v: Vector2

  Returns boolean

• equals(x: number, y?: number): boolean

  Approximate equality (within approxEqual tolerance). Scalar broadcasts.

  Parameters

  • x: number
  • Optionaly: number

  Returns boolean

floor

• floor(): Vec2

  Round each component down. Mutates and returns this.

  Returns Vec2

isValid

• isValid(): boolean

  true when both components are finite (rules out NaN and ±Infinity).

  Returns boolean

length

• length(): number

  Euclidean magnitude (sqrt(x² + y²)).

  Returns number

lengthManhattan

• lengthManhattan(): number

  Manhattan magnitude (|x| + |y|).

  Returns number

map

• map(callback: (value: number, index: number) => number): Vec2

  Apply callback to each component (index is 0 for x, 1 for y). Mutates and returns this.

  Parameters

  • callback: (value: number, index: number) => number

  Returns Vec2

  Example

  new Vec2(3.6, -2.1).map(Math.trunc);   // Vec2 { x: 3, y: -2 }
  new Vec2(2, 5).map((v, i) => v * (i + 1)); // Vec2 { x: 2, y: 10 }
  Copy

max

• max(): number

  Larger of the two components.

  Returns number

min

• min(): number

  Smaller of the two components.

  Returns number

mod

• mod(v: Vector2): Vec2

  Per-axis Euclidean modulo (result sign matches the divisor). Mutates and returns this.

  Parameters

  • v: Vector2

  Returns Vec2

• mod(x: number, y?: number): Vec2

  Per-axis Euclidean modulo (result sign matches the divisor). Mutates and returns this.

  Parameters

  • x: number
  • Optionaly: number

  Returns Vec2

mult

• mult(v: Vector2): Vec2

  Per-axis multiply. Mutates and returns this.

  Parameters

  • v: Vector2

  Returns Vec2

• mult(x: number, y?: number): Vec2

  Per-axis multiply. Mutates and returns this.

  Parameters

  • x: number
  • Optionaly: number

  Returns Vec2

negate

• negate(): Vec2

  Flip the sign of both components (same as mult(-1)). Mutates and returns this.

  Returns Vec2

normalize

• normalize(): Vec2

  Scale to unit length. Zero-length vectors are left untouched and warn (throttled). Mutates and returns this.

  Returns Vec2

normalizeManhattan

• normalizeManhattan(): Vec2

  Scale so |x| + |y| === 1. Zero-length vectors are left untouched. Mutates and returns this.

  Returns Vec2

rem

• rem(v: Vector2): Vec2

  Per-axis remainder (JavaScript %, sign follows the dividend). Mutates and returns this.

  Parameters

  • v: Vector2

  Returns Vec2

• rem(x: number, y?: number): Vec2

  Per-axis remainder (JavaScript %, sign follows the dividend). Mutates and returns this.

  Parameters

  • x: number
  • Optionaly: number

  Returns Vec2

round

• round(): Vec2

  Round each component to the nearest integer. Mutates and returns this.

  Returns Vec2

set

• set(v: Vector2): Vec2

  Replace components. Mutates and returns this.

  Parameters

  • v: Vector2

  Returns Vec2

• set(x: number, y?: number): Vec2

  Replace components. Mutates and returns this.

  Parameters

  • x: number
  • Optionaly: number

  Returns Vec2

sub

• sub(v: Vector2): Vec2

  Per-axis subtract. Mutates and returns this.

  Parameters

  • v: Vector2

  Returns Vec2

• sub(x: number, y?: number): Vec2

  Per-axis subtract. Mutates and returns this.

  Parameters

  • x: number
  • Optionaly: number

  Returns Vec2

toArray

• toArray(): [number, number]

  Tuple [x, y].

  Returns [number, number]

toRectAddPos

• toRectAddPos(v: Vector2): Rect

  Build a Rect with the argument as position and this as size.

  Parameters

  • v: Vector2

  Returns Rect

• toRectAddPos(x: number, y?: number): Rect

  Build a Rect with the argument as position and this as size.

  Parameters

  • x: number
  • Optionaly: number

  Returns Rect

toRectAddSize

• toRectAddSize(v: Vector2): Rect

  Build a Rect with this as position and the argument as size.

  Parameters

  • v: Vector2

  Returns Rect

• toRectAddSize(x: number, y?: number): Rect

  Build a Rect with this as position and the argument as size.

  Parameters

  • x: number
  • Optionaly: number

  Returns Rect

toString

• toString(): string

  Debug string like "Vec2 [x: 1, y: 2]".

  Returns string

StaticfromAngle

• fromAngle(rad: number, scaleX?: number, scaleY?: number): Vec2

  Unit vector at angle rad (radians), scaled per-axis. scaleY defaults to scaleX.

  Parameters

  • rad: number
  • scaleX: number = 1
  • scaleY: number = scaleX

  Returns Vec2