earcut 2.0.6 → 2.1.1

package/.npmignore

@@ -1,4 +1,5 @@
 coverage
-node_modules
-dist
 *.log
+test
+bench
+viz

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015, Mapbox
+Copyright (c) 2016, Mapbox
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

package/README.md

@@ -6,6 +6,7 @@ The fastest and smallest JavaScript polygon triangulation library. 2.5KB gzipped
 [![Coverage Status](https://coveralls.io/repos/mapbox/earcut/badge.svg?branch=master)](https://coveralls.io/r/mapbox/earcut?branch=master)
 [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/mapbox/earcut.svg)](http://isitmaintained.com/project/mapbox/earcut "Average time to resolve an issue")
 [![Percentage of issues still open](http://isitmaintained.com/badge/open/mapbox/earcut.svg)](http://isitmaintained.com/project/mapbox/earcut "Percentage of issues still open")
+[![](https://img.shields.io/badge/simply-awesome-brightgreen.svg)](https://github.com/mourner/projects)
 
 #### The algorithm
 
@@ -29,10 +30,10 @@ Some benchmarks using Node 0.12:
 
 (ops/sec)         | pts  | earcut    | libtess  | poly2tri | pnltri    | polyk
 ------------------| ---- | --------- | -------- | -------- | --------- | ------
-OSM building      | 15   | _743,130_ | _50,640_ | _61,501_ | _122,966_ | _175,570_
-dude shape        | 94   | _35,039_  | _10,339_ | _8,784_  | _11,172_  | _13,557_
+OSM building      | 15   | _795,935_ | _50,640_ | _61,501_ | _122,966_ | _175,570_
+dude shape        | 94   | _35,658_  | _10,339_ | _8,784_  | _11,172_  | _13,557_
 holed dude shape  | 104  | _28,319_  | _8,883_  | _7,494_  | _2,130_   | n/a
-complex OSM water | 2523 | _597_     | _77.54_  | failure  | failure   | n/a
+complex OSM water | 2523 | _543_     | _77.54_  | failure  | failure   | n/a
 huge OSM water    | 5667 | _95_      | _29.30_  | failure  | failure   | n/a
 
 The original use case it was created for is [Mapbox GL](https://www.mapbox.com/mapbox-gl), WebGL-based interactive maps.
@@ -46,12 +47,12 @@ and earcut is not precise enough, take a look at [libtess.js](https://github.com
 var triangles = earcut([10,0, 0,50, 60,60, 70,10]); // returns [1,0,3, 3,2,1]
 ```
 
-Signature: `earcut(coords[, holeIndices, numDimensions = 2])`.
+Signature: `earcut(vertices[, holes, dimensions = 2])`.
 
-* `coords` is a flat array of vertice coordinates like `[x0,y0, x1,y1, x2,y2, ...]`.
-* `holeIndices` is an array of hole indices if any
+* `vertices` is a flat array of vertice coordinates like `[x0,y0, x1,y1, x2,y2, ...]`.
+* `holes` is an array of hole _indices_ if any
   (e.g. `[5, 8]` for a 12-vertice input would mean one hole with vertices 5–7 and another with 8–11).
-* `numDimensions` is the number of coordinates per vertice in the input array (`2` by default).
+* `dimensions` is the number of coordinates per vertice in the input array (`2` by default).
 
 Each group of three vertice indices in the resulting array forms a triangle.
 
@@ -65,10 +66,24 @@ earcut([10,0,1, 0,50,2, 60,60,3, 70,10,4], null, 3);
 // [1,0,3, 3,2,1]
 ```
 
+If you pass a single vertice as a hole, Earcut treats it as a Steiner point.
+
 If your input is a multi-dimensional array (e.g. [GeoJSON Polygon](http://geojson.org/geojson-spec.html#polygon)),
-you can convert it to the format expected by Earcut with [a couple lines of codes](viz/viz.js#L99-L115).
+you can convert it to the format expected by Earcut with `earcut.flatten`:
 
-If you pass a single vertice as a hole, Earcut treats it as a Steiner point.
+```js
+var data = earcut.flatten(geojson.geometry.coordinates);
+var triangles = earcut(data.vertices, data.holes, data.dimensions);
+```
+
+After getting a triangulation, you can verify its correctness with `earcut.deviation`:
+
+```js
+var deviation = earcut.deviation(vertices, holes, dimensions, triangles);
+```
+
+Returns the relative difference between the total area of triangles and the area of the input polygon.
+`0` means the triangulation is fully correct.
 
 #### Install
 
@@ -78,13 +93,10 @@ NPM and Browserify:
 npm install earcut
 ```
 
-Browser builds:
+Browser builds on CDN:
 
-```bash
-npm install
-npm run build-dev # builds dist/earcut.dev.js, a dev version with a source map
-npm run build-min # builds dist/earcut.min.js, a minified production build
-```
+- [development build](https://npmcdn.com/earcut@2.0.8/dist/earcut.dev.js)
+- [minified production build](https://npmcdn.com/earcut@2.0.8/dist/earcut.min.js)
 
 Running tests:
 
@@ -97,10 +109,35 @@ npm test
 #### Ports to other languages
 
 - [mapbox/earcut.hpp](https://github.com/mapbox/earcut.hpp) (C++11)
-- [Cawfree/earcut-j](https://github.com/Cawfree/earcut-j) (Java)
+- [Cawfree/earcut-j](https://github.com/Cawfree/earcut-j) (Java, outdated)
 
 #### Changelog
 
+##### 2.1.1 (Mar 17, 2016)
+
+- Fixed a rare race condition where the split routine would choose bad diagonals.
+- Fixed a rare race condition in the "cure local intersections" routine.
+- Fixed a rare race condition where a hole that shares a point with the outer ring would be handled incorrectly.
+- Fixed a bug where a closing point wouldn't be filtered as duplicate, sometimes breaking triangulation.
+
+##### 2.1.0 (Mar 11, 2016)
+
+- Added `earcut.deviation` function for verifying correctness of triangulation.
+- Added `earcut.flatten` function for converting GeoJSON-like input into a format Earcut expects.
+
+##### 2.0.9 (Mar 10, 2016)
+
+- Fixed a rare race condition where a hole would be handled incorrectly.
+
+##### 2.0.8 (Jan 19, 2016)
+
+- Fixed a rare race condition with a hole touching outer ring.
+
+##### 2.0.7 (Nov 18, 2015)
+
+- Changed the algorithm to avoid filtering colinear/duplicate vertices unless it can't triangulate the polygon otherwise.
+  Improves performance on simpler shapes and fixes some 3D use cases.
+
 ##### 2.0.6 (Oct 26, 2015)
 
 - Improved robustness and reliability of the triangulation algorithm.