Phaser Class: QuadTree

new QuadTree(x, y, width, height, maxObjects, maxLevels, level)

QuadTree Constructor

Parameters:

Name	Type	Argument	Default	Description
`x`	number			The top left coordinate of the quadtree.
`y`	number			The top left coordinate of the quadtree.
`width`	number			The width of the quadtree in pixels.
`height`	number			The height of the quadtree in pixels.
`maxObjects`	number	<optional>	10	The maximum number of objects per node.
`maxLevels`	number	<optional>	4	The maximum number of levels to iterate to.
`level`	number	<optional>	0	Which level is this?

Source:

math/QuadTree.js, line 60

Members

bounds

Properties:

Name	Type	Description
`bounds`	object	Object that contains the quadtree bounds.

Source:

math/QuadTree.js, line 82

level

Properties:

Name	Type	Description
`level`	number	The current level.

Source:

math/QuadTree.js, line 77

maxLevels

Properties:

Name	Type	Description
`maxLevels`	number	The maximum number of levels to break down to.

Default Value:

Source:

math/QuadTree.js, line 72

maxObjects

Properties:

Name	Type	Description
`maxObjects`	number	The maximum number of objects per node.

Default Value:

Source:

math/QuadTree.js, line 66

nodes

Properties:

Name	Type	Description
`nodes`	array	Array of associated child nodes.

Source:

math/QuadTree.js, line 92

objects

Properties:

Name	Type	Description
`objects`	array	Array of quadtree children.

Source:

math/QuadTree.js, line 87

Methods

clear()

Clear the quadtree.

Source:

math/QuadTree.js, line 334

getIndex(rect) → {number}

Determine which node the object belongs to.

Parameters:

Name	Type	Description
`rect`	Phaser.Rectangle \| object	The bounds in which to check.

Source:

math/QuadTree.js, line 242

Returns:

index - Index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node.

Type: number

insert(body)

Insert the object into the node. If the node exceeds the capacity, it will split and add all objects to their corresponding subnodes.

Parameters:

Name	Type	Description
`body`	Phaser.Physics.Arcade.Body \| object	The Body object to insert into the quadtree. Can be any object so long as it exposes x, y, right and bottom properties.

Source:

math/QuadTree.js, line 190

populate(group)

Populates this quadtree with the children of the given Group. In order to be added the child must exist and have a body property.

Parameters:

Name	Type	Description
`group`	Phaser.Group	The Group to add to the quadtree.

Source:

math/QuadTree.js, line 140

populateHandler(sprite)

Handler for the populate method.

Parameters:

Name	Type	Description
`sprite`	Phaser.Sprite \| object	The Sprite to check.

Source:

math/QuadTree.js, line 152

reset(x, y, width, height, maxObjects, maxLevels, level)

Resets the QuadTree.

Parameters:

Name	Type	Argument	Default	Description
`x`	number			The top left coordinate of the quadtree.
`y`	number			The top left coordinate of the quadtree.
`width`	number			The width of the quadtree in pixels.
`height`	number			The height of the quadtree in pixels.
`maxObjects`	number	<optional>	10	The maximum number of objects per node.
`maxLevels`	number	<optional>	4	The maximum number of levels to iterate to.
`level`	number	<optional>	0	Which level is this?

Source:

math/QuadTree.js, line 106

retrieve(source) → {array}

Return all objects that could collide with the given Sprite or Rectangle.

Parameters:

Name	Type	Description
`source`	Phaser.Sprite \| Phaser.Rectangle	The source object to check the QuadTree against. Either a Sprite or Rectangle.

Source:

math/QuadTree.js, line 286

Returns:

Array with all detected objects.

Type: array

split()

Split the node into 4 subnodes

Source:

math/QuadTree.js, line 167