goog.structs.QuadTree

Provided By	`goog.structs.QuadTree`

Constructs a new quad tree.

new QuadTree( `minX`, `minY`, `maxX`, `maxY` )

Parameters

`minX`	`number`
	Minimum x-value that can be held in tree.
`minY`	`number`
	Minimum y-value that can be held in tree.
`maxX`	`number`
	Maximum x-value that can be held in tree.
`maxY`	`number`
	Maximum y-value that can be held in tree.

VIEW SOURCE

Instance Methods

Removes all items from the tree.

VIEW SOURCE

Clones the quad-tree and returns the new instance.

Parameters

None.

Returns

goog.structs.QuadTree

A clone of the tree.

VIEW SOURCE

Returns true if the point at (x, y) exists in the tree.

Parameters

`x`	`number`
	The x-coordinate.
`y`	`number`
	The y-coordinate.

Returns

boolean

Whether the tree contains a point at (x, y).

VIEW SOURCE

Traverses the tree and calls a function on each node.

Parameters

`fn`	`function(?, (goog.math.Coordinate\|null), (goog.structs.QuadTree\|null)): ?`
	The function to call for every value. This function takes 3 arguments (the value, the coordinate, and the tree itself) and the return value is irrelevant.
`opt_obj`	`(Object\|null)=`
	The object to be used as the value of 'this' within {@ code fn}.

VIEW SOURCE

Gets the value of the point at (x, y) or null if the point is empty.

Parameters

`x`	`number`
	The x-coordinate.
`y`	`number`
	The y-coordinate.
`opt_default`	`*=`
	The default value to return if the node doesn't exist.

Returns

*

The value of the node, the default value if the node doesn't exist, or undefined if the node doesn't exist and no default has been provided.

VIEW SOURCE

Parameters

None.

Returns

number

The number of items in the tree.

VIEW SOURCE

Returns an array containing the coordinates of each point stored in the tree.

Parameters

None.

Returns

Array<(goog.math.Coordinate|null)>

Array of coordinates.

VIEW SOURCE

Returns a reference to the tree's root node. Callers shouldn't modify nodes, directly. This is a convenience for visualization and debugging purposes.

Parameters

None.

Returns

(goog.structs.QuadTree.Node|null)

The root node.

VIEW SOURCE

Returns an array containing all values stored within the tree.

Parameters

None.

Returns

Array<(Object|null)>

The values stored within the tree.

VIEW SOURCE

Parameters

None.

Returns

boolean

Whether the tree is empty.

VIEW SOURCE

Removes a point from (x, y) if it exists.

Parameters

`x`	`number`
	The x-coordinate.
`y`	`number`
	The y-coordinate.

Returns

*

The value of the node that was removed, or null if the node doesn't exist.

VIEW SOURCE

Sets the value of an (x, y) point within the quad-tree.

Parameters

`x`	`number`
	The x-coordinate.
`y`	`number`
	The y-coordinate.
`value`	`*`
	The value associated with the point.

VIEW SOURCE

Classes

Enumerations

QuadTree.NodeType

goog.structs.QuadTree

new QuadTree( `minX`, `minY`, `maxX`, `maxY` )

Instance Methods

`this.`clear() `→` `void`

`this.`clone() `→` `goog.structs.QuadTree`

`this.`contains( `x`, `y` ) `→` `boolean`

`this.`forEach( `fn`, `opt_obj` ) `→` `void`

`this.`get( `x`, `y`, `opt_default` ) `→` `*`

`this.`getCount() `→` `number`

`this.`getKeys() `→` `Array<(goog.math.Coordinate|null)>`

`this.`getRootNode() `→` `(goog.structs.QuadTree.Node|null)`

`this.`getValues() `→` `Array<(Object|null)>`

`this.`isEmpty() `→` `boolean`

`this.`remove( `x`, `y` ) `→` `*`

`this.`set( `x`, `y`, `value` ) `→` `void`

Classes

Enumerations

goog.structs.QuadTree

new QuadTree( minX, minY, maxX, maxY )

Instance Methods

this.clear() → void

this.clone() → goog.structs.QuadTree

this.contains( x, y ) → boolean

this.forEach( fn, opt_obj ) → void

this.get( x, y, opt_default ) → *

this.getCount() → number

this.getKeys() → Array<(goog.math.Coordinate|null)>

this.getRootNode() → (goog.structs.QuadTree.Node|null)

this.getValues() → Array<(Object|null)>

this.isEmpty() → boolean

this.remove( x, y ) → *

this.set( x, y, value ) → void

Classes

Enumerations

new QuadTree( `minX`, `minY`, `maxX`, `maxY` )

`this.`clear() `→` `void`

`this.`clone() `→` `goog.structs.QuadTree`

`this.`contains( `x`, `y` ) `→` `boolean`

`this.`forEach( `fn`, `opt_obj` ) `→` `void`

`this.`get( `x`, `y`, `opt_default` ) `→` `*`

`this.`getCount() `→` `number`

`this.`getKeys() `→` `Array<(goog.math.Coordinate|null)>`

`this.`getRootNode() `→` `(goog.structs.QuadTree.Node|null)`

`this.`getValues() `→` `Array<(Object|null)>`

`this.`isEmpty() `→` `boolean`

`this.`remove( `x`, `y` ) `→` `*`

`this.`set( `x`, `y`, `value` ) `→` `void`