Class QuadTreeNode

QuadTreeNode. The values of the node is an array of QuadTreeItem.

To create, you probably want the quadTree function.

Implements

TraversableTree<QuadTreeItem[]>

Index

Constructors

Methods

add children couldHold direction getIdentity getLengthChildren getParent getValue parents

Properties

boundary level opts

Constructors

constructor

new QuadTreeNode(
    parent: undefined | QuadTreeNode,
    boundary: RectPositioned,
    level: number,
    opts: QuadTreeOpts,
): QuadTreeNode
Constructor
Parameters
- parent: undefined | QuadTreeNode
- boundary: RectPositioned
- level: number
- opts: QuadTreeOpts
Returns QuadTreeNode
- Defined in geometry/src/quad-tree.ts:74

Methods

add

add(p: QuadTreeItem): boolean
Add an item to the quadtree
Parameters
- p: QuadTreeItem
Returns boolean
False if item is outside of boundary, True if item was added
- Defined in geometry/src/quad-tree.ts:134

children

children(): IterableIterator<QuadTreeNode>
Iterates over immediate children

Returns IterableIterator<QuadTreeNode>
Implementation of TraversableTree.children
- Defined in geometry/src/quad-tree.ts:103

couldHold

couldHold(p: Point): boolean
Returns true if point is inside node's boundary
Parameters
- p: Point
Returns boolean
- Defined in geometry/src/quad-tree.ts:167

direction

direction(d: Direction): undefined | QuadTreeNode
Get a descendant node in a given direction
Parameters
- d: Direction
Returns undefined | QuadTreeNode
- Defined in geometry/src/quad-tree.ts:125

getIdentity

getIdentity(): QuadTreeNode
Object reference that acts as the identity of the node

Returns QuadTreeNode
Implementation of TraversableTree.getIdentity
- Defined in geometry/src/quad-tree.ts:117

getLengthChildren

getLengthChildren(): number
Returns number
- Defined in geometry/src/quad-tree.ts:83

getParent

getParent(): undefined | QuadTreeNode
Direct parent of node

Returns undefined | QuadTreeNode
Implementation of TraversableTree.getParent
- Defined in geometry/src/quad-tree.ts:96

getValue

getValue(): QuadTreeItem[]
Array of QuadTreeItem

Returns QuadTreeItem[]
Implementation of TraversableTree.getValue
- Defined in geometry/src/quad-tree.ts:113

parents

parents(): IterableIterator<QuadTreeNode>
Returns IterableIterator<QuadTreeNode>
- Defined in geometry/src/quad-tree.ts:87

Properties

`Readonly`boundary

boundary: RectPositioned

`Readonly`level

level: number

`Readonly`opts

opts: QuadTreeOpts