@thi.ng/geom-poly-utils

[!NOTE] This is one of 199 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

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

About

2D polygon/polyline analysis & processing utilities. This is a support package for @thi.ng/geom.

• signed 2D polygon & triangle area
• triangle barycentric coord conversion
• nD point cloud bounding box
• 2D poly center of weight
• nD point cloud centroid
• 2D circumcenter
• 2D polygon convexity classification
• 2D equilateral triangle
• polygon / polyline perimeter

Current implementations partially based on toxiclibs (Java) and Clojure version of thi.ng/geom.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/geom-poly-utils

ESM import:

import * as gpu from "@thi.ng/geom-poly-utils";

Browser ESM import:

<script type="module" src="https://esm.run/@thi.ng/geom-poly-utils"></script>

JSDelivr documentation

For Node.js REPL:

const gpu = await import("@thi.ng/geom-poly-utils");

Package sizes (brotli'd, pre-treeshake): ESM: 2.63 KB

Dependencies

• @thi.ng/api
• @thi.ng/errors
• @thi.ng/math
• @thi.ng/vectors

Note: @thi.ng/api is in most cases a type-only import (not used at runtime)

API

Generated API docs

TODO

Authors

• Karsten Schmidt

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

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

License

© 2013 - 2024 Karsten Schmidt // Apache License 2.0