JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4412957
  • Score
    100M100P100Q200316F
  • License ISC

A really fast JavaScript library for Delaunay triangulation of 2D points

Package Exports

  • delaunator
  • delaunator/delaunator.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (delaunator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

delaunator

A really fast JavaScript library for Delaunay triangulation of 2D points.

Build Status

For Voronoi diagram computation, search, traversal and rendering, check out d3-delaunay which is based on Delaunator.

Example

const points = [[168, 180], [168, 178], [168, 179], [168, 181], [168, 183], ...];

const delaunay = Delaunator.from(points);
console.log(delaunay.triangles);
// [623, 636, 619,  636, 444, 619, ...]

Install

Install with NPM (npm install delaunator) or Yarn (yarn add delaunator), then:

// import as an ES module
import Delaunator from 'delaunator';

// or require in Node / Browserify
const Delaunator = require('delaunator');

Or use a browser build directly:

<script src="https://unpkg.com/delaunator@2.0.2/delaunator.min.js"></script> <!-- minified build -->
<script src="https://unpkg.com/delaunator@2.0.2/delaunator.js"></script> <!-- dev build -->

API Reference

Delaunator.from(points[, getX, getY])

Constructs a delaunay triangulation object given an array of points ([x, y] by default). getX and getY are optional functions of the form (point) => value for custom point formats. Duplicate points are skipped.

new Delaunator(coords)

Constructs a delaunay triangulation object given a typed array of point coordinates of the form: [x0, y0, x1, y1, ...].

delaunay.triangles

A flat Int32Array array of triangle vertex indices (each group of three numbers forms a triangle). All triangles are directed counterclockwise.

To get the coordinates of all triangles, use:

for (let i = 0; i < triangles.length; i += 3) {
    coordinates.push([
        points[triangles[i]],
        points[triangles[i + 1]],
        points[triangles[i + 2]]
    ]);
}

delaunay.halfedges

A flat Int32Array array of triangle half-edge indices that allows you to traverse the triangulation. i-th half-edge in the array corresponds to vertex triangles[i] the half-edge is coming from. halfedges[i] is the index of a twin half-edge in an adjacent triangle (or -1 for outer half-edges on the convex hull).

The flat array-based data structures might be counterintuitive, but they're one of the key reasons this library is fast.

Performance

Benchmark results against four fastest other libraries (npm run bench on Macbook Pro Retina 15" 2017, Node v8.10.0):

library 10,000 20,000 50,000 100,000 200,000 500,000 1,000,000
delaunator 31ms 17ms 59ms 125ms 232ms 613ms 1.35s
faster-delaunay 48ms 88ms 243ms 447ms 1.02s 2.72s 4.95s
incremental-delaunay 56ms 131ms 309ms 577ms 1.12s 3.01s 6.37s
d3-voronoi 132ms 220ms 483ms 1s 2.27s 6.3s 12.67s
delaunay-fast 150ms 343ms 1.19s 3.35s 10.09s 41.09s 117.53s

Papers

The algorithm is based on ideas from the following papers: