Class Quadtree

bounds

maxObjects

maxDepth

depth

objects

nodes

root

Static INDICES

all

• get all(): QuadtreeObject[]

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

  Returns QuadtreeObject[]

split

• split(): Quadtree

• Split this node into 4 sub-nodes.

  Returns Quadtree

  The split Quadtree

clear

• clear(): Quadtree

• Clear the quadtree of all existing contents

  Returns Quadtree

  The cleared Quadtree

insert

• insert(obj): 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): Quadtree

• Remove an object from the quadtree

  Parameters

  • target: any

    The quadtree target being removed

  Returns Quadtree

  The Quadtree for method chaining

update

• update(obj): 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

getObjects

• getObjects(rect, options?): Set<any>

• Get all the objects which could collide with the provided rectangle

  Parameters

  • rect: Rectangle

    The normalized target rectangle
  • Optional options: {
        collisionTest: Function;
        _s: Set<any>;
    } = {}

    Options affecting the collision test.

    • collisionTest: 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.

    • _s: Set<any>

      The existing result set, for internal use.

  Returns Set<any>

  The objects in the Quadtree which represent potential collisions

getLeafNodes

• getLeafNodes(rect): 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

getChildNodes

• getChildNodes(rect): 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

getAdjacentNodes

• getAdjacentNodes(): Quadtree[]

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

  Returns Quadtree[]