plotboilerplate 1.24.0 → 1.25.0

package/src/ts/Vertex.ts

@@ -35,7 +35,8 @@
  * @modified 2024-12-17 Outsourced the euclidean distance calculation of `Vertex.distance` to `geomutils.dist4`.
  * @modified 2025-03-24 Making the second parameter `center` of the `Vertex.rotate` method optional.
  * @modified 2025-04-13 Adding the `Vertex.move(amount: XYCoords)` method (does the same as `add`, added by naming convention).
- * @version  2.10.0
+ * @modified 2025-05-07 Class `Vertex` is now implementing interface `IBounded` (to meet convention).
+ * @version  2.11.0
  *
  * @file Vertex
  * @public
@@ -44,8 +45,9 @@
 import { IVertexAttr, VertexAttr } from "./VertexAttr";
 import { UIDGenerator } from "./UIDGenerator";
 import { VertexListeners } from "./VertexListeners";
-import { XYCoords, SVGSerializable, UID } from "./interfaces";
+import { XYCoords, SVGSerializable, UID, IBounded } from "./interfaces";
 import { geomutils } from "./geomutils";
+import { Bounds } from "./Bounds";
 
 /**
  * @classdesc A vertex is a pair of two numbers.<br>
@@ -61,7 +63,7 @@ import { geomutils } from "./geomutils";
  * @requires XYCoords
  *
  */
-export class Vertex implements XYCoords, SVGSerializable {
+export class Vertex implements IBounded, XYCoords, SVGSerializable {
   private static readonly ZERO = new Vertex(0, 0);
 
   /**
@@ -645,6 +647,22 @@ export class Vertex implements XYCoords, SVGSerializable {
     return this;
   }
 
+  //--- BEGIN --- Implement interface `IBounded`
+  /**
+   * Get the bounding box (bounds) of this Vertex.
+   * This is just by convention – any vertex is just a position without any useful with or height (0).
+   *
+   * @method getBounds
+   * @instance
+   * @memberof Vertex
+   * @return {Bounds} The rectangular bounds of this Vertex (width and height are zero).
+   **/
+  getBounds(): Bounds {
+    // return Bounds.computeFromVertices([this.a, this.b, this.c]);
+    return Bounds.computeFromVertices([this]);
+  }
+  //--- END --- Implement interface `IBounded`
+
   /**
    * Get a string representation of this vertex.
    *

package/src/ts/interfaces/core.ts

@@ -22,6 +22,8 @@
  * @modified 2024-08-25 Added the `CSSBackdropFilterParams` params to the global params (all optional).
  * @modified 2025-03-29 Added interface `Intersectable`.
  * @modified 2025-04-16 Added interface `IBounded`.
+ * @modified 2025-05-07 Added callback `onContentChanged` to PB to track if the drawable content changed.
+ * @modified 2025-06-07 Adding helper type `PolygonIntersectionTuple` for re-usability.
  **/
 
 import { Vertex } from "../Vertex";
@@ -114,6 +116,18 @@ export interface CanvasWrapper {
   setSize: (width: number, height: number) => void;
   element: HTMLCanvasElement | SVGElement;
 }
+
+/**
+ * The interface for PB change events.
+ */
+export interface IPBChangeEvent {
+  type: "DRAWABLES_ADDED" | "DRAWABLES_REMOVED";
+  addedDrawables: Array<Drawable>;
+  removedDrawables: Array<Drawable>;
+}
+
+export type PBContentChangeListener = (event: IPBChangeEvent) => void; // A callback function that will be triggered after content changed.
+
 /**
  * The config that's used by PB.
  */
@@ -303,3 +317,20 @@ export interface IBounded {
    **/
   getBounds(): IBounds;
 }
+
+export interface IShapeInteractionHelper {
+  /**
+   * Let this shape helper draw it's handle lines. It's up to the helper what they look like.
+   * @param {DrawLib<any>} draw - The draw library to use.
+   * @param {DrawLib<any>} fill - The fill library to use.
+   */
+  drawHandleLines(draw: DrawLib<any>, fill: DrawLib<any>): void;
+
+  /**
+   * Destroys this helper. This means that all listeners get released and this helper
+   * will not receive or handle any events.
+   */
+  destroy(): void;
+}
+
+export type PolygonIntersectionTuple<T> = { edgeIndex: number; intersection: T };