Class KDTree

Since

0.3.5

Index

Constructors

Properties

agents bbox depth dimension left median needsUpdating parent right

Methods

agentsWithinDistance axis intersectsAlongDimension locateSubtree nearestNeighbor rebalance removeAgent sphereIntersectsBBox subtreesWithinDistance

Constructors

constructor

new KDTree(
    agents: Agent[],
    dimension?: number,
    depth?: number,
    bbox?: BBox,
): KDTree
Parameters
- agents: Agent[]
- dimension: number = 2
- depth: number = 0
- Optionalbbox: BBox
Returns KDTree
- Defined in helpers/KDTree.ts:35

Properties

agents

agents: Agent[] = null

bbox

bbox: BBox

depth

depth: number = 0

dimension

dimension: number = 2

left

left: KDTree = null

median

median: number = null

needsUpdating

needsUpdating: boolean = false

parent

parent: KDTree = null

right

right: KDTree = null

Methods

agentsWithinDistance

agentsWithinDistance(
    pt: Agent | Point,
    d: number,
    filterFn?: (a: Agent) => boolean,
): Agent[]
Return all the Agents in this KDTree that are within d distance of the given Point or Agent pt, optionally restricted to agents that pass filterFn.
Parameters
- pt: Agent | Point
- d: number
- OptionalfilterFn: (a: Agent) => boolean = ...
  Optional predicate; only matching agents are returned. Defaults to accepting all agents.
Returns Agent[]
Since
0.3.5
- Defined in helpers/KDTree.ts:163

axis

axis(): "x" | "y" | "z"
Returns "x" | "y" | "z"
- Defined in helpers/KDTree.ts:58

intersectsAlongDimension

intersectsAlongDimension(
    pt: Agent | Point,
    d: number,
    coord: "x" | "y" | "z",
): boolean
Parameters
- pt: Agent | Point
- d: number
- coord: "x" | "y" | "z"
Returns boolean
- Defined in helpers/KDTree.ts:111

locateSubtree

locateSubtree(pt: Agent | Point): KDTree
Parameters
- pt: Agent | Point
Returns KDTree
- Defined in helpers/KDTree.ts:72

nearestNeighbor

nearestNeighbor(pt: Agent | Point, filterFn?: (a: Agent) => boolean): Agent
Returns the Agent in this KDTree that is closest spatially to the given Point or Agent pt, optionally restricted to agents that pass filterFn.

When pt is an Agent, its cached __subtree reference is used directly instead of traversing from the root, avoiding an O(log n) traversal and a potential out-of-bounds error. The search expands outward until a qualifying candidate is found, then widens to all subtrees within that distance to guarantee the true nearest filtered neighbor is returned. Distance values are computed once per candidate and cached to avoid redundant calculations during sorting.
Parameters
- pt: Agent | Point
  The reference point or agent to search from.
- OptionalfilterFn: (a: Agent) => boolean = ...
  Optional predicate. Only agents for which filterFn(agent) returns true are considered. Defaults to accepting all agents.
Returns Agent
The nearest qualifying agent.

Since
0.3.5
- Defined in helpers/KDTree.ts:193

rebalance

rebalance(agents?: Agent[]): void
Rebalance the KDTree (if it has been marked as needing updating). Optionally pass the agents that belong to this tree (relevant for trees of higher depth than the top level).
Parameters
- agents: Agent[] = ...
Returns void
Since
0.3.5
- Defined in helpers/KDTree.ts:252

removeAgent

removeAgent(agent: Agent, rebalance?: boolean): boolean
Parameters
- agent: Agent
- rebalance: boolean = true
Returns boolean
- Defined in helpers/KDTree.ts:337

sphereIntersectsBBox

sphereIntersectsBBox(pt: Agent | Point, d: number): boolean
Parameters
- pt: Agent | Point
- d: number
Returns boolean
- Defined in helpers/KDTree.ts:132

subtreesWithinDistance

subtreesWithinDistance(pt: Agent | Point, d: number, trees?: KDTree[]): KDTree[]
Parameters
- pt: Agent | Point
- d: number
- trees: KDTree[] = []
Returns KDTree[]
- Defined in helpers/KDTree.ts:94