Skip to content

Latest commit

 

History

History

geom-closest-point

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

geom-closest-point

npm version npm downloads Twitter Follow

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

About

2D / 3D closest point / proximity helpers.

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-closest-point
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/geom-closest-point?module" crossorigin></script>

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

Package sizes (gzipped, pre-treeshake): ESM: 1.01 KB / CJS: 1.10 KB / UMD: 1.14 KB

Dependencies

Usage examples

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

A selection:

Screenshot Description Live demo Source
Interactive visualization of closest points on ellipses Demo Source

API

Generated API docs

  • closestPointAABB
  • closestPointArray
  • closestPointCircle
  • closestPointLine
  • closestPointPlane
  • closestPointPolyline
  • closestPointRect
  • closestPointSphere
  • closestPointSegment
  • closestT
  • distToLine
  • distToSegment

Authors

Karsten Schmidt

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

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

License

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