@thi.ng/geom-axidraw 0.1.3 → 0.2.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-22T21:47:07Z
+- **Last updated**: 2022-12-29T20:56:59Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,21 @@ 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.
 
+## [0.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom-axidraw@0.2.0) (2022-12-29)
+
+#### 🚀 Features
+
+- add shapesByNearestNeighbor() ([0059766](https://github.com/thi-ng/umbrella/commit/0059766))
+- add skip attrib ([4675151](https://github.com/thi-ng/umbrella/commit/4675151))
+  - update group & points conversion fns
+  - update deps
+
+#### ♻️ Refactoring
+
+- update pointsByNearestNeighbor() ([8a171e0](https://github.com/thi-ng/umbrella/commit/8a171e0))
+  - lift `accel` spatial index impl as arg
+  - update doc strings
+
 ## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom-axidraw@0.1.0) (2022-12-10)
 
 #### 🚀 Features

package/api.d.ts

@@ -52,6 +52,12 @@ export interface AxiDrawAttribs {
      * - {@link shapesByProximity} (for `group()`)
      */
     sort: PointOrdering | ShapeOrdering;
+    /**
+     * Only used for groups or point clouds. If given, only every (n+1)th child
+     * shape or point is being processed and the others ignored. Useful for low
+     * detail test runs.
+     */
+    skip: number;
 }
 export interface AsAxiDrawOpts {
     /**

package/as-axidraw.js

@@ -6,6 +6,7 @@ import { pointInPolygon2 } from "@thi.ng/geom-isec/point";
 import { applyTransforms } from "@thi.ng/geom/apply-transforms";
 import { asPolyline } from "@thi.ng/geom/as-polyline";
 import { __dispatch } from "@thi.ng/geom/internal/dispatch";
+import { takeNth } from "@thi.ng/transducers/take-nth";
 import { pointsByNearestNeighbor } from "./sort.js";
 /**
  * Lazily converts given shape (or group) into an iterable of thi.ng/axidraw
@@ -67,9 +68,10 @@ export const asAxiDraw = defmulti(__dispatch, {
     group: ($, opts) => __group($, opts),
 });
 function* __group($, opts) {
-    const { sort } = __axiAttribs($.attribs);
-    const children = sort ? sort($.children) : $.children;
-    for (let child of children) {
+    const { skip, sort } = __axiAttribs($.attribs);
+    const children = skip ? [...takeNth(skip + 1, $.children)] : $.children;
+    const childrenIter = sort ? sort(children) : children;
+    for (let child of childrenIter) {
         const shape = applyTransforms(child);
         shape.attribs = {
             ...shape.attribs,
@@ -81,7 +83,7 @@ function* __group($, opts) {
 function* __points(pts, attribs, opts) {
     if (!pts.length)
         return;
-    const { clip, delayDown, delayUp, down, speed, sort } = {
+    const { clip, delayDown, delayUp, down, skip, speed, sort } = {
         sort: pointsByNearestNeighbor(),
         ...__axiAttribs(attribs),
     };
@@ -91,6 +93,9 @@ function* __points(pts, attribs, opts) {
         if (!pts.length)
             return;
     }
+    if (skip) {
+        pts = [...takeNth(skip + 1, pts)];
+    }
     yield UP;
     if (down != undefined)
         yield ["pen", down];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/geom-axidraw",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Conversion and preparation of thi.ng/geom shapes & shape groups to AxiDraw pen plotter draw commands",
   "type": "module",
   "module": "./index.js",
@@ -35,16 +35,17 @@
   },
   "dependencies": {
     "@thi.ng/api": "^8.6.2",
-    "@thi.ng/arrays": "^2.4.7",
-    "@thi.ng/axidraw": "^0.2.3",
+    "@thi.ng/arrays": "^2.5.0",
+    "@thi.ng/axidraw": "^0.3.0",
     "@thi.ng/compare": "^2.1.21",
     "@thi.ng/defmulti": "^2.1.26",
-    "@thi.ng/geom": "^4.1.0",
-    "@thi.ng/geom-accel": "^3.2.31",
-    "@thi.ng/geom-api": "^3.3.23",
-    "@thi.ng/geom-clip-line": "^2.2.3",
-    "@thi.ng/geom-isec": "^2.1.40",
-    "@thi.ng/vectors": "^7.5.29"
+    "@thi.ng/geom": "^4.1.1",
+    "@thi.ng/geom-accel": "^3.2.32",
+    "@thi.ng/geom-api": "^3.3.24",
+    "@thi.ng/geom-clip-line": "^2.2.4",
+    "@thi.ng/geom-isec": "^2.1.41",
+    "@thi.ng/transducers": "^8.3.29",
+    "@thi.ng/vectors": "^7.5.30"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
@@ -117,5 +118,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "bc6f7f5e2765bb96fe64db804eaf4b2443b47fc6\n"
+  "gitHead": "28bb74c67217a352d673b6efdab234921d4a370e\n"
 }

package/sort.d.ts

@@ -1,19 +1,22 @@
+import type { IRegionQuery, IShape, ISpatialMap, ISpatialSet } from "@thi.ng/geom-api";
 import { ReadonlyVec } from "@thi.ng/vectors/api";
 import type { PointOrdering, ShapeOrdering } from "./api.js";
 /**
- * Higher order point ordering fn. Lazily sorts points by nearest neighbor
+ * Higher order point ordering fn. Adds points to given spatial
+ * index/acceleration structure and then lazily sorts them by nearest neighbor
  * distance, starting selection of first point based on given `ref` point
  * (default: [0, 0]).
  *
  * @remarks
- * Internally uses a
+ * By default is using a
  * [`KdTreeSet`](https://docs.thi.ng/umbrella/geom-accel/classes/KdTreeSet.html)
  * to index all points and then successively perform efficient nearest neighbor
  * searches (always w.r.t the most recent result point).
  *
+ * @param accel
  * @param ref
  */
-export declare const pointsByNearestNeighbor: (ref?: ReadonlyVec) => PointOrdering;
+export declare const pointsByNearestNeighbor: (accel?: ISpatialSet<ReadonlyVec> & IRegionQuery<ReadonlyVec, ReadonlyVec, number>, ref?: ReadonlyVec) => PointOrdering;
 /**
  * Higher order point ordering fn. Sorts points by proximity to given `ref` point
  * (default: [0, 0]).
@@ -28,4 +31,19 @@ export declare const pointsByProximity: (ref?: ReadonlyVec) => PointOrdering;
  * @param ref
  */
 export declare const shapesByProximity: (ref?: ReadonlyVec) => ShapeOrdering;
+/**
+ * Similar to {@link pointsByNearestNeighbor}, however for shapes and requiring
+ * an
+ * [`ISpatialMap`](https://docs.thi.ng/umbrella/geom-api/interfaces/ISpatialMap.html)
+ * implementation and is using shape centroid (auto-computed) to perform
+ * indexing and nearest neighbor queries.
+ *
+ * @remarks
+ * Currently recommended to use
+ * [`NdQuadtreeMap`](https://docs.thi.ng/umbrella/geom-accel/classes/NdQuadtreeMap.html).
+ *
+ * @param accel
+ * @param ref
+ */
+export declare const shapesByNearestNeighbor: (accel: ISpatialMap<ReadonlyVec, IShape> & IRegionQuery<ReadonlyVec, IShape, number>, ref?: ReadonlyVec) => ShapeOrdering;
 //# sourceMappingURL=sort.d.ts.map

package/sort.js

@@ -5,23 +5,26 @@ import { centroid } from "@thi.ng/geom/centroid";
 import { ZERO2 } from "@thi.ng/vectors/api";
 import { distSq2 } from "@thi.ng/vectors/distsq";
 /**
- * Higher order point ordering fn. Lazily sorts points by nearest neighbor
+ * Higher order point ordering fn. Adds points to given spatial
+ * index/acceleration structure and then lazily sorts them by nearest neighbor
  * distance, starting selection of first point based on given `ref` point
  * (default: [0, 0]).
  *
  * @remarks
- * Internally uses a
+ * By default is using a
  * [`KdTreeSet`](https://docs.thi.ng/umbrella/geom-accel/classes/KdTreeSet.html)
  * to index all points and then successively perform efficient nearest neighbor
  * searches (always w.r.t the most recent result point).
  *
+ * @param accel
  * @param ref
  */
-export const pointsByNearestNeighbor = (ref = ZERO2) => function* (pts) {
-    const index = new KdTreeSet(2, pts);
-    while (index.size) {
-        ref = index.queryKeys(ref, 1e4, 1)[0];
-        index.remove(ref);
+export const pointsByNearestNeighbor = (accel = new KdTreeSet(2), ref = ZERO2) => function* (pts) {
+    accel.into(pts);
+    // const index = new KdTreeSet(2, pts);
+    while (accel.size) {
+        ref = accel.queryKeys(ref, 1e4, 1)[0];
+        accel.remove(ref);
         yield ref;
     }
 };
@@ -43,3 +46,26 @@ export const pointsByProximity = (ref = ZERO2) => (pts) => {
 export const shapesByProximity = (ref = ZERO2) => (shapes) => {
     return sortByCachedKey(shapes.slice(), (s) => distSq2(centroid(s) || ZERO2, ref), compareNumAsc);
 };
+/**
+ * Similar to {@link pointsByNearestNeighbor}, however for shapes and requiring
+ * an
+ * [`ISpatialMap`](https://docs.thi.ng/umbrella/geom-api/interfaces/ISpatialMap.html)
+ * implementation and is using shape centroid (auto-computed) to perform
+ * indexing and nearest neighbor queries.
+ *
+ * @remarks
+ * Currently recommended to use
+ * [`NdQuadtreeMap`](https://docs.thi.ng/umbrella/geom-accel/classes/NdQuadtreeMap.html).
+ *
+ * @param accel
+ * @param ref
+ */
+export const shapesByNearestNeighbor = (accel, ref = ZERO2) => function* (shapes) {
+    accel.into(shapes.map((s) => [centroid(s) || [0, 0], s]));
+    while (accel.size) {
+        const pair = accel.query(ref, 1e4, 1)[0];
+        ref = pair[0];
+        accel.remove(ref);
+        yield pair[1];
+    }
+};