Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/geom-resample

geom-resample

npm versionnpm downloads Twitter Follow

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

About

Customizable nD polyline interpolation, re-sampling, splitting & nearest point computation.

Also includes an implementation of Douglas-Peucker polyline / polygon simplification.

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

Status

STABLE - used in production

Installation

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

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

Package sizes (gzipped, pre-treeshake): ESM: 1.21 KB / CJS: 1.27 KB / UMD: 1.38 KB

Dependencies

Usage examples

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

A selection:

ScreenshotDescriptionLive demoSource
Animated Voronoi diagram, cubic splines & SVG downloadDemoSource

API

Generated API docs

import { resample, simplify } from "@thi.ng/geom-resample";

// resample polygon w/ uniform distance
const pts = resample([[0,0], [100,0], [100,100], [0,100]], { dist: 25 }, true)

// [ [ 0, 0 ], [ 25, 0 ], [ 50, 0 ], [ 75, 0 ],
//   [ 100, 0 ], [ 100, 25 ], [ 100, 50 ], [ 100, 75 ],
//   [ 100, 100 ], [ 75, 100 ], [ 50, 100 ], [ 25, 100 ],
//   [ 0, 100 ], [ 0, 75 ], [ 0, 50 ], [ 0, 25 ] ]

// simply polygon
// (epsilon = 0 only removes co-linear points, increase if necessary)
simplify(pts, 0, true)

// [ [ 0, 0 ], [ 100, 0 ], [ 100, 100 ], [ 0, 100 ] ]

Authors

Karsten Schmidt

License

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

Generated using TypeDoc