Class Vector

A two-dimensional vector class with functions useful for working with (x, y) coordinates.

Hierarchy

Vector

Index

Constructors

Properties

x y

Accessors

Methods

add addWithAngle angleTo ceil clamp distanceTo div equals floor isInRect mul normalize rotate round set sub swapXy wrap

Constructors

constructor

new Vector(x?: number | VectorLike, y?: number): Vector
Parameters
- Optional x: number | VectorLike
- Optional y: number
Returns Vector
- Defined in src/vector.ts:22

Properties

x

x: number = 0

y

y: number = 0

Accessors

angle

get angle(): number
Returns number
- Defined in src/vector.ts:162

length

get length(): number
Returns number
- Defined in src/vector.ts:158

Methods

add

add(x: number | VectorLike, y?: number): Vector
Parameters
- x: number | VectorLike
- Optional y: number
Returns Vector
- Defined in src/vector.ts:37

addWithAngle

addWithAngle(angle: number, length: number): Vector
Parameters
- angle: number
- length: number
Returns Vector
- Defined in src/vector.ts:83

angleTo

angleTo(x: number | VectorLike, y?: number): number
Parameters
- x: number | VectorLike
- Optional y: number
Returns number
- Defined in src/vector.ts:111

ceil

ceil(): Vector
Returns Vector
- Defined in src/vector.ts:152

clamp

clamp(xLow: number, xHigh: number, yLow: number, yHigh: number): Vector
Parameters
- xLow: number
- xHigh: number
- yLow: number
- yHigh: number
Returns Vector
- Defined in src/vector.ts:71

distanceTo

distanceTo(x: number | VectorLike, y?: number): number
Parameters
- x: number | VectorLike
- Optional y: number
Returns number
- Defined in src/vector.ts:119

div

div(v: number): Vector
Parameters
- v: number
Returns Vector
- Defined in src/vector.ts:65

equals

equals(other: VectorLike): boolean
Parameters
- other: VectorLike
Returns boolean
- Defined in src/vector.ts:136

floor

floor(): Vector
Returns Vector
- Defined in src/vector.ts:140

isInRect

isInRect(x: number, y: number, width: number, height: number): boolean
Parameters
- x: number
- y: number
- width: number
- height: number
Returns boolean
- Defined in src/vector.ts:132

mul

mul(v: number): Vector
Parameters
- v: number
Returns Vector
- Defined in src/vector.ts:59

normalize

normalize(): Vector
Returns Vector
- Defined in src/vector.ts:96

rotate

rotate(angle: number): Vector
Parameters
- angle: number
Returns Vector
- Defined in src/vector.ts:101

round

round(): Vector
Returns Vector
- Defined in src/vector.ts:146

set

set(x?: number | VectorLike, y?: number): Vector
Parameters
- x: number | VectorLike = 0
- y: number = 0
Returns Vector
- Defined in src/vector.ts:26

sub

sub(x: number | VectorLike, y?: number): Vector
Parameters
- x: number | VectorLike
- Optional y: number
Returns Vector
- Defined in src/vector.ts:48

swapXy

swapXy(): Vector
Returns Vector
- Defined in src/vector.ts:89

wrap

wrap(xLow: number, xHigh: number, yLow: number, yHigh: number): Vector
Parameters
- xLow: number
- xHigh: number
- yLow: number
- yHigh: number
Returns Vector
- Defined in src/vector.ts:77

Generated using TypeDoc