Skip to content

Latest commit

 

History

History

geom-resample

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

@thi.ng/geom-resample

npm version npm downloads Mastodon Follow

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

Customizable nD polyline interpolation, re-sampling, splitting & nearest point computation. This is a support package for @thi.ng/geom.

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

Search or submit any issues for this package

Installation

yarn add @thi.ng/geom-resample

ESM import:

import * as sample from "@thi.ng/geom-resample";

Browser ESM import:

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

JSDelivr documentation

For Node.js REPL:

const sample = await import("@thi.ng/geom-resample");

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

Dependencies

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

Usage examples

Two projects in this repo's /examples directory are using this package:

Screenshot Description Live demo Source
Animated, iterative polygon subdivisions & visualization Demo Source
Animated Voronoi diagram, cubic splines & SVG download Demo Source

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

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

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

License

© 2013 - 2024 Karsten Schmidt // Apache License 2.0