Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/geom-closest-point

geom-closest-point

npm versionnpm 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:

ScreenshotDescriptionLive demoSource
Interactive visualization of closest points on ellipsesDemoSource

API

Generated API docs

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

Authors

Karsten Schmidt

License

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

Generated using TypeDoc