Module "point"

Index

Interfaces

Point

Variables

ORIGIN

Constructor Functions

from

Distance Functions

Other Functions

Transform Functions

Variables

Const ORIGIN

ORIGIN: {} = Object.freeze({ x: 0, y: 0 })

The origin is the point at 0, 0. It cannot be modified.

Type declaration

Constructor Functions

from

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

- Defined in point.ts:34
Creates a point from its X and Y coordinates.

Parameters
- x: number
- y: number
Returns Point

Distance Functions

chebyshev

chebyshev(p1: Point, p2: Point): number

- Defined in point.ts:84
Calculates the Chebyshev distance between p1 and p2.

Parameters
- p1: Point
- p2: Point
Returns number

distance

distance(p1: Point, p2: Point): number

- Defined in point.ts:64
Calculates the Euclidean distance between p1 and p2.

Parameters
- p1: Point
- p2: Point
Returns number

manhattan

manhattan(p1: Point, p2: Point): number

- Defined in point.ts:74
Calculates the Manhattan distance between p1 and p2.

Parameters
- p1: Point
- p2: Point
Returns number

Other Functions

ceil

ceil(point: Point): void

- Defined in point.ts:167
Rounds the coordinates in point up.

This modifies point. Use ceiled to create a new point.

Parameters
- point: Point
Returns void

ceiled

ceiled(point: Point): { x: number; y: number }

- Defined in point.ts:155
Rounds the coordinates in point up.

This creates a new point. Use ceil if you want to modify point instead.

Parameters
- point: Point
Returns { x: number; y: number }
- x: number
- y: number

clone

clone(point: Point): Point

- Defined in point.ts:41
Creates a copy of point.

Parameters
- point: Point
Returns Point

equals

equals(p1: Point, p2: Point): boolean

- Defined in point.ts:51
Determines whether p1 and p2 are equal.

Points are considered equal if their X and Y coordinates are both equal.

Parameters
- p1: Point
- p2: Point
Returns boolean

floor

floor(point: Point): void

- Defined in point.ts:145
Rounds the coordinates in point down.

This modifies point. Use floored to create a new point.

Parameters
- point: Point
Returns void

floored

floored(point: Point): { x: number; y: number }

- Defined in point.ts:133
Rounds the coordinates in point down.

This creates a new point. Use floor if you want to modify point instead.

Parameters
- point: Point
Returns { x: number; y: number }
- x: number
- y: number

interpolate

interpolate(p1: Point, p2: Point, value: number): { x: number; y: number }

- Defined in point.ts:118
Interpolate a new point on the line between p1 and p2.

Parameters
- p1: Point
- p2: Point
- value: number
Returns { x: number; y: number }
- x: number
- y: number

is

is(value: any): value is Point

- Defined in point.ts:20
Determines whether value is a Point.

Parameters
- value: any
Returns value is Point

mooreNeighbours

mooreNeighbours(point: Point): Point[]

- Defined in point.ts:178
Returns the adjacent 8-points from the Moore neighbourhood. Assumes the point a rounded grid coordinate.

see

https://en.wikipedia.org/wiki/Moore_neighborhood

Parameters
- point: Point
Returns Point[]

relativeFrom

relativeFrom(point: Point, origin: Point): Point

- Defined in point.ts:212
Parameters
- point: Point
- origin: Point
Returns Point

relativeTo

relativeTo(point: Point, origin: Point): Point

- Defined in point.ts:208
Parameters
- point: Point
- origin: Point
Returns Point

vonNeumannNeighbours

vonNeumannNeighbours(point: Point): Point[]

- Defined in point.ts:198
Returns the adjacent 4-points from the Von Neumann neighbourhood. Assumes the point a rounded grid coordinate.

see

https://en.wikipedia.org/wiki/Von_Neumann_neighborhood

Parameters
- point: Point
Returns Point[]

Transform Functions

translate

translate(point: Point, vector: Vector): void

- Defined in point.ts:95
Translates point by vector.

This modifies point. Use translated to create a new point.

Parameters
- point: Point
- vector: Vector
Returns void

translated

translated(point: Point, vector: Vector): { x: number; y: number }

- Defined in point.ts:108
Translates point by vector.

This creates a new point. Use translate if you want to modify point instead.

Parameters
- point: Point
- vector: Vector
Returns { x: number; y: number }
- x: number
- y: number

Generated using TypeDoc