feat(geom): update API for various shape types

- add IClear impls for APC, Group, Path - add .add() methods for APC, Group, Polygon, Polyline - update Path.add() to accept multiple args
thi-ng · Aug 5, 2023 · 3a45c5f · 3a45c5f
1 parent fdea6ba
commit 3a45c5f
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 6 deletions.
diff --git a/packages/geom/src/api/apc.ts b/packages/geom/src/api/apc.ts
@@ -1,7 +1,8 @@
+import type { IClear } from "@thi.ng/api";
 import type { Attribs, PCLike } from "@thi.ng/geom-api";
 import type { Vec } from "@thi.ng/vectors";
 
-export abstract class APC implements PCLike {
+export abstract class APC implements IClear, PCLike {
 	constructor(public points: Vec[] = [], public attribs?: Attribs) {}
 
 	abstract get type(): number | string;
@@ -13,4 +14,8 @@ export abstract class APC implements PCLike {
 	*[Symbol.iterator]() {
 		yield* this.points;
 	}
+
+	clear() {
+		this.points.length = 0;
+	}
 }
diff --git a/packages/geom/src/api/group.ts b/packages/geom/src/api/group.ts
@@ -1,9 +1,13 @@
-import type { Fn } from "@thi.ng/api";
+import type { Fn, IClear } from "@thi.ng/api";
 import { equiv } from "@thi.ng/equiv";
 import type { Attribs, IHiccupShape } from "@thi.ng/geom-api";
 import { __copyAttribs } from "../internal/copy.js";
 
-export class Group implements IHiccupShape {
+/**
+ * Geometry/shape group container for other {@link IHiccupShape}s, incl. nested
+ * groups.
+ */
+export class Group implements IClear, IHiccupShape {
 	constructor(
 		public attribs?: Attribs,
 		public children: IHiccupShape[] = []
@@ -17,6 +21,23 @@ export class Group implements IHiccupShape {
 		yield* this.children;
 	}
 
+	/**
+	 * Appends given `shapes` to this {@link Group.children} array.
+	 *
+	 * @param shapes
+	 */
+	add(...shapes: IHiccupShape[]) {
+		this.children.push(...shapes);
+		return this;
+	}
+
+	/**
+	 * Removes all children from the group.
+	 */
+	clear() {
+		this.children.length = 0;
+	}
+
 	copy(): Group {
 		return this.copyTransformed((c) => <IHiccupShape>c.copy());
 	}

diff --git a/packages/geom/src/api/path.ts b/packages/geom/src/api/path.ts
@@ -1,10 +1,11 @@
+import type { IClear } from "@thi.ng/api";
 import { equiv } from "@thi.ng/equiv";
 import { illegalState } from "@thi.ng/errors/illegal-state";
 import type { Attribs, IHiccupShape, PathSegment } from "@thi.ng/geom-api";
 import { copy } from "@thi.ng/vectors/copy";
 import { __copyAttribs } from "../internal/copy.js";
 
-export class Path implements IHiccupShape {
+export class Path implements IClear, IHiccupShape {
 	closed = false;
 
 	constructor(
@@ -20,6 +21,10 @@ export class Path implements IHiccupShape {
 		yield* this.segments;
 	}
 
+	clear() {
+		this.segments.length = 0;
+	}
+
 	copy(): Path {
 		const p = new Path(
 			this.segments.map((s) => {
@@ -44,9 +49,9 @@ export class Path implements IHiccupShape {
 		return o instanceof Path && equiv(this.segments, o.segments);
 	}
 
-	add(s: PathSegment) {
+	add(...segments: PathSegment[]) {
 		if (this.closed) illegalState("path already closed");
-		this.segments.push(s);
+		this.segments.push(...segments);
 	}
 
 	toHiccup() {

diff --git a/packages/geom/src/api/polygon.ts b/packages/geom/src/api/polygon.ts
@@ -1,4 +1,5 @@
 import type { Attribs, IHiccupShape } from "@thi.ng/geom-api";
+import type { Vec } from "@thi.ng/vectors";
 import { __copyShape } from "../internal/copy.js";
 import { APC } from "./apc.js";
 
@@ -7,6 +8,10 @@ export class Polygon extends APC implements IHiccupShape {
 		return "poly";
 	}
 
+	add(...points: Vec[]) {
+		this.points.push(...points);
+	}
+
 	copy(): Polygon {
 		return <Polygon>__copyShape(Polygon, this);
 	}

diff --git a/packages/geom/src/api/polyline.ts b/packages/geom/src/api/polyline.ts
@@ -3,6 +3,7 @@ import type {
 	IHiccupPathSegment,
 	IHiccupShape,
 } from "@thi.ng/geom-api";
+import type { Vec } from "@thi.ng/vectors";
 import { __copyShape } from "../internal/copy.js";
 import { APC } from "./apc.js";
 
@@ -11,6 +12,10 @@ export class Polyline extends APC implements IHiccupShape, IHiccupPathSegment {
 		return "polyline";
 	}
 
+	add(...points: Vec[]) {
+		this.points.push(...points);
+	}
+
 	copy(): Polyline {
 		return <Polyline>__copyShape(Polyline, this);
 	}