Class Quadtree

depth

maxDepth

maxObjects

nodes

objects

root

StaticINDICES

all

• get all(): QuadtreeObject[]

  Return an array of all the objects in the Quadtree (recursive)

  Returns QuadtreeObject[]

bounds

• get bounds(): Rectangle

  The bounding rectangle of the quadtree.

  Returns Rectangle

height

• get height(): number

  The height of the bounding rectangle

  Returns number

width

• get width(): number

  The width of the bounding rectangle

  Returns number

x

• get x(): number

  The x-coordinate of the bounding rectangle

  Returns number

y

• get y(): number

  The y-coordinate of the bounding rectangle

  Returns number

clear

• clear(): Quadtree

  Clear the quadtree of all existing contents

  Returns Quadtree

  The cleared Quadtree

getAdjacentNodes

• getAdjacentNodes(): Quadtree[]

  Identify all nodes which are adjacent to this one within the parent Quadtree.

  Returns Quadtree[]

getChildNodes

• getChildNodes(rect: Rectangle): Quadtree[]

  Obtain the child nodes within the current node which a rectangle belongs to. Note that this function is not recursive, it only returns nodes at the current or child level.

  Parameters

  • rect: Rectangle

    The target rectangle.

  Returns Quadtree[]

  The Quadtree nodes to which the target rectangle belongs

getLeafNodes

• getLeafNodes(rect: Rectangle): Quadtree[]

  Obtain the leaf nodes to which a target rectangle belongs. This traverses the quadtree recursively obtaining the final nodes which have no children.

  Parameters

  • rect: Rectangle

    The target rectangle.

  Returns Quadtree[]

  The Quadtree nodes to which the target rectangle belongs

getObjects

• getObjects(
      rect: Rectangle,
      options?: { _s?: Set<any>; collisionTest?: Function },
  ): Set<any>

  Get all the objects which could collide with the provided rectangle

  Parameters

  • rect: Rectangle

    The normalized target rectangle

  • Optionaloptions: { _s?: Set<any>; collisionTest?: Function } = {}

    Options affecting the collision test.

    • Optional_s?: Set<any>

      The existing result set, for internal use.

    • OptionalcollisionTest?: Function

      Function to further refine objects to return after a potential collision is found. Parameters are the object and rect, and the function should return true if the object should be added to the result set.

  Returns Set<any>

  The objects in the Quadtree which represent potential collisions

insert

• insert(obj: QuadtreeObject): Quadtree[]

  Add a rectangle object to the tree

  Parameters

  • obj: QuadtreeObject

    The object being inserted

  Returns Quadtree[]

  The Quadtree nodes the object was added to.

remove

• remove(target: any): Quadtree

  Remove an object from the quadtree

  Parameters

  • target: any

    The quadtree target being removed

  Returns Quadtree

  The Quadtree for method chaining

setDimensions

• setDimensions(width: number, height: number): Quadtree

  Re-dimension the bounding rectangle of this Quadtree, clear existing data, and re-insert all objects. Useful if the underlying canvas or region is resized.

  Parameters

  • width: number

    The new width of the bounding rectangle

  • height: number

    The new height of the bounding rectangle

  Returns Quadtree

  This Quadtree for method chaining

setPosition

• setPosition(x: number, y: number): Quadtree

  Re-position the bounding rectangle of this Quadtree, clear existing data, and re-insert all objects. Useful if the Quadtree needs to move.

  Parameters

  • x: number

    The new x-coordinate of the bounding rectangle

  • y: number

    The new y-coordinate of the bounding rectangle

  Returns Quadtree

  This Quadtree for method chaining

split

• split(): Quadtree

  Split this node into 4 sub-nodes.

  Returns Quadtree

  The split Quadtree

update

• update(obj: QuadtreeObject): Quadtree[]

  Remove an existing object from the quadtree and re-insert it with a new position

  Parameters

  • obj: QuadtreeObject

    The object being inserted

  Returns Quadtree[]

  The Quadtree nodes the object was added to

visualize

• visualize(objects?: boolean): void

  Visualize the nodes and objects in the quadtree

  Parameters

  • Optionalobjects: boolean = {}

    Visualize the rectangular bounds of objects in the Quadtree. Default is false.

  Returns void