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

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

About

2D convex polygon clipping (Sutherland-Hodgeman). This is a support package for @thi.ng/geom.

Current implementation is based on toxiclibs (Java) and Clojure version thi.ng/geom-clj.

This package has been extracted from the former (now obsolete) @thi.ng/geom-clip package.

Status

STABLE - used in production

Search or submit any issues for this package

Related packages

• @thi.ng/geom-clip-line - 2D line clipping (Liang-Barsky)

Installation

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

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/geom-clip-poly"></script>

Skypack documentation

For Node.js REPL:

# with flag only for < v16
node --experimental-repl-await

> const geomClipPoly = await import("@thi.ng/geom-clip-poly");

Package sizes (gzipped, pre-treeshake): ESM: 347 bytes

Dependencies

• @thi.ng/geom-isec
• @thi.ng/geom-poly-utils
• @thi.ng/math
• @thi.ng/vectors

API

Generated API docs

TODO

Authors

Karsten Schmidt

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

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

License

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