Skip to main content

Class: PointRange

Defined in: src/point-range.ts:8

Range between two points. Creates a normalized range between two given points

Constructors​

Constructor​

new PointRange(source, target): PointRange

Defined in: src/point-range.ts:14

Parameters​

source​

Point

target​

Point

Returns​

PointRange

Properties​

end​

end: Point

Defined in: src/point-range.ts:12

The bottom-right point


start​

start: Point

Defined in: src/point-range.ts:10

The top-left point

Methods​

[iterator]()​

[iterator](): Iterator<Point>

Defined in: src/point-range.ts:26

Iterates through all the existing points in given range

Returns​

Iterator<Point>


equals()​

equals(range): boolean

Defined in: src/point-range.ts:74

Returns whether given range is equal to this range

Parameters​

range​

PointRange

Returns​

boolean


has()​

has(point): boolean

Defined in: src/point-range.ts:46

Returns whether given point exists in given range

Parameters​

point​

Point

Returns​

boolean


mask()​

mask(mask): PointRange

Defined in: src/point-range.ts:56

Limits given masked range with given mask

Parameters​

mask​

PointRange

Returns​

PointRange


size()​

size(): number

Defined in: src/point-range.ts:39

Returns the size (rows x columns) of the given range

Returns​

number