Sparse Octree

A sparse octree data structure.

Extensive Demo ∴ API Reference

Installation

This library requires the peer dependencies iterator-result and math-ds.

npm install iterator-result math-ds

npm install sparse-octree

Usage

Custom Octrees

import { Octree, CubicOctant } from "sparse-octree";

export class CubicOctree extends Octree {

	constructor(min, size) {

		this.root = new CubicOctant(min, size);

	}

}

Points

import { Vector3 } from "math-ds";
import { PointOctree } from "sparse-octree";

const min = new Vector3(-1, -1, -1);
const max = new Vector3(1, 1, 1);

const octree = new PointOctree(min, max);
const myData = {};

octree.put(new Vector3(0, 0, 0), myData);
octree.fetch(new Vector3(0, 0, 0)); // => myData

A full point octree example can be found here.

Features

• Base Functionality
  • Pointer-based structure
  • Handles octant splitting
  • Adheres to a common octant layout
  • Supports raycasting
  • Supports culling
  • Supports cubic octrees
  • Can be extended to manage any data
• Provides a point management implementation

Octree Helper

The octree-helper module provides an octree visualisation tool for three.js.

Contributing

Maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.