\n\n## About\n\nThe fastest and smallest JavaScript polygon triangulation library with builtin tesselation. 3.18 kB minified and gzipped.\n\n## Install\n\n```bash\n# NPM\nnpm install earclip\n# PNPM\npnpm add earclip\n# Yarn\nyarn add earclip\n# Bun\nbun add earclip\n\n# Rust\ncargo add earclip\n```\n\n## The Algorithm\n\nThe library implements a modified ear slicing algorithm,\noptimized by [z-order curve](http://en.wikipedia.org/wiki/Z-order_curve) hashing\nand extended to handle holes, twisted polygons, degeneracies and self-intersections\nin a way that doesn't _guarantee_ correctness of triangulation,\nbut attempts to always produce acceptable results for practical data.\n\nIt's based on ideas from\n[FIST: Fast Industrial-Strength Triangulation of Polygons](http://www.cosy.sbg.ac.at/~held/projects/triang/triang.html) by Martin Held\nand [Triangulation by Ear Clipping](http://www.geometrictools.com/Documentation/TriangulationByEarClipping.pdf) by David Eberly.\n\n## Usage\n\n```ts\nimport { earclip } from 'earclip'\n\nconst poly = [[[3506,-2048],[7464,402],[-2048,2685],[-2048,-2048],[3506,-2048]],[[-2048,-37],[1235,747],[338,-1464],[-116,-1188],[-2048,-381],[-2048,-37]],[[-1491,-1981],[-1300,-1800],[-1155,-1981],[-1491,-1981]]]\nconst modulo = 8192 / 2\n\nconst res = earclip(poly, modulo)\nconsole.log(res)\n\nconst polyAsPoints = [\n [{ x: 3506, y: -2048 },{ x: 7464, y: 402 },{ x: -2048, y: 2685 },{ x: -2048, y: -2048 },{ 3506, y: -2048 }],\n [{ x: -2048, y: -37 },{ x: 1235, y: 747 },{ x: 338, y: -1464 },{ x: -116, y: -1188 },{ x: -2048, y: -381 },{ x: -2048, y: -37 }],\n [{ x: -1491, y: -1981 },{ x: -1300, y: -1800 },{ x: -1155, y: -1981 },{ x: -1491, y: -1981 }],\n]\nconst res2 = earclip(polyAsPoints, modulo)\n\nassert(res === res2)\n```\n\n> [!NOTE] \n> Safety Unsafe code is forbidden by a #![forbid(unsafe_code)] attribute in the root of the rust library.\n\n---\n\n## Development\n\n### Requirements\n\nYou need the tool `tarpaulin` to generate the coverage report. Install it using the following command:\n\n```bash\ncargo install cargo-tarpaulin\n```\n\nThe `bacon coverage` tool is used to generate the coverage report. To utilize the [pycobertura](https://pypi.org/project/pycobertura/) package for a prettier coverage report, install it using the following command:\n\n```bash\npip install pycobertura\n```\n\n### Running Tests\n\nTo run the tests, use the following command:\n\n```bash\n# TYPESCRIPT\n## basic test\nbun run test\n## live testing\nbun run test:dev\n\n# RUST\n## basic test\ncargo test\n# live testing\nbacon test\n```\n\n### Generating Coverage Report\n\nTo generate the coverage report, use the following command:\n\n```bash\ncargo tarpaulin\n# faster\ncargo tarpaulin --color always --skip-clean\n# bacon\nbacon coverage # or type `l` inside the tool\n```\n\n## Benchmarks\n\n### Rust\n\nRun the Rust benchmarks using the following command:\n\n```bash\ncargo +nightly bench\n```\n\n\n","readmeFilename":"README.md"}
![\"GitHub](\"https://img.shields.io/github/actions/workflow/status/Open-S2/earclip/test.yml?logo=github\")
\n \n ![\"npm\"](\"https://img.shields.io/npm/v/earclip.svg?logo=npm&logoColor=white\")
\n \n \n ![\"crate\"](\"https://img.shields.io/crates/v/earclip.svg?logo=rust&logoColor=white\")
\n \n \n ![\"downloads\"](\"https://img.shields.io/npm/dm/earclip.svg\")
\n \n \n ![\"bundle\"](\"https://img.shields.io/bundlejs/size/earclip?exports=earclip\")
\n \n \n ![\"docs-ts\"](\"https://img.shields.io/badge/docs-typescript-yellow.svg\"){kind=icon}
\n \n \n ![\"docs-rust\"](\"https://img.shields.io/badge/docs-rust-yellow.svg\"){kind=icon}
\n \n ![\"doc-coverage\"](\"https://raw.githubusercontent.com/Open-S2/earclip/master/assets/doc-coverage.svg\")
\n \n ![\"code-coverage\"](\"https://coveralls.io/repos/github/Open-S2/earclip/badge.svg?branch=master\"){kind=icon}
\n \n \n ![\"Discord\"](\"https://img.shields.io/discord/953563031701426206?logo=discord&logoColor=white\")
\n \n