Module "vector"

Index

Type aliases

Vector

Constructors Functions

Length Functions

Other Functions

Transform Functions

Type aliases

Vector

Vector: [number, number]

Vector represents a direction and a magnitude.

Constructors Functions

clone

clone(vector: Vector): Vector

- Defined in vector.ts:60
Creates a copy of vector that can be modified separately.

Parameters
- vector: Vector
Returns Vector

from

from(x: number, y: number): Vector

- Defined in vector.ts:26
Creates a vector from X and Y components.

Parameters
- x: number
- y: number
Returns Vector

fromAngle

fromAngle(radians: number, length: number): Vector

- Defined in vector.ts:48
Creates a vector from an angle and a length.

Parameters
- radians: number
  
  Angle in radians
- length: number
Returns Vector

fromPoints

fromPoints(start: Point, end: Point): Vector

- Defined in vector.ts:35
Creates a vector from start and end points.

Parameters
- start: Point
- end: Point
Returns Vector

Length Functions

chebyshev

chebyshev(vector: Vector): number

- Defined in vector.ts:98
Calculates the Chebyshev distance of vector.

Parameters
- vector: Vector
Returns number

length

length(vector: Vector): number

- Defined in vector.ts:78
Calculates the magnitude of a vector.

Parameters
- vector: Vector
Returns number

manhattan

manhattan(vector: Vector): number

- Defined in vector.ts:88
Calculates the Manhattan distance of vector.

Parameters
- vector: Vector
Returns number

Other Functions

add

add(v1: Vector, v2: Vector): void

- Defined in vector.ts:117
Adds v2 to v1.

Use added if you want to create a new vector instead.

Parameters
- v1: Vector
- v2: Vector
Returns void

added

added(v1: Vector, v2: Vector): Vector

- Defined in vector.ts:127
Adds v1 and v2 to create a new vector.

Use add if you want to modify v1 instead.

Parameters
- v1: Vector
- v2: Vector
Returns Vector

divide

divide(v1: Vector, v2: Vector): void

- Defined in vector.ts:183
Divides v1 by v2

Use divided if you want to create a new vector instead.

Parameters
- v1: Vector
- v2: Vector
Returns void

divided

divided(v1: Vector, v2: Vector): Vector

- Defined in vector.ts:193
Divides v1 by v2 to create a new vector.

Use divide if you want to modify v1 instead.

Parameters
- v1: Vector
- v2: Vector
Returns Vector

dot

dot(v1: Vector, v2: Vector): number

- Defined in vector.ts:108
Calculates the dot product of v1 and v2.

Parameters
- v1: Vector
- v2: Vector
Returns number

equals

equals(v1: Vector, v2: Vector): boolean

- Defined in vector.ts:69
Check whether v1 and v2 are equal.

Vectors are equal if both of their components are the equal.

Parameters
- v1: Vector
- v2: Vector
Returns boolean

is

is(value: any): value is Vector

- Defined in vector.ts:11
Determines whether value is a Vector.

Parameters
- value: any
Returns value is Vector

multiplied

multiplied(v1: Vector, v2: Vector): Vector

- Defined in vector.ts:171
Multiplies v1 and v2 to create a new vector.

Use multiply if you want to modify v1 instead.

Parameters
- v1: Vector
- v2: Vector
Returns Vector

multiply

multiply(v1: Vector, v2: Vector): void

- Defined in vector.ts:161
Multiplies v1 by v2.

Use multiplied if you want to create a new vector instead.

Parameters
- v1: Vector
- v2: Vector
Returns void

normalize

normalize(vector: Vector): void

- Defined in vector.ts:206
Normalizes vector to have a length of 1.

This function modifies vector. Use normalized if you want to create a new vector instead.

Parameters
- vector: Vector
Returns void

normalized

normalized(vector: Vector): Vector

- Defined in vector.ts:217
Creates a new vector by normalizing vector.

Use normalize if you want to normalize vector in place.

Parameters
- vector: Vector
Returns Vector

subtract

subtract(v1: Vector, v2: Vector): void

- Defined in vector.ts:139
Subtracts v2 from v1.

Use subtracted if you want to create a new vector instead.

Parameters
- v1: Vector
- v2: Vector
Returns void

subtracted

subtracted(v1: Vector, v2: Vector): Vector

- Defined in vector.ts:149
Subtracts v2 from v1 to create a new vector.

Use subtract if you want to modify v1 instead.

Parameters
- v1: Vector
- v2: Vector
Returns Vector

Transform Functions

rotate

rotate(vector: Vector, radians: number): void

- Defined in vector.ts:235
Rotates vector.

This function modifies vector. Use rotated if you want to produce a new vector.

Parameters
- vector: Vector
- radians: number
  
  Rotation angle in radians
Returns void

rotated

rotated(vector: Vector, radians: number): Vector

- Defined in vector.ts:250
Creates a new rotated vector.

Use rotate if you want to rotate vector in place.

Parameters
- vector: Vector
- radians: number
  
  Rotation angle in radians
Returns Vector

scale

scale(vector: Vector, scale: number): void

- Defined in vector.ts:269
Scales a vector in-place.

This function modifies vector. Use scaled if you want to produce a new vector.

Parameters
- vector: Vector
- scale: number
  
  Scaling factor
Returns void

scaled

scaled(vector: Vector, scale: number): Vector

- Defined in vector.ts:283
Creates a new scaled vector.

This function produces a new vector. Use scale if you want to scale vector in-place.

Parameters
- vector: Vector
- scale: number
  
  Scaling factor
Returns Vector

Generated using TypeDoc