feat(geom): add proximity()

thi-ng · May 3, 2024 · 5d5951c · 5d5951c
1 parent 35ce854
commit 5d5951c
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/packages/geom/src/index.ts b/packages/geom/src/index.ts
@@ -38,6 +38,7 @@ export * from "./plane.js";
 export * from "./points.js";
 export * from "./polygon.js";
 export * from "./polyline.js";
+export * from "./proximity.js";
 export * from "./quad.js";
 export * from "./quadratic.js";
 export * from "./ray.js";

diff --git a/packages/geom/src/proximity.ts b/packages/geom/src/proximity.ts
@@ -0,0 +1,16 @@
+import type { IShape } from "@thi.ng/geom-api";
+import type { ReadonlyVec } from "@thi.ng/vectors";
+import { dist } from "@thi.ng/vectors/dist";
+import { closestPoint } from "./closest-point.js";
+
+/**
+ * Computes {@link closestPoint} on `shape` to `p`, and if successful, returns
+ * eucledian distance between that point and `p`.
+ *
+ * @param shape
+ * @param p
+ */
+export const proximity = (shape: IShape, p: ReadonlyVec) => {
+	const q = closestPoint(shape, p);
+	return q ? dist(p, q) : undefined;
+};