@thi.ng/geom 3.2.6 → 3.3.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-06-09T16:14:01Z
+- **Last updated**: 2022-06-20T17:33:30Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,15 @@ 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.
 
+## [3.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom@3.3.0) (2022-06-20)
+
+#### 🚀 Features
+
+- update bounds() to support opt. margin ([8cdc372](https://github.com/thi-ng/umbrella/commit/8cdc372))
+- update rect/aabb, add new factory fns ([f74e377](https://github.com/thi-ng/umbrella/commit/f74e377))
+  - add ...WithMargin() factory fns
+  - add AABBLike.offset() impls
+
 ### [3.2.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom@3.2.1) (2022-04-07)
 
 #### 🩹 Bug fixes

package/aabb.d.ts

@@ -6,6 +6,9 @@ export declare function aabb(pos: Vec, size: number | Vec, attribs?: Attribs): A
 export declare function aabb(size: number | Vec, attribs?: Attribs): AABB;
 export declare function aabb(attribs?: Attribs): AABB;
 export declare const aabbFromMinMax: (min: Vec, max: Vec, attribs?: Attribs) => AABB;
+export declare const aabbFromMinMaxWithMargin: (min: Vec, max: Vec, margin: number, attribs?: Attribs) => AABB;
+export declare const aabbFromCentroid: (centroid: Vec, size: Vec, attribs?: Attribs) => AABB;
+export declare const aabbFromCentroidWithMargin: (centroid: Vec, size: Vec, margin: number, attribs?: Attribs) => AABB;
 /**
  * Returns the intersection AABB of given inputs or `undefined` if they
  * are non-overlapping.

package/aabb.js

@@ -1,6 +1,7 @@
 import { SQRT2_2 } from "@thi.ng/math/api";
 import { add3 } from "@thi.ng/vectors/add";
 import { ZERO3 } from "@thi.ng/vectors/api";
+import { maddN3 } from "@thi.ng/vectors/maddn";
 import { max3 } from "@thi.ng/vectors/max";
 import { min3 } from "@thi.ng/vectors/min";
 import { sub3 } from "@thi.ng/vectors/sub";
@@ -11,6 +12,9 @@ export function aabb(...args) {
     return new AABB(...__argsVV(args));
 }
 export const aabbFromMinMax = (min, max, attribs) => new AABB(min, sub3([], max, min), attribs);
+export const aabbFromMinMaxWithMargin = (min, max, margin, attribs) => aabbFromMinMax(min, max, attribs).offset(margin);
+export const aabbFromCentroid = (centroid, size, attribs) => new AABB(maddN3([], size, -0.5, centroid), size, attribs);
+export const aabbFromCentroidWithMargin = (centroid, size, margin, attribs) => aabbFromCentroid(centroid, size, attribs).offset(margin);
 /**
  * Returns the intersection AABB of given inputs or `undefined` if they
  * are non-overlapping.

package/api/aabb.d.ts

@@ -8,5 +8,6 @@ export declare class AABB implements AABBLike {
     get type(): string;
     copy(): AABB;
     max(): Vec;
+    offset(offset: number): this;
 }
 //# sourceMappingURL=aabb.d.ts.map

package/api/aabb.js

@@ -1,6 +1,8 @@
 import { isNumber } from "@thi.ng/checks/is-number";
 import { add3 } from "@thi.ng/vectors/add";
+import { addN3 } from "@thi.ng/vectors/addn";
 import { set } from "@thi.ng/vectors/set";
+import { subN3 } from "@thi.ng/vectors/subn";
 import { __copyAttribs } from "../internal/copy.js";
 export class AABB {
     constructor(pos = [0, 0, 0], size = 1, attribs) {
@@ -17,4 +19,9 @@ export class AABB {
     max() {
         return add3([], this.pos, this.size);
     }
+    offset(offset) {
+        subN3(null, this.pos, offset);
+        addN3(null, this.size, offset * 2);
+        return this;
+    }
 }

package/api/rect.d.ts

@@ -8,6 +8,7 @@ export declare class Rect implements AABBLike, IHiccupShape {
     get type(): string;
     copy(): Rect;
     max(): Vec;
+    offset(offset: number): this;
     toHiccup(): (string | number | Attribs | undefined)[];
 }
 //# sourceMappingURL=rect.d.ts.map

package/api/rect.js

@@ -1,6 +1,8 @@
 import { isNumber } from "@thi.ng/checks/is-number";
 import { add2 } from "@thi.ng/vectors/add";
+import { addN2 } from "@thi.ng/vectors/addn";
 import { set2 } from "@thi.ng/vectors/set";
+import { subN2 } from "@thi.ng/vectors/subn";
 import { __copyAttribs } from "../internal/copy.js";
 export class Rect {
     constructor(pos = [0, 0], size = 1, attribs) {
@@ -17,6 +19,11 @@ export class Rect {
     max() {
         return add2([], this.pos, this.size);
     }
+    offset(offset) {
+        subN2(null, this.pos, offset);
+        addN2(null, this.size, offset * 2);
+        return this;
+    }
     toHiccup() {
         return ["rect", this.attribs, this.pos, this.size[0], this.size[1]];
     }

package/bounds.d.ts

@@ -1,4 +1,4 @@
-import type { MultiFn1 } from "@thi.ng/defmulti";
+import type { MultiFn1O } from "@thi.ng/defmulti";
 import type { AABBLike, IShape } from "@thi.ng/geom-api";
-export declare const bounds: MultiFn1<IShape, AABBLike | undefined>;
+export declare const bounds: MultiFn1O<IShape, number, AABBLike | undefined>;
 //# sourceMappingURL=bounds.d.ts.map

package/bounds.js

@@ -7,18 +7,18 @@ import { comp } from "@thi.ng/transducers/comp";
 import { filter } from "@thi.ng/transducers/filter";
 import { iterator1 } from "@thi.ng/transducers/iterator";
 import { map } from "@thi.ng/transducers/map";
+import { addN2 } from "@thi.ng/vectors/addn";
 import { max } from "@thi.ng/vectors/max";
 import { min } from "@thi.ng/vectors/min";
 import { mul2 } from "@thi.ng/vectors/mul";
 import { mulN2 } from "@thi.ng/vectors/muln";
-import { set2 } from "@thi.ng/vectors/set";
 import { sub2 } from "@thi.ng/vectors/sub";
 import { subN2 } from "@thi.ng/vectors/subn";
-import { aabbFromMinMax } from "./aabb.js";
+import { aabbFromMinMaxWithMargin } from "./aabb.js";
 import { Rect } from "./api/rect.js";
 import { __collBounds } from "./internal/bounds.js";
 import { __dispatch } from "./internal/dispatch.js";
-import { rectFromMinMax } from "./rect.js";
+import { rectFromMinMaxWithMargin } from "./rect.js";
 export const bounds = defmulti(__dispatch, {
     aabb: "rect",
     bpatch: "points",
@@ -27,24 +27,29 @@ export const bounds = defmulti(__dispatch, {
     quad: "points",
     tri: "points",
 }, {
-    arc: ($) => rectFromMinMax(...arcBounds($.pos, $.r, $.axis, $.start, $.end)),
-    circle: ($) => new Rect(subN2([], $.pos, $.r), mulN2(null, [2, 2], $.r)),
-    cubic: ({ points }) => rectFromMinMax(...cubicBounds(points[0], points[1], points[2], points[3])),
-    ellipse: ($) => new Rect(sub2([], $.pos, $.r), mul2(null, [2, 2], $.r)),
-    group: ($) => {
+    arc: ($, margin = 0) => rectFromMinMaxWithMargin(...arcBounds($.pos, $.r, $.axis, $.start, $.end), margin),
+    circle: ($, margin = 0) => new Rect(subN2([], $.pos, $.r + margin), mulN2(null, [2, 2], $.r + margin)),
+    cubic: ({ points }, margin = 0) => rectFromMinMaxWithMargin(...cubicBounds(points[0], points[1], points[2], points[3]), margin),
+    ellipse: ($, margin = 0) => {
+        const r = addN2([], $.r, margin);
+        return new Rect(sub2([], $.pos, r), mul2(null, [2, 2], r));
+    },
+    group: ($, margin = 0) => {
         const res = __collBounds($.children, bounds);
-        return res ? new Rect(...res) : undefined;
+        return res ? new Rect(...res).offset(margin) : undefined;
     },
-    line: ({ points: [a, b] }) => rectFromMinMax(min([], a, b), max([], a, b)),
-    path: (path) => {
+    line: ({ points: [a, b] }, margin = 0) => rectFromMinMaxWithMargin(min([], a, b), max([], a, b), margin),
+    path: (path, margin = 0) => {
         const b = __collBounds([
             ...iterator1(comp(map((s) => s.geo), filter((s) => !!s)), path.segments),
         ], bounds);
-        return b ? new Rect(...b) : undefined;
+        return b ? new Rect(...b).offset(margin) : undefined;
     },
-    points: ($) => rectFromMinMax(...bounds2($.points)),
-    points3: ($) => aabbFromMinMax(...bounds3($.points)),
-    quadratic: ({ points }) => rectFromMinMax(...quadraticBounds(points[0], points[1], points[2])),
-    rect: ($) => $.copy(),
-    text: ($) => new Rect(set2([], $.pos), [0, 0]),
+    points: ($, margin = 0) => rectFromMinMaxWithMargin(...bounds2($.points), margin),
+    points3: ($, margin = 0) => aabbFromMinMaxWithMargin(...bounds3($.points), margin),
+    quadratic: ({ points }, margin = 0) => rectFromMinMaxWithMargin(...quadraticBounds(points[0], points[1], points[2]), margin),
+    rect: ($, margin = 0) => margin === 0
+        ? $.copy()
+        : $.copy().offset(margin),
+    text: ($, margin = 0) => new Rect(subN2([], $.pos, margin), [0, 0]), // TODO
 });

package/internal/bounds.d.ts

@@ -2,10 +2,10 @@ import type { Fn } from "@thi.ng/api";
 import type { AABBLike, IShape } from "@thi.ng/geom-api";
 import type { ReadonlyVec, VecPair } from "@thi.ng/vectors";
 /**
- * Computes the total bounds for the given shape collection, which
- * should either contain only 2D or 3D types. No mixed dimensions are
- * allowed! Currently the {@link bounds} function MUST be passed in as
- * arg to avoid circular module dependencies.
+ * Computes the total bounds for the given shape collection, which should either
+ * contain only 2D or 3D types. No mixed dimensions are allowed! Currently the
+ * {@link bounds} function MUST be passed in as arg to avoid circular module
+ * dependencies. Returns 2-tuple of `[pos, size]`.
  *
  * @param shapes - input shapes
  * @param bounds - bbox function

package/internal/bounds.js

@@ -3,10 +3,10 @@ import { max } from "@thi.ng/vectors/max";
 import { min } from "@thi.ng/vectors/min";
 import { sub } from "@thi.ng/vectors/sub";
 /**
- * Computes the total bounds for the given shape collection, which
- * should either contain only 2D or 3D types. No mixed dimensions are
- * allowed! Currently the {@link bounds} function MUST be passed in as
- * arg to avoid circular module dependencies.
+ * Computes the total bounds for the given shape collection, which should either
+ * contain only 2D or 3D types. No mixed dimensions are allowed! Currently the
+ * {@link bounds} function MUST be passed in as arg to avoid circular module
+ * dependencies. Returns 2-tuple of `[pos, size]`.
  *
  * @param shapes - input shapes
  * @param bounds - bbox function

package/internal/copy.d.ts

@@ -1,4 +1,6 @@
 import type { Attribs, IShape, PCLike, PCLikeConstructor } from "@thi.ng/geom-api";
+/** @internal */
 export declare const __copyAttribs: ($: IShape) => Attribs;
-export declare const __copyShape: (ctor: PCLikeConstructor, inst: PCLike) => PCLike;
+/** @internal */
+export declare const __copyShape: <T extends PCLike>(ctor: PCLikeConstructor, inst: T) => T;
 //# sourceMappingURL=copy.d.ts.map

package/internal/copy.js

@@ -1,3 +1,6 @@
+// thing:export
 import { copyVectors } from "@thi.ng/vectors/copy";
+/** @internal */
 export const __copyAttribs = ($) => ({ ...$.attribs });
+/** @internal */
 export const __copyShape = (ctor, inst) => new ctor(copyVectors(inst.points), __copyAttribs(inst));

package/internal/dispatch.d.ts

@@ -1,4 +1,6 @@
 import type { IShape } from "@thi.ng/geom-api";
+/** @internal */
 export declare const __dispatch: (x: IShape) => string | number;
+/** @internal */
 export declare const __dispatch2: (a: IShape, b: IShape) => string;
 //# sourceMappingURL=dispatch.d.ts.map

package/internal/dispatch.js

@@ -1,2 +1,4 @@
+/** @internal */
 export const __dispatch = (x) => x.type;
+/** @internal */
 export const __dispatch2 = (a, b) => a.type + "-" + b.type;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/geom",
-  "version": "3.2.6",
+  "version": "3.3.0",
   "description": "Functional, polymorphic API for 2D geometry types & SVG generation",
   "type": "module",
   "module": "./index.js",
@@ -42,20 +42,20 @@
     "@thi.ng/defmulti": "^2.1.7",
     "@thi.ng/equiv": "^2.1.7",
     "@thi.ng/errors": "^2.1.7",
-    "@thi.ng/geom-api": "^3.1.14",
-    "@thi.ng/geom-arc": "^2.1.14",
-    "@thi.ng/geom-clip-line": "^2.1.14",
-    "@thi.ng/geom-clip-poly": "^2.1.14",
+    "@thi.ng/geom-api": "^3.2.0",
+    "@thi.ng/geom-arc": "^2.1.15",
+    "@thi.ng/geom-clip-line": "^2.1.15",
+    "@thi.ng/geom-clip-poly": "^2.1.15",
     "@thi.ng/geom-closest-point": "^2.1.14",
     "@thi.ng/geom-hull": "^2.1.14",
-    "@thi.ng/geom-isec": "^2.1.14",
-    "@thi.ng/geom-poly-utils": "^2.2.6",
-    "@thi.ng/geom-resample": "^2.1.14",
-    "@thi.ng/geom-splines": "^2.1.14",
-    "@thi.ng/geom-subdiv-curve": "^2.1.14",
-    "@thi.ng/geom-tessellate": "^2.1.14",
+    "@thi.ng/geom-isec": "^2.1.15",
+    "@thi.ng/geom-poly-utils": "^2.2.7",
+    "@thi.ng/geom-resample": "^2.1.15",
+    "@thi.ng/geom-splines": "^2.1.15",
+    "@thi.ng/geom-subdiv-curve": "^2.1.15",
+    "@thi.ng/geom-tessellate": "^2.1.15",
     "@thi.ng/hiccup": "^4.2.9",
-    "@thi.ng/hiccup-svg": "^4.2.14",
+    "@thi.ng/hiccup-svg": "^4.3.0",
     "@thi.ng/math": "^5.3.3",
     "@thi.ng/matrices": "^2.1.14",
     "@thi.ng/random": "^3.3.2",
@@ -247,6 +247,15 @@
     "./group": {
       "default": "./group.js"
     },
+    "./internal/copy": {
+      "default": "./internal/copy.js"
+    },
+    "./internal/dispatch": {
+      "default": "./internal/dispatch.js"
+    },
+    "./internal/transform": {
+      "default": "./internal/transform.js"
+    },
     "./intersects": {
       "default": "./intersects.js"
     },
@@ -362,5 +371,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "ab0188234419f2d9f471de80871df930e5555bd6\n"
+  "gitHead": "f50e292ecc7dc74a6705b07fc739bf827cc5efd7\n"
 }

package/rect.d.ts

@@ -7,7 +7,9 @@ export declare function rect(pos: Vec, size: number | Vec, attribs?: Attribs): R
 export declare function rect(size: number | Vec, attribs?: Attribs): Rect;
 export declare function rect(attribs?: Attribs): Rect;
 export declare const rectFromMinMax: (min: Vec, max: Vec, attribs?: Attribs) => Rect;
+export declare const rectFromMinMaxWithMargin: (min: Vec, max: Vec, margin: number, attribs?: Attribs) => Rect;
 export declare const rectFromCentroid: (centroid: Vec, size: Vec, attribs?: Attribs) => Rect;
+export declare const rectFromCentroidWithMargin: (centroid: Vec, size: Vec, margin: number, attribs?: Attribs) => Rect;
 /**
  * Returns the intersection rect of given inputs or `undefined` if they
  * are non-overlapping.

package/rect.js

@@ -14,7 +14,9 @@ export function rect(...args) {
     return new Rect(...__argsVV(args));
 }
 export const rectFromMinMax = (min, max, attribs) => new Rect(min, sub2([], max, min), attribs);
+export const rectFromMinMaxWithMargin = (min, max, margin, attribs) => rectFromMinMax(min, max, attribs).offset(margin);
 export const rectFromCentroid = (centroid, size, attribs) => new Rect(maddN2([], size, -0.5, centroid), size, attribs);
+export const rectFromCentroidWithMargin = (centroid, size, margin, attribs) => rectFromCentroid(centroid, size, attribs).offset(margin);
 /**
  * Returns the intersection rect of given inputs or `undefined` if they
  * are non-overlapping.