geom-closest-point

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

• About
  • Status
  • Related packages
• Installation
• Dependencies
• Usage examples
• API
• Authors
• License

About

2D / 3D closest point / proximity helpers. This is a support package for @thi.ng/geom.

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

Related packages

• @thi.ng/geom-isec - 2D/3D shape intersection checks
• @thi.ng/geom-resample - Customizable nD polyline interpolation, re-sampling, splitting & nearest point computation

Installation

yarn add @thi.ng/geom-closest-point

ES module import:

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

Skypack documentation

For Node.js REPL:

# with flag only for < v16
node --experimental-repl-await

> const geomClosestPoint = await import("@thi.ng/geom-closest-point");

Package sizes (gzipped, pre-treeshake): ESM: 1.14 KB

Dependencies

• @thi.ng/api
• @thi.ng/math
• @thi.ng/vectors

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