Class Vector2

Hierarchy

Vector2

Index

Constructors

constructor

Properties

Accessors

length

Methods

Constructors

constructor

new Vector2(x: number, y: number): Vector2
new Vector2(arr: [number, number]): Vector2
new Vector2(obj: IVector2): Vector2
new Vector2(value: number): Vector2

- Defined in types-shared/index.d.ts:2238
Parameters
- x: number
- y: number
Returns Vector2
- Defined in types-shared/index.d.ts:2240
Parameters
- arr: [number, number]
Returns Vector2
- Defined in types-shared/index.d.ts:2242
Parameters
- obj: IVector2
Returns Vector2
- Defined in types-shared/index.d.ts:2244
Parameters
- value: number
Returns Vector2

Properties

Readonly x

x: number

Readonly y

y: number

Static Readonly down

(0, -1) vector

Static Readonly left

(-1, 0) vector

Static Readonly negativeInfinity

negativeInfinity: Vector2

(-Infinity, -Infinity) vector

Static Readonly one

(1, 1) vector

Static Readonly positiveInfinity

positiveInfinity: Vector2

(Infinity, Infinity) vector

Static Readonly right

right: Vector2

(1, 0) vector

Static Readonly up

(0, 1) vector

Static Readonly zero

(0, 0) vector

Accessors

length

get length(): number

- Defined in types-shared/index.d.ts:2248
Returns number

Methods

add

add(x: number, y: number): Vector2
add(value: number): Vector2
add(array: [number, number]): Vector2
add(vector: IVector2): Vector2

- Defined in types-shared/index.d.ts:2262
Adds two vectors.

Parameters
- x: number
- y: number
Returns Vector2
- Defined in types-shared/index.d.ts:2267
Adds a number to all vector axis.

Parameters
- value: number
Returns Vector2
- Defined in types-shared/index.d.ts:2272
Adds two vectors.

Parameters
- array: [number, number]
Returns Vector2
- Defined in types-shared/index.d.ts:2277
Adds two vectors.

Parameters
- vector: IVector2
Returns Vector2

angleTo

angleTo(vector: IVector2): Vector2

- Defined in types-shared/index.d.ts:2384
Calculates angle between to vectors (in radians).

Parameters
- vector: IVector2
Returns Vector2

angleToDegrees

angleToDegrees(vector: IVector2): Vector2

- Defined in types-shared/index.d.ts:2389
Calculates angle between to vectors (in degrees).

Parameters
- vector: IVector2
Returns Vector2

distanceTo

distanceTo(vector: IVector2): number

- Defined in types-shared/index.d.ts:2374
Calculates distance between vectors.

Parameters
- vector: IVector2
Returns number

distanceToSquared

distanceToSquared(vector: IVector2): number

- Defined in types-shared/index.d.ts:2379
Calculates squared distance between vectors.

Parameters
- vector: IVector2
Returns number

div

div(x: number, y: number): Vector2
div(value: number): Vector2
div(array: [number, number]): Vector2
div(vector: IVector2): Vector2

- Defined in types-shared/index.d.ts:2302
Divides two vectors.

Parameters
- x: number
- y: number
Returns Vector2
- Defined in types-shared/index.d.ts:2307
Divides two vectors.

Parameters
- value: number
Returns Vector2
- Defined in types-shared/index.d.ts:2312
Divides two vectors.

Parameters
- array: [number, number]
Returns Vector2
- Defined in types-shared/index.d.ts:2317
Divides two vectors.

Parameters
- vector: IVector2
Returns Vector2

dot

dot(x: number, y: number): Vector2
dot(value: number): Vector2
dot(array: [number, number]): Vector2
dot(vector: IVector2): Vector2

- Defined in types-shared/index.d.ts:2322
Calculates dot product between two vectors.

Parameters
- x: number
- y: number
Returns Vector2
- Defined in types-shared/index.d.ts:2327
Calculates dot product between vector and a number.

Parameters
- value: number
Returns Vector2
- Defined in types-shared/index.d.ts:2332
Calculates dot product between two vectors.

Parameters
- array: [number, number]
Returns Vector2
- Defined in types-shared/index.d.ts:2337
Calculates dot product between two vectors.

Parameters
- vector: IVector2
Returns Vector2

inverse

inverse(): Vector2

- Defined in types-shared/index.d.ts:2364
Returns Vector2

isInRange

isInRange(vector: IVector2, range: number): boolean

- Defined in types-shared/index.d.ts:2404
Checks if distance between vectors is smaller or equal to range.

Parameters
- vector: IVector2
- range: number
Returns boolean

lerp

lerp(vector: IVector2, ratio: number): Vector2

- Defined in types-shared/index.d.ts:2409
Interpolates vectors linearly.

Parameters
- vector: IVector2
- ratio: number
Returns Vector2

mul

mul(x: number, y: number): Vector2
mul(value: number): Vector2
mul(array: [number, number]): Vector2
mul(vector: IVector2): Vector2

- Defined in types-shared/index.d.ts:2342
Multiplies two vectors.

Parameters
- x: number
- y: number
Returns Vector2
- Defined in types-shared/index.d.ts:2347
Multiplies all vector axis by a number.

Parameters
- value: number
Returns Vector2
- Defined in types-shared/index.d.ts:2352
Multiplies two vectors.

Parameters
- array: [number, number]
Returns Vector2
- Defined in types-shared/index.d.ts:2357
Multiplies two vectors.

Parameters
- vector: IVector2
Returns Vector2

negative

negative(): Vector2

- Defined in types-shared/index.d.ts:2362
Negates vector.

Returns Vector2

normalize

normalize(): Vector2

- Defined in types-shared/index.d.ts:2369
Normalizes vector.

Returns Vector2

sub

sub(x: number, y: number): Vector2
sub(value: number): Vector2
sub(array: [number, number]): Vector2
sub(vector: IVector2): Vector2

- Defined in types-shared/index.d.ts:2282
Subtracts two vectors.

Parameters
- x: number
- y: number
Returns Vector2
- Defined in types-shared/index.d.ts:2287
Subtracts a number from all vector axis.

Parameters
- value: number
Returns Vector2
- Defined in types-shared/index.d.ts:2292
Subtracts two vectors.

Parameters
- array: [number, number]
Returns Vector2
- Defined in types-shared/index.d.ts:2297
Subtracts two vectors.

Parameters
- vector: IVector2
Returns Vector2

toArray

toArray(): [number, number]

- Defined in types-shared/index.d.ts:2253
Returns [x, y] array.

Returns [number, number]

toDegrees

toDegrees(): Vector2

- Defined in types-shared/index.d.ts:2399
Converts radians to degrees.

Returns Vector2

toFixed

toFixed(precision: number): Vector2

- Defined in types-shared/index.d.ts:2255
Parameters
- precision: number
Returns Vector2

toRadians

toRadians(): Vector2

- Defined in types-shared/index.d.ts:2394
Converts degrees to radians.

Returns Vector2

toString

toString(): string

- Defined in types-shared/index.d.ts:2257
Returns string