README.md

This project is part of the @thi.ng/umbrella monorepo.

• About
  • Status
• Installation
• Dependencies
• Usage examples
• API
• Authors
• License

About

2D/3D convex polygon tessellators.

• earcut
• edgeSplit
• inset
• quadFan
• rimTris
• triFan

Note: Though not officially supported, all functions might also work (in principle) with concave polygons, though correct results are highly dependent on the concavities present. YMMV!

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/geom-tessellate

// ES module
<script type="module" src="https://unpkg.com/@thi.ng/geom-tessellate?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/geom-tessellate/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 788 bytes / CJS: 877 bytes / UMD: 941 bytes

Dependencies

• @thi.ng/checks
• @thi.ng/geom-api
• @thi.ng/geom-isec
• @thi.ng/geom-poly-utils
• @thi.ng/transducers
• @thi.ng/vectors

Usage examples

Several demos in this repo's /examples directory are using this package.

A selection:

Screenshot	Description	Live demo	Source
	Animated, recursive polygon tessellations	Demo	Source

API

Generated API docs

TODO

Authors

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-geom-tessellate,
  title = "@thi.ng/geom-tessellate",
  author = "Karsten Schmidt",
  note = "https://thi.ng/geom-tessellate",
  year = 2016
}

License

© 2016 - 2021 Karsten Schmidt // Apache Software License 2.0