Class Vec2

2D vector with mutable x/y components and immutable arithmetic methods.

Index

Constructors

Properties

Methods

set clone add sub scale dot lengthSq length normalize toArray zero one

Constructors

constructor

new Vec2(x?: number, y?: number): Vec2
Parameters
- x: number = 0
- y: number = 0
Returns Vec2
- Defined in src/math/vec2.ts:9

Properties

x

x: number

y

y: number

`Static` `Readonly`ZERO

ZERO: Vec2 = ...

`Static` `Readonly`ONE

ONE: Vec2 = ...

Methods

set

set(x: number, y: number): this
Sets x and y in place and returns this.
Parameters
- x: number
- y: number
Returns this
- Defined in src/math/vec2.ts:15

clone

clone(): Vec2
Returns a copy of this vector.

Returns Vec2
- Defined in src/math/vec2.ts:20

add

add(v: Vec2): Vec2
Returns this + v componentwise.
Parameters
- v: Vec2
Returns Vec2
- Defined in src/math/vec2.ts:23

sub

sub(v: Vec2): Vec2
Returns this - v componentwise.
Parameters
- v: Vec2
Returns Vec2
- Defined in src/math/vec2.ts:25

scale

scale(s: number): Vec2
Returns this scaled by s.
Parameters
- s: number
Returns Vec2
- Defined in src/math/vec2.ts:27

dot

dot(v: Vec2): number
Returns the dot product of this and v.
Parameters
- v: Vec2
Returns number
- Defined in src/math/vec2.ts:29

lengthSq

lengthSq(): number
Returns the squared length.

Returns number
- Defined in src/math/vec2.ts:31

length

length(): number
Returns the Euclidean length.

Returns number
- Defined in src/math/vec2.ts:33

normalize

normalize(): Vec2
Returns a unit-length copy, or the zero vector if length is 0.

Returns Vec2
- Defined in src/math/vec2.ts:36

toArray

toArray(): [number, number]
Returns [x, y].

Returns [number, number]
- Defined in src/math/vec2.ts:42

`Static`zero

zero(): Vec2
Returns (0, 0).

Returns Vec2
- Defined in src/math/vec2.ts:45

`Static`one

one(): Vec2
Returns (1, 1).

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