@devlsh/quadtree

Installation

$ npm install @devlsh/quadtree

Usage

import { Quadtree, type Rect } from '@devlsh/quadtree';

/**
 * If you want custom data (such as an ID) attached to objects, you can pass in a
 * generic based on `Rect`.
 */
interface Entity extends Rect {
  id: string;
}

const tree = new Quadtree<Entity>({
  width: 1024, // World/canvas width.
  height: 1024, // World/canvas height.
  maxDepth: 12, // Limit how many times regions subdivide.
  maxObjects: 15, // Split crowded regions into four; not a hard cap at maxDepth.
});

const object: Entity = {
  id: 'object-1',
  x: 489,
  y: 200,
  width: 20,
  height: 20,
};

const others: Entity[] = [
  { id: 'object-2', x: 460, y: 190, width: 20, height: 20 },
  { id: 'object-3', x: 1000, y: 1000, width: 20, height: 20 },
];

tree.insert(object);
tree.insertAll(others);

/**
 * Candidates are not exact collisions - they are neighboring spatial objects.
 * Retrieval returns each original reference at most once, even across child boundaries.
 * Distinct objects with equal bounds remain separate candidates. TODO: fix this.
 * Apply your own collision check afterward.
 */
const candidates = tree.retrieve({ x: 480, y: 180, width: 100, height: 100 });

/**
 * No update/remove methods: after moving objects, clear and reinsert all current objects.
 */
object.x = 600;
tree.clear();
tree.insertAll([object, ...others]);

Contributing

License