Interface Ennetree<T>

interface Ennetree<T> {
    size: number;
    bounds: Readonly<Bounds>;
    insert(item: Readonly<T>): void;
    search(area: Readonly<Bounds>): IterableIterator<Readonly<T>>;
    all(): IterableIterator<Readonly<T>>;
    collect(area: Readonly<Bounds>, result?: Readonly<T>[]): Readonly<T>[];
    collectAll(result?: Readonly<T>[]): Readonly<T>[];
    remove(item: Readonly<T>): boolean;
    clear(): void;
}

Type Parameters

T
The type of children of this Ennetree contains.

Index

Properties

Methods

insert search all collect collectAll remove clear

Properties

`Readonly`size

size: number

Count the total number of items in the Ennetree.

`Readonly`bounds

bounds: Readonly<Bounds>

The bounds of this Ennetree.

Methods

insert

insert(item): void
Insert an item into the Ennetree.
Parameters
- item: Readonly<T>
  The item to insert.
Returns void
- Defined in ennetree.ts:22

search

search(area): IterableIterator<Readonly<T>>
Search the Ennetree for all items that intersect with the search area.
Parameters
- area: Readonly<Bounds>
  The search area of the query.
Returns IterableIterator<Readonly<T>>
An iterator of matched items.
- Defined in ennetree.ts:30

all

all(): IterableIterator<Readonly<T>>
Return all the items within the Ennetree.

Returns IterableIterator<Readonly<T>>
An iterator of all items.
- Defined in ennetree.ts:37

collect

collect(area, result?): Readonly<T>[]
Collect items in the Ennetree that intersect with the search area into result.
Parameters
- area: Readonly<Bounds>
  The search area of the query.
- Optionalresult: Readonly<T>[]
  An optional array to collect items. Defaults to an empty array.
Returns Readonly<T>[]
A reference to the collection array.
- Defined in ennetree.ts:46

collectAll

collectAll(result?): Readonly<T>[]
Collect all items in the Ennetree into result.
Parameters
- Optionalresult: Readonly<T>[]
  An optional array to collect items. Defaults to an empty array.
Returns Readonly<T>[]
A reference to the collection array.
- Defined in ennetree.ts:54

remove

remove(item): boolean
Remove an item from the Ennetree.
Parameters
- item: Readonly<T>
  The item to remove.
Returns boolean
- Defined in ennetree.ts:61

clear

clear(): void
Clear all items from the Ennetree and reset the tree back to its initial state.

Returns void
- Defined in ennetree.ts:66