Shash

Simple, and fast, spacial hashing library

The shash class has only 2 members.

Setup

var width = 1000,
    height = 500,
    shash = new Shash(width, height, onNeighbour);

"gridItem" complient objects are added to the grid.

shash.add(gridItem, width, height);

interface GridItem {
    coords : Coords;
}
interface Coords {
    x : number;
    y : number;
}

Running check

shash.check()

This will check through the grid, and call the "onNeighbour" callback for each pair of neighbouring objects

function onNeighbour(object1, object2){
    // Do work with neighbours, such as collision checking.
}

Usage

You can include <script src="https://raw.githubusercontent.com/tobq/Shash/master/Shash.js" async> in a HTML file.

// constructor
function rectangle(x, y, width, height){
    this.coords = {
        x: x || 0,
        y: y || 0
    };
    this.width = width || 10;
    this.height = height || 10
    shash.add(this, this.width, this.height);
}
function onNeighbour(object1, object2){
    console.log("NEIGHBOURS:", object1, object2);
}

var width = 1000,
    height = 500,
    shash = new Shash(width, height, onNeighbour);
    
new rectangle(0, 0);
new rectangle(5, 0);
new rectangle(100, 50);
shash.check();

onNeighbour: NEIGHBOURS: rectangle {coords: {…}, width: 10, height: 10} rectangle {coords: {…}, width: 10, height: 10}