refactor(vectors): cleanup, update docs/readme

thi-ng · Oct 2, 2020 · 142515f · 142515f
1 parent 6e78a2b
commit 142515f
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 52 deletions.
diff --git a/packages/vectors/README.md b/packages/vectors/README.md
@@ -155,7 +155,7 @@ yarn add @thi.ng/vectors
 <script src="https://unpkg.com/@thi.ng/vectors/lib/index.umd.js" crossorigin></script>
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 11.15 KB / CJS: 14.03 KB / UMD: 12.40 KB
+Package sizes (gzipped, pre-treeshake): ESM: 11.19 KB / CJS: 14.08 KB / UMD: 12.43 KB
 
 ## Dependencies
 
@@ -446,12 +446,13 @@ Component wise op with one input vector and single scalar:
 
 ### Distances
 
-| Function        | Generic | Fixed | Strided | Int | Comments |
-|-----------------|---------|-------|---------|-----|----------|
-| `dist`          | ✓       |       |         |     |          |
-| `distSq`        | ✓       | 2-4   |         |     |          |
-| `distChebyshev` | ✓       | 2-4   |         |     |          |
-| `distManhattan` | ✓       | 2-4   |         |     |          |
+| Function        | Generic | Fixed | Strided | Int | Comments          |
+|-----------------|---------|-------|---------|-----|-------------------|
+| `dist`          | ✓       |       |         |     |                   |
+| `distSq`        | ✓       | 2-4   |         |     |                   |
+| `distChebyshev` | ✓       | 2-4   |         |     |                   |
+| `distManhattan` | ✓       | 2-4   |         |     |                   |
+| `pointOnRay`    | ✓       | 2-3   |         |     | point at distance |
 
 ### Orientation
 

diff --git a/packages/vectors/src/index.ts b/packages/vectors/src/index.ts
@@ -127,8 +127,8 @@ export * from "./normalizes";
 export * from "./not";
 export * from "./ortho-normal";
 export * from "./perpendicular";
+export * from "./point-on-ray";
 export * from "./polar";
-export * from "./point-at";
 export * from "./pow";
 export * from "./pown";
 export * from "./project";

diff --git a/packages/vectors/src/point-at.ts b/packages/vectors/src/point-at.ts
diff --git a/packages/vectors/src/point-on-ray.ts b/packages/vectors/src/point-on-ray.ts
@@ -0,0 +1,48 @@
+import { Vec } from "./api";
+import { maddN, maddN2, maddN3 } from "./maddn";
+
+/**
+ * Calculates the nD point laying on ray at given distance. `rayDir` MUST be
+ * normalized.
+ *
+ * @param out -
+ * @param rayOrigin -
+ * @param rayDir -
+ * @param dist -
+ */
+export const pointOnRay = (
+    out: Vec | null,
+    rayOrigin: Vec,
+    rayDir: Vec,
+    dist: number
+) => maddN(out, rayDir, dist, rayOrigin);
+
+/**
+ * 2D version of {@link pointOnRay}.
+ *
+ * @param out -
+ * @param rayOrigin -
+ * @param rayDir -
+ * @param dist -
+ */
+export const pointOnRay2 = (
+    out: Vec | null,
+    rayOrigin: Vec,
+    rayDir: Vec,
+    dist: number
+) => maddN2(out, rayDir, dist, rayOrigin);
+
+/**
+ * 3D version of {@link pointOnRay}.
+ *
+ * @param out -
+ * @param rayOrigin -
+ * @param rayDir -
+ * @param dist -
+ */
+export const pointOnRay3 = (
+    out: Vec | null,
+    rayOrigin: Vec,
+    rayDir: Vec,
+    dist: number
+) => maddN3(out, rayDir, dist, rayOrigin);
diff --git a/packages/vectors/tpl.readme.md b/packages/vectors/tpl.readme.md
@@ -350,12 +350,13 @@ Component wise op with one input vector and single scalar:
 
 ### Distances
 
-| Function        | Generic | Fixed | Strided | Int | Comments |
-|-----------------|---------|-------|---------|-----|----------|
-| `dist`          | ✓       |       |         |     |          |
-| `distSq`        | ✓       | 2-4   |         |     |          |
-| `distChebyshev` | ✓       | 2-4   |         |     |          |
-| `distManhattan` | ✓       | 2-4   |         |     |          |
+| Function        | Generic | Fixed | Strided | Int | Comments          |
+|-----------------|---------|-------|---------|-----|-------------------|
+| `dist`          | ✓       |       |         |     |                   |
+| `distSq`        | ✓       | 2-4   |         |     |                   |
+| `distChebyshev` | ✓       | 2-4   |         |     |                   |
+| `distManhattan` | ✓       | 2-4   |         |     |                   |
+| `pointOnRay`    | ✓       | 2-3   |         |     | point at distance |
 
 ### Orientation