Quadtree

A simple javascript implementation of a quadtree data structure for storing 2d objects - Quadtree

For use in node or browser based projects.

Usage

$3

Use your node package manager to install, or if you're just using it in the browser, skip this.
``
npm install @slatham/quadtree
`

$3

Include in your node project
`javascript
// import the module
const qt = require('@slatham/quadtree');
`
Or, if it is a browser-based project, include the file found in the build folder in your HTML
`HTML





`

$3

Set up the required properties of the quadtree
`javascript
// define the area of the quadtree
// qt.Rectangle(x, y, w, h)
const area = new qt.Rectangle(0, 0, 100, 100);

// define how many points each node should hold before sub-dividing
const maxPointsPerNode = 10;
`


$3


Will create a new quadtree
`javascript
// create the quadtree
const qtree = new qt.Quadtree(area, maxPointsPerNode);
`

$3

Will insert a valid point into the quadtree
`javascript
// define a Point object
// qt.Point(x, y, data)
const point = new qt.Point(50, 50, 'Some test data');
// insert point
qtree.insertPoint(point);
`

$3

Will return a `Set` of Point objects for the area defined
`javascript
// define an area to query
// qt.Rectangle(x, y, w, h)
const queryArea = new qt.Rectangle(25, 25, 50, 50);
// query the quadtree
const points = qtree.queryPoints(queryArea);
`

$3

Will return all points in the quadtree
`javascript
// get all points simply by omitting the query area parameter on queryPoints()
const allPoints = qtree.queryPoints();
`

Examples

Two working examples can be found in the folders web_example and node_example. To run the node example,
navigate to the node_example folder and run
`
node index.js
``
To run the web example that uses p5 to visualise the quadtree, open up web_example/index.html with your browser.