@thi.ng/geom 4.2.12 → 4.3.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-03-14T13:27:19Z
+- **Last updated**: 2023-03-22T22:24:21Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [4.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom@4.3.0) (2023-03-22)
+
+#### 🚀 Features
+
+- add splitArclength() ([906a326](https://github.com/thi-ng/umbrella/commit/906a326))
+- add spiral() polyline factory fn ([572e0ef](https://github.com/thi-ng/umbrella/commit/572e0ef))
+
 ## [4.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom@4.2.0) (2023-01-10)
 
 #### 🚀 Features

package/README.md

@@ -198,7 +198,7 @@ For Node.js REPL:
 const geom = await import("@thi.ng/geom");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 12.10 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 12.29 KB
 
 ## Dependencies
 

package/index.d.ts

@@ -69,6 +69,7 @@ export * from "./rotate.js";
 export * from "./scale.js";
 export * from "./scatter.js";
 export * from "./simplify.js";
+export * from "./split-arclength.js";
 export * from "./split-at.js";
 export * from "./split-near.js";
 export * from "./subdiv-curve.js";

package/index.js

@@ -69,6 +69,7 @@ export * from "./rotate.js";
 export * from "./scale.js";
 export * from "./scatter.js";
 export * from "./simplify.js";
+export * from "./split-arclength.js";
 export * from "./split-at.js";
 export * from "./split-near.js";
 export * from "./subdiv-curve.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/geom",
-  "version": "4.2.12",
+  "version": "4.3.0",
   "description": "Functional, polymorphic API for 2D geometry types & SVG generation",
   "type": "module",
   "module": "./index.js",
@@ -334,6 +334,9 @@
     "./sphere": {
       "default": "./sphere.js"
     },
+    "./split-arclength": {
+      "default": "./split-arclength.js"
+    },
     "./split-at": {
       "default": "./split-at.js"
     },
@@ -395,5 +398,5 @@
     ],
     "year": 2013
   },
-  "gitHead": "1359645f3af8a7d0d43fe7944ea5cd865832f8ee\n"
+  "gitHead": "5b3d731c0e192c53f65efb4baed97be0e4029a33\n"
 }

package/polyline.d.ts

@@ -1,5 +1,24 @@
 import type { Attribs } from "@thi.ng/geom-api";
-import type { Vec } from "@thi.ng/vectors";
+import type { ReadonlyVec, Vec } from "@thi.ng/vectors";
 import { Polyline } from "./api/polyline.js";
 export declare const polyline: (pts: Vec[], attribs?: Attribs) => Polyline;
+/**
+ * Creates a polyline spiral from given params. The number of twists is defined
+ * by the angle range. Resolution depends on angle range and number of steps.
+ *
+ * @example
+ * ```ts
+ * // 4 full turns over 80 steps
+ * spiral([0, 0], 5, 100, 0, Math.PI * 2 * 4, 80);
+ * ```
+ *
+ * @param origin
+ * @param r1
+ * @param r2
+ * @param startTheta
+ * @param endTheta
+ * @param steps
+ * @param attribs
+ */
+export declare const spiral: (origin: ReadonlyVec, r1: number, r2: number, startTheta: number, endTheta: number, steps: number, attribs?: Attribs) => Polyline;
 //# sourceMappingURL=polyline.d.ts.map

package/polyline.js

@@ -1,2 +1,27 @@
+import { mix } from "@thi.ng/math/mix";
+import { map } from "@thi.ng/transducers/map";
+import { normRange } from "@thi.ng/transducers/norm-range";
+import { cartesian2 } from "@thi.ng/vectors/cartesian";
 import { Polyline } from "./api/polyline.js";
 export const polyline = (pts, attribs) => new Polyline(pts, attribs);
+/**
+ * Creates a polyline spiral from given params. The number of twists is defined
+ * by the angle range. Resolution depends on angle range and number of steps.
+ *
+ * @example
+ * ```ts
+ * // 4 full turns over 80 steps
+ * spiral([0, 0], 5, 100, 0, Math.PI * 2 * 4, 80);
+ * ```
+ *
+ * @param origin
+ * @param r1
+ * @param r2
+ * @param startTheta
+ * @param endTheta
+ * @param steps
+ * @param attribs
+ */
+export const spiral = (origin, r1, r2, startTheta, endTheta, steps, attribs) => new Polyline([
+    ...map((t) => cartesian2(null, [mix(r1, r2, t), mix(startTheta, endTheta, t)], origin), normRange(steps - 1)),
+], attribs);

package/split-arclength.d.ts

@@ -0,0 +1,20 @@
+import type { MultiFn2 } from "@thi.ng/defmulti";
+import type { IShape } from "@thi.ng/geom-api";
+/**
+ * Splits given shape into {@link Polyline} segments of given (max) arc length.
+ * Returns array of new shapes/polylines.
+ *
+ * @remarks
+ * Currently only implemented for:
+ *
+ * - {@link Group}
+ * - {@link Polyline}
+ *
+ * Other shape types will be attempted to be auto-converted via
+ * {@link asPolyline} first.
+ *
+ * @param shape
+ * @param dist
+ */
+export declare const splitArclength: MultiFn2<IShape, number, IShape[]>;
+//# sourceMappingURL=split-arclength.d.ts.map

package/split-arclength.js

@@ -0,0 +1,53 @@
+import { DEFAULT, defmulti } from "@thi.ng/defmulti/defmulti";
+import { Sampler } from "@thi.ng/geom-resample/sampler";
+import { mapcat } from "@thi.ng/transducers/mapcat";
+import { Group } from "./api/group.js";
+import { Polyline } from "./api/polyline.js";
+import { asPolyline } from "./as-polyline.js";
+import { __copyAttribs } from "./internal/copy.js";
+import { __dispatch } from "./internal/dispatch.js";
+import { __pointArraysAsShapes } from "./internal/points-as-shape.js";
+/**
+ * Splits given shape into {@link Polyline} segments of given (max) arc length.
+ * Returns array of new shapes/polylines.
+ *
+ * @remarks
+ * Currently only implemented for:
+ *
+ * - {@link Group}
+ * - {@link Polyline}
+ *
+ * Other shape types will be attempted to be auto-converted via
+ * {@link asPolyline} first.
+ *
+ * @param shape
+ * @param dist
+ */
+export const splitArclength = defmulti(__dispatch, {}, {
+    [DEFAULT]: ($, d) => splitArclength(asPolyline($), d),
+    group: ($, d) => [
+        new Group(__copyAttribs($.attribs), [
+            ...mapcat((c) => splitArclength(c, d), $.children),
+        ]),
+    ],
+    polyline: ($, d) => {
+        const chunks = [];
+        let pts = $.points;
+        while (true) {
+            const sampler = new Sampler(pts);
+            const total = sampler.totalLength();
+            if (total > d) {
+                const parts = sampler.splitAt(d / total);
+                if (!parts)
+                    break;
+                chunks.push(parts[0]);
+                pts = parts[1];
+            }
+            else {
+                chunks.push(pts);
+                break;
+            }
+        }
+        return __pointArraysAsShapes(Polyline, chunks, $.attribs);
+    },
+});