Class Vec2

2D vector representation containing x and y components. Used for positional and texture coordinate calculations.

Index

Accessors

down left one right up zero

Constructors

Methods

add addScaled clone copy distance distanceSquared dot equals length lengthSquared lerp multiply normalize scale set sub toFloat32Array lerp

Properties

x y

Accessors

`Static`down

get down(): Vec2
Returns a new Vec2 representing (0, -1)

Returns Vec2
- Defined in math/vec2.ts:44

`Static`left

get left(): Vec2
Returns a new Vec2 representing (-1, 0)

Returns Vec2
- Defined in math/vec2.ts:49

`Static`one

get one(): Vec2
Returns a new Vec2 representing (1, 1)

Returns Vec2
- Defined in math/vec2.ts:34

`Static`right

get right(): Vec2
Returns a new Vec2 representing (1, 0)

Returns Vec2
- Defined in math/vec2.ts:54

`Static`up

get up(): Vec2
Returns a new Vec2 representing (0, 1)

Returns Vec2
- Defined in math/vec2.ts:39

`Static`zero

get zero(): Vec2
Returns a new Vec2 representing (0, 0)

Returns Vec2
- Defined in math/vec2.ts:29

Constructors

constructor

new Vec2(x?: number, y?: number): Vec2
Create a new Vec2
Parameters
- Optionalx: number = 0
  X component
- Optionaly: number = 0
  Y component
Returns Vec2
- Defined in math/vec2.ts:23

Methods

add

add(v: Vec2): this
Adds another vector to this one (in-place)
Parameters
- v: Vec2
  The vector to add
Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:94

addScaled

addScaled(v: Vec2, s: number): this
Adds a scaled vector to this one (in-place) without allocating temporary objects. Computes: this += v * s
Parameters
- v: Vec2
  The vector to scale and add
- s: number
  The scalar factor
Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:107

clone

clone(): Vec2
Clone this vector into a new Vec2

Returns Vec2
A new vector with the same x and y values
- Defined in math/vec2.ts:85

copy

copy(v: Vec2): this
Copy the values of another vector into this vector
Parameters
- v: Vec2
  The vector to copy from
Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:75

distance

distance(v: Vec2): number
Calculates the distance to another vector
Parameters
- v: Vec2
  The other vector
Returns number
The distance
- Defined in math/vec2.ts:189

distanceSquared

distanceSquared(v: Vec2): number
Calculates the squared distance to another vector
Parameters
- v: Vec2
  The other vector
Returns number
The squared distance
- Defined in math/vec2.ts:198

dot

dot(v: Vec2): number
Calculates the dot product of this vector and another
Parameters
- v: Vec2
  The other vector
Returns number
The dot product
- Defined in math/vec2.ts:151

equals

equals(v: Vec2): boolean
Checks for strict equality with another vector
Parameters
- v: Vec2
  The vector to compare with
Returns boolean
True if the components are exactly equal
- Defined in math/vec2.ts:209

length

length(): number
Calculates the length of this vector

Returns number
The length
- Defined in math/vec2.ts:167

lengthSquared

lengthSquared(): number
Calculates the squared length of this vector

Returns number
The squared length
- Defined in math/vec2.ts:159

lerp

lerp(target: Vec2, t: number): this
Linearly interpolate to a target vector (in-place)
Parameters
- target: Vec2
  The target vector to interpolate towards
- t: number
  Interpolation factor
Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:219

multiply

multiply(v: Vec2): this
Multiplies this vector by another vector (in-place)
Parameters
- v: Vec2
  The vector to multiply by
Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:129

normalize

normalize(): this
Normalizes this vector (in-place)

Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:175

scale

scale(n: number): this
Scales this vector by a scalar value (in-place)
Parameters
- n: number
  The scalar value
Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:140

set

set(x: number, y: number): this
Set the x and y components of this vector
Parameters
- x: number
  The new x value
- y: number
  The new y value
Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:64

sub

sub(v: Vec2): this
Subtracts another vector from this one (in-place)
Parameters
- v: Vec2
  The vector to subtract
Returns this
The current vector (for chaining)
- Defined in math/vec2.ts:118

toFloat32Array

toFloat32Array(
out?: Float32Array<ArrayBufferLike>,
offset?: number,
): Float32Array
Get the vector as a Float32Array or fill an existing array
Parameters
- Optionalout: Float32Array<ArrayBufferLike>
  Optional Float32Array to fill
- Optionaloffset: number = 0
  Optional offset in the array
Returns Float32Array
The filled array
- Defined in math/vec2.ts:250

`Static`lerp

lerp(v1: Vec2, v2: Vec2, t: number, out?: Vec2): Vec2
Linearly interpolate between two vectors into a new vector
Parameters
- v1: Vec2
  Start vector
- v2: Vec2
  End vector
- t: number
  Interpolation factor
- Optionalout: Vec2 = ...
  Optional vector to store the result
Returns Vec2
The interpolated vector
- Defined in math/vec2.ts:233

Properties

x

x: number

X component

y

y: number

Y component