Skip to content

Latest commit

 

History

History
126 lines (90 loc) · 4.55 KB

README.md

File metadata and controls

126 lines (90 loc) · 4.55 KB
Raw

@thi.ng/geom-closest-point

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

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

Installation

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

ESM import:

import * as gcp from "@thi.ng/geom-closest-point";

Browser ESM import:

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

JSDelivr documentation

For Node.js REPL:

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

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

Dependencies

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

Usage examples

One project in this repo's /examples directory is using this package:

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

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 - 2024 Karsten Schmidt // Apache License 2.0