QuadTree <TItem>

QuadTree spatial data structure. Useful for quickly retrieving all objects that might be in a specific location.

Index

Constructors

• constructor

Properties

• bottomLeft
• bottomRight
• bounds
• halfHeight
• halfWidth
• items
• options
• topLeft
• topRight

Methods

• clear
• debug
• getAllItems
• getTreeDepth
• insert
• query
• remove

Constructors

constructor

• new QuadTree<TItem>(bounds: BoundingBox, options?: QuadTreeOptions): QuadTree<TItem>

• Type parameters

  • TItem: QuadTreeItem

  Parameters

  • bounds: BoundingBox

  • optionaloptions: QuadTreeOptions

  Returns QuadTree<TItem>

Properties

publicbottomLeft

bottomLeft: QuadTree<TItem> = null

publicbottomRight

bottomRight: QuadTree<TItem> = null

publicbounds

bounds: BoundingBox

publichalfHeight

halfHeight: number

publichalfWidth

halfWidth: number

publicitems

items: TItem[] = []

publicoptionaloptions

options?: QuadTreeOptions

publictopLeft

topLeft: QuadTree<TItem> = null

publictopRight

topRight: QuadTree<TItem> = null

Methods

clear

• clear(): void

• Returns void

debug

• debug(ctx: ExcaliburGraphicsContext): void

• Parameters

  • ctx: ExcaliburGraphicsContext

  Returns void

getAllItems

• getAllItems(): TItem[]

• Returns TItem[]

getTreeDepth

• getTreeDepth(): number

• Returns number

insert

• insert(item: TItem): void

• Insert an item to be tracked in the QuadTree

  ---

  Parameters

  • item: TItem

  Returns void

query

• query(boundingBox: BoundingBox): TItem[]

• Query the structure for all objects that intersect the bounding box

  ---

  Parameters

  • boundingBox: BoundingBox

  Returns TItem[]

  items

remove

• remove(item: TItem): void

• Remove a tracked item in the QuadTree

  ---

  Parameters

  • item: TItem

  Returns void