QuadTree

Defined in: spatial/QuadTree.ts:16

A quadtree spatial index for fast 2D region queries. Used for viewport culling and hit-testing optimization.

Type Parameters

T

T

Constructors

Constructor

new QuadTree<T>(bounds, options?): QuadTree<T>

Defined in: spatial/QuadTree.ts:25

Parameters

bounds

Rect

options?

depth?

number

maxDepth?

number

maxItems?

number

Returns

QuadTree<T>

Accessors

itemCount

Get Signature

get itemCount(): number

Defined in: spatial/QuadTree.ts:38

Get the total number of items in the quadtree.

Returns

number

Methods

clear()

clear(): void

Defined in: spatial/QuadTree.ts:257

Remove all items.

Returns

void

---

getAllItems()

getAllItems(): T[]

Defined in: spatial/QuadTree.ts:269

Get all items in the quadtree.

Returns

T[]

---

getBounds()

getBounds(): Rect

Defined in: spatial/QuadTree.ts:33

Get the bounds of this quadtree node.

Returns

Rect

---

insert()

insert(x, y, data): void

Defined in: spatial/QuadTree.ts:43

Insert an item at a point.

Parameters

x

number

y

number

data

T

Returns

void

---

insertWithBounds()

insertWithBounds(bounds, data): void

Defined in: spatial/QuadTree.ts:56

Insert an item described by a bounding rectangle. The item is indexed by its full extent (not just its center) so a viewport/region query finds it whenever the rectangle overlaps, even if its center point doesn’t.

Parameters

bounds

Rect

data

T

Returns

void

---

isLeaf()

isLeaf(): boolean

Defined in: spatial/QuadTree.ts:264

Check if this node is a leaf (has no children).

Returns

boolean

---

queryCircle()

queryCircle(cx, cy, radius): T[]

Defined in: spatial/QuadTree.ts:199

Query all items within a circle.

Parameters

cx

number

cy

number

radius

number

Returns

T[]

---

queryNearest()

queryNearest(x, y, maxDistance): T | null

Defined in: spatial/QuadTree.ts:211

Query the nearest item to a point within maxDistance.

Parameters

x

number

y

number

maxDistance

number

Returns

T | null

---

queryRegion()

queryRegion(bounds): T[]

Defined in: spatial/QuadTree.ts:138

Query all items within a region (inclusive). Returns data items found in the region.

Parameters

bounds

Rect

Returns

T[]

---

queryRegionWithPoints()

queryRegionWithPoints(bounds): object[]

Defined in: spatial/QuadTree.ts:173

Query items within a rectangular region. Returns data items with their positions.

Parameters

bounds

Rect

Returns

object[]

---

remove()

remove(data): boolean

Defined in: spatial/QuadTree.ts:233

Remove an item from the quadtree.

Parameters

data

T

Returns

boolean