Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/geom-hull

geom-hull

npm versionnpm downloads Twitter Follow

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

About

Fast 2D convex hull (Graham Scan).

Current implementation is partially based on 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-hull
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/geom-hull?module" crossorigin></script>

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

Package sizes (gzipped, pre-treeshake): ESM: 432 bytes / CJS: 487 bytes / UMD: 596 bytes

Dependencies

Usage examples

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

A selection:

ScreenshotDescriptionLive demoSource
Convex hull & shape clipping of 2D polygonsDemoSource

API

Generated API docs

import { grahamScan2 } from "@thi.ng/geom-hull";

grahamScan2([[0, 0], [50, 10], [100, 0], [80, 50], [100, 100], [50, 90], [0, 100]]);
// [ [ 0, 0 ], [ 100, 0 ], [ 100, 100 ], [ 0, 100 ] ]

Authors

Karsten Schmidt

License

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

Generated using TypeDoc