Skip to content

Latest commit

 

History

History

geom-hull

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

geom-hull

npm version npm downloads Twitter Follow

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

About

Fast 2D convex hull (Graham Scan). This is a support package for @thi.ng/geom.

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 import:

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

Skypack documentation

For NodeJS (v14.6+):

node --experimental-specifier-resolution=node --experimental-repl-await

> const geomHull = await import("@thi.ng/geom-hull");

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

Dependencies

Usage examples

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

A selection:

Screenshot Description Live demo Source
Convex hull & shape clipping of 2D polygons Demo Source

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

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

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

License

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