Skip to main content

Class: Path

Defined in: common/path/path.ts:8

Class to represent a path consisting of a series of 2D points.

Implements​

Constructors​

Constructor​

new Path(path?): Path

Defined in: common/path/path.ts:18

Creates an instance of Path.

Parameters​

path?​

Vector2[] = []

An array of Vector2 points representing the path.

Returns​

Path

Example​

const path = new Path([{ x: 0, y: 0 }, { x: 1, y: 1 }]);
console.log(path.length); // 2

Properties​

path​

path: Vector2[]

Defined in: common/path/path.ts:9

Accessors​

first​

Get Signature​

get first(): Vector2

Defined in: common/path/path.ts:61

Gets the first point in the path.

Returns​

Vector2

The first point in the path.

last​

Get Signature​

get last(): Vector2 | null

Defined in: common/path/path.ts:69

Gets the last point in the path.

Returns​

Vector2 | null

The last point in the path.

length​

Get Signature​

get length(): number

Defined in: common/path/path.ts:77

Gets the number of points in the path.

Returns​

number

The number of points in the path.

Methods​

[iterator]()​

[iterator](): Iterator<Vector2>

Defined in: common/path/path.ts:89

Returns an iterator for the path.

Returns​

Iterator<Vector2>

An iterator for the path.

Example​

for (const point of path) {
  console.log(point);
}

Implementation of​

Iterable.[iterator]

at()​

at(index): Vector2

Defined in: common/path/path.ts:27

Gets the point at the specified index.

Parameters​

index​

number

The index of the point to retrieve.

Returns​

Vector2

The point at the specified index.

map()​

map<T>(callback): T[]

Defined in: common/path/path.ts:53

Maps the path to a new array using the provided callback function.

Type Parameters​

T​

T

Parameters​

callback​

MapPathCallback<T>

The callback function to apply to each point.

Returns​

T[]

A new array with the results of calling the callback on each point.

Example​

const pointStrings = path.map(point => `[${point.x},${point.y}]`);
console.log(pointStrings); // ['[0,0]', '[1,1]']

push()​

push(point): void

Defined in: common/path/path.ts:41

Adds a point to the end of the path.

Parameters​

point​

Vector2

The point to add.

Returns​

void