Class Flood<T>

abstract: Represents a "flooder" than can flood a part of a grid like the bucket tool of any raster graphics editor does.

Type parameters

T

Any type of data.

Hierarchy

Flood
- FloodFill

Index

Constructors

constructor

Methods

process

Constructors

constructor

new Flood<T>(grid: T[][], floodCallbackFn: FloodCallbackFn<T>): Flood<T>

- Defined in flood/flood.ts:62
Type parameters
- T
  
  Any type of data.
Parameters
- grid: T[][]
  
  The grid for which to compute the flooding.
- floodCallbackFn: FloodCallbackFn<T>
  
  A callback function used to determine if a cell is a one to flood.
Returns Flood<T>

Methods

Abstract process

process(startPosition: Position): FloodResult

- Defined in flood/flood.ts:76
Computes the flooding.

Parameters
- startPosition: Position
  
  The Position on which to start the computation.
Returns FloodResult
The flooding result.

Generated using TypeDoc