@thi.ng/geom 5.0.7 → 5.1.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-08-04T10:58:19Z
+- **Last updated**: 2023-08-06T09:21:31Z
 - **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.
 
+## [5.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom@5.1.0) (2023-08-06)
+
+#### 🚀 Features
+
+- update API for various shape types ([3a45c5f](https://github.com/thi-ng/umbrella/commit/3a45c5f))
+  - add IClear impls for APC, Group, Path
+  - add .add() methods for APC, Group, Polygon, Polyline
+  - update Path.add() to accept multiple args
+
 # [5.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom@5.0.0) (2023-04-08)
 
 #### 🛑 Breaking changes

package/api/apc.d.ts

@@ -1,6 +1,7 @@
+import type { IClear } from "@thi.ng/api";
 import type { Attribs, PCLike } from "@thi.ng/geom-api";
 import type { Vec } from "@thi.ng/vectors";
-export declare abstract class APC implements PCLike {
+export declare abstract class APC implements IClear, PCLike {
     points: Vec[];
     attribs?: Attribs | undefined;
     constructor(points?: Vec[], attribs?: Attribs | undefined);
@@ -8,5 +9,6 @@ export declare abstract class APC implements PCLike {
     abstract copy(): APC;
     abstract withAttribs(attribs: Attribs): APC;
     [Symbol.iterator](): Generator<Vec, void, undefined>;
+    clear(): void;
 }
 //# sourceMappingURL=apc.d.ts.map

package/api/apc.js

@@ -6,4 +6,7 @@ export class APC {
     *[Symbol.iterator]() {
         yield* this.points;
     }
+    clear() {
+        this.points.length = 0;
+    }
 }

package/api/group.d.ts

@@ -1,11 +1,25 @@
-import type { Fn } from "@thi.ng/api";
+import type { Fn, IClear } from "@thi.ng/api";
 import type { Attribs, IHiccupShape } from "@thi.ng/geom-api";
-export declare class Group implements IHiccupShape {
+/**
+ * Geometry/shape group container for other {@link IHiccupShape}s, incl. nested
+ * groups.
+ */
+export declare class Group implements IClear, IHiccupShape {
     attribs?: Attribs | undefined;
     children: IHiccupShape[];
     constructor(attribs?: Attribs | undefined, children?: IHiccupShape[]);
     get type(): string;
     [Symbol.iterator](): Generator<IHiccupShape, void, undefined>;
+    /**
+     * Appends given `shapes` to this {@link Group.children} array.
+     *
+     * @param shapes
+     */
+    add(...shapes: IHiccupShape[]): this;
+    /**
+     * Removes all children from the group.
+     */
+    clear(): void;
     copy(): Group;
     copyTransformed(fn: Fn<IHiccupShape, IHiccupShape>): Group;
     withAttribs(attribs: Attribs): Group;

package/api/group.js

@@ -1,5 +1,9 @@
 import { equiv } from "@thi.ng/equiv";
 import { __copyAttribs } from "../internal/copy.js";
+/**
+ * Geometry/shape group container for other {@link IHiccupShape}s, incl. nested
+ * groups.
+ */
 export class Group {
     constructor(attribs, children = []) {
         this.attribs = attribs;
@@ -11,6 +15,21 @@ export class Group {
     *[Symbol.iterator]() {
         yield* this.children;
     }
+    /**
+     * Appends given `shapes` to this {@link Group.children} array.
+     *
+     * @param shapes
+     */
+    add(...shapes) {
+        this.children.push(...shapes);
+        return this;
+    }
+    /**
+     * Removes all children from the group.
+     */
+    clear() {
+        this.children.length = 0;
+    }
     copy() {
         return this.copyTransformed((c) => c.copy());
     }

package/api/path.d.ts

@@ -1,15 +1,17 @@
+import type { IClear } from "@thi.ng/api";
 import type { Attribs, IHiccupShape, PathSegment } from "@thi.ng/geom-api";
-export declare class Path implements IHiccupShape {
+export declare class Path implements IClear, IHiccupShape {
     segments: PathSegment[];
     attribs?: Attribs | undefined;
     closed: boolean;
     constructor(segments?: PathSegment[], attribs?: Attribs | undefined);
     get type(): string;
     [Symbol.iterator](): Generator<PathSegment, void, undefined>;
+    clear(): void;
     copy(): Path;
     withAttribs(attribs: Attribs): Path;
     equiv(o: any): boolean;
-    add(s: PathSegment): void;
+    add(...segments: PathSegment[]): void;
     toHiccup(): (string | any[] | Attribs)[];
 }
 //# sourceMappingURL=path.d.ts.map

package/api/path.js

@@ -14,6 +14,9 @@ export class Path {
     *[Symbol.iterator]() {
         yield* this.segments;
     }
+    clear() {
+        this.segments.length = 0;
+    }
     copy() {
         const p = new Path(this.segments.map((s) => {
             const d = { type: s.type };
@@ -32,10 +35,10 @@ export class Path {
     equiv(o) {
         return o instanceof Path && equiv(this.segments, o.segments);
     }
-    add(s) {
+    add(...segments) {
         if (this.closed)
             illegalState("path already closed");
-        this.segments.push(s);
+        this.segments.push(...segments);
     }
     toHiccup() {
         let dest = [];

package/api/polygon.d.ts

@@ -1,9 +1,11 @@
 import type { Attribs, IHiccupShape } from "@thi.ng/geom-api";
+import type { Vec } from "@thi.ng/vectors";
 import { APC } from "./apc.js";
 export declare class Polygon extends APC implements IHiccupShape {
     get type(): string;
+    add(...points: Vec[]): void;
     copy(): Polygon;
     withAttribs(attribs: Attribs): Polygon;
-    toHiccup(): (string | import("@thi.ng/vectors").Vec[] | Attribs | undefined)[];
+    toHiccup(): (string | Vec[] | Attribs | undefined)[];
 }
 //# sourceMappingURL=polygon.d.ts.map

package/api/polygon.js

@@ -4,6 +4,9 @@ export class Polygon extends APC {
     get type() {
         return "poly";
     }
+    add(...points) {
+        this.points.push(...points);
+    }
     copy() {
         return __copyShape(Polygon, this);
     }

package/api/polyline.d.ts

@@ -1,10 +1,12 @@
 import type { Attribs, IHiccupPathSegment, IHiccupShape } from "@thi.ng/geom-api";
+import type { Vec } from "@thi.ng/vectors";
 import { APC } from "./apc.js";
 export declare class Polyline extends APC implements IHiccupShape, IHiccupPathSegment {
     get type(): string;
+    add(...points: Vec[]): void;
     copy(): Polyline;
     withAttribs(attribs: Attribs): Polyline;
-    toHiccup(): (string | import("@thi.ng/vectors").Vec[] | {
+    toHiccup(): (string | Vec[] | {
         fill: string;
     })[];
     toHiccupPathSegments(): any[];

package/api/polyline.js

@@ -4,6 +4,9 @@ export class Polyline extends APC {
     get type() {
         return "polyline";
     }
+    add(...points) {
+        this.points.push(...points);
+    }
     copy() {
         return __copyShape(Polyline, this);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/geom",
-  "version": "5.0.7",
+  "version": "5.1.0",
   "description": "Functional, polymorphic API for 2D geometry types & SVG generation",
   "type": "module",
   "module": "./index.js",
@@ -398,5 +398,5 @@
     ],
     "year": 2013
   },
-  "gitHead": "9fa3f7f8169efa30e3c71b43c82f77393581c3b5\n"
+  "gitHead": "888293c74f2e9a481d500d4ec319f1e2bd765ec6\n"
 }