plotboilerplate 1.12.9 → 1.15.0

package/src/esm/utils/findInVertexArray.js

@@ -0,0 +1,25 @@
+/**
+ * @author  Ikaros Kappler
+ * @date    2022-01-10
+ * @version 1.0.0
+ */
+/**
+ * In an array of vertices find the first occurence of a specific vertex, using
+ * and epsilon tolerance.
+ *
+ * @param {Array<Vertex>} vertexList - The vertex array to search in.
+ * @param {XYCoords} vertex - A vertex/position to search for. This can be any x-y-tuple and does not
+ *                              necessarily need to be an instance of Vertex.
+ * @param {number} epsilon - The epsilon tolerance to use (should be >= 0). This is a required param to avoid excessive
+ *                              is-undef checking if this function runs in a loop.
+ * @returns {boolean} - The first index of a vertex that matched or -1 if no such vertex could be found.
+ */
+export const findInVertexArray = (vertexList, vertex, epsilon) => {
+    for (var i = 0; i < vertexList.length; i++) {
+        if (vertexList[i].distance(vertex) < epsilon) {
+            return i;
+        }
+    }
+    return -1;
+};
+//# sourceMappingURL=findInVertexArray.js.map

package/src/esm/utils/findInVertexArray.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findInVertexArray.js","sourceRoot":"","sources":["../../ts/utils/findInVertexArray.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,UAAyB,EAAE,MAAgB,EAAE,OAAe,EAAU,EAAE;IACxG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC1C,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,OAAO,EAAE;YAC5C,OAAO,CAAC,CAAC;SACV;KACF;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC,CAAC"}

package/src/ts/BezierPath.ts

@@ -529,6 +529,38 @@ export class BezierPath implements SVGSerializable {
     return this;
   }
 
+  /**
+   * Scale the whole bezier path by the given uniform factor.
+   *
+   * @method scale
+   * @param {Vertex} anchor - The scale origin to scale from.
+   * @param {number} scaleFactor - The scalar to be multiplied with.
+   * @instance
+   * @memberof BezierPath
+   * @return {BezierPath} this for chaining.
+   **/
+  scale(anchor: Vertex, scaleFactor: number): BezierPath {
+    // var scaleFactors : XYCoords = { x : scaleFactor, y : scaleFactor };
+    // for (var i = 0; i < this.bezierCurves.length; i++) {
+    //   var curve = this.bezierCurves[i];
+    //   curve.getStartPoint().scale(scaleFactor, anchor);
+    //   curve.getStartControlPoint().scale(scaleFactor, anchor);
+    //   curve.getEndControlPoint().scale(scaleFactor, anchor);
+    //   // Do NOT scale the end point here!
+    //   // Don't forget that the curves are connected and on curve's end point
+    //   // the the successor's start point (same instance)!
+    // }
+
+    // // Finally move the last end point (was not scaled yet)
+    // if (this.bezierCurves.length > 0 && !this.adjustCircular) {
+    //   this.bezierCurves[this.bezierCurves.length - 1].getEndPoint().scale(scaleFactor, anchor);
+    // }
+
+    // this.updateArcLengths();
+    // return this;
+    return this.scaleXY({ x: scaleFactor, y: scaleFactor }, anchor);
+  }
+
   /**
    * Scale the whole bezier path by the given (x,y)-factors.
    *
@@ -539,12 +571,12 @@ export class BezierPath implements SVGSerializable {
    * @memberof BezierPath
    * @return {BezierPath} this for chaining.
    **/
-  scale(anchor: Vertex, scaling: number): BezierPath {
+  scaleXY(scaleFactors: XYCoords, anchor?: XYCoords): BezierPath {
     for (var i = 0; i < this.bezierCurves.length; i++) {
       var curve = this.bezierCurves[i];
-      curve.getStartPoint().scale(scaling, anchor);
-      curve.getStartControlPoint().scale(scaling, anchor);
-      curve.getEndControlPoint().scale(scaling, anchor);
+      curve.getStartPoint().scaleXY(scaleFactors, anchor);
+      curve.getStartControlPoint().scaleXY(scaleFactors, anchor);
+      curve.getEndControlPoint().scaleXY(scaleFactors, anchor);
       // Do NOT scale the end point here!
       // Don't forget that the curves are connected and on curve's end point
       // the the successor's start point (same instance)!
@@ -552,7 +584,7 @@ export class BezierPath implements SVGSerializable {
 
     // Finally move the last end point (was not scaled yet)
     if (this.bezierCurves.length > 0 && !this.adjustCircular) {
-      this.bezierCurves[this.bezierCurves.length - 1].getEndPoint().scale(scaling, anchor);
+      this.bezierCurves[this.bezierCurves.length - 1].getEndPoint().scaleXY(scaleFactors, anchor);
     }
 
     this.updateArcLengths();

package/src/ts/PBText.ts

@@ -0,0 +1,147 @@
+/**
+ * @author   Ikaros Kappler
+ * @date     2021-11-16
+ * @version  1.0.0
+ **/
+
+import { UIDGenerator } from "./UIDGenerator";
+import { Vertex } from "./Vertex";
+import { FontOptions, FontStyle, FontWeight, SVGSerializable, UID } from "./interfaces";
+
+/**
+ * @classdesc A simple text element: position, fontSize, fontFamily, color, textAlign, lineHeight and rotation.
+ *
+ * @requires FontOptions
+ * @requires FontSize
+ * @requires FontStyle
+ * @requires FontWeight
+ * @requires Vertex
+ * @requires SVGSerializale
+ * @requires UID
+ * @requires UIDGenerator
+ **/
+export class PBText implements SVGSerializable, FontOptions {
+  /**
+   * Required to generate proper CSS classes and other class related IDs.
+   **/
+  readonly className: string = "PBText";
+
+  /**
+   * The UID of this drawable object.
+   *
+   * @member {UID}
+   * @memberof PBText
+   * @instance
+   * @readonly
+   */
+  readonly uid: UID;
+
+  /**
+   * @member {string}
+   * @memberof PBText
+   * @instance
+   */
+  text: string;
+
+  /**
+   * @member {Vertex}
+   * @memberof PBText
+   * @instance
+   */
+  anchor: Vertex;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  fontSize: number | undefined;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  lineHeight: number | undefined;
+
+  /**
+   * @member {FontWeight}
+   * @memberof PBText
+   * @instance
+   */
+  fontWeight: FontWeight | undefined;
+
+  /**
+   * @member {FontStyle}
+   * @memberof PBText
+   * @instance
+   */
+  fontStyle: FontStyle | undefined;
+
+  /**
+   * @member {CanvasRenderingContext2D["textAlign"]}
+   * @memberof PBText
+   * @instance
+   */
+  textAlign: CanvasRenderingContext2D["textAlign"] | undefined;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  rotation: number | undefined;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  fontFamily: string | undefined;
+
+  /**
+   * @member {number}
+   * @memberof PBText
+   * @instance
+   */
+  color: string | undefined;
+
+  /**
+   * Create a new circle with given center point and radius.
+   *
+   * @constructor
+   * @name Circle
+   * @param {Vertex} center - The center point of the circle.
+   * @param {number} radius - The radius of the circle.
+   */
+  constructor(text: string, anchor?: Vertex, options?: FontOptions) {
+    this.uid = UIDGenerator.next();
+    this.text = text;
+    this.anchor = anchor ?? new Vertex();
+    this.color = options.color;
+    this.fontFamily = options.fontFamily;
+    this.fontSize = options.fontSize;
+    this.fontStyle = options.fontStyle;
+    this.fontWeight = options.fontWeight;
+    this.lineHeight = options.lineHeight;
+    this.textAlign = options.textAlign;
+    this.rotation = options.rotation;
+  }
+
+  /**
+   * Create an SVG representation of this circle.
+   *
+   * @deprecated DEPRECATION Please use the drawutilssvg library and an XMLSerializer instead.
+   * @method toSVGString
+   * @param {object=} options - An optional set of options, like 'className'.
+   * @return {string} A string representing the SVG code for this vertex.
+   * @instance
+   * @memberof Circle
+   */
+  toSVGString(options: { className?: string }) {
+    console.warn(
+      "[PBText.toSVGString()] This function is not implemented as it defines a deprecated method. Use the 'drawutilssvg.text()' method instead."
+    );
+    return "";
+  }
+} // END class

package/src/ts/PlotBoilerplate.ts

@@ -73,7 +73,8 @@
  * @modified 2021-03-03 Added the `VEllipseSector` drawable.
  * @modified 2021-03-29 Clearing `currentClassName` and `currentId` after drawing each drawable.
  * @modified 2021-04-25 Extending `remove` to accept arrays of drawables.
- * @version  1.14.0
+ * @modified 2021-11-16 Adding the `PBText` drawable.
+ * @version  1.15.0
  *
  * @file PlotBoilerplate
  * @fileoverview The main class.
@@ -118,6 +119,8 @@ import {
   XYDimension,
   DatGuiProps
 } from "./interfaces";
+import { PBText } from "./PBText";
+import { AlloyFingerOptions } from "alloyfinger-typescript/src/cjs/alloy_finger";
 
 /**
  * @classdesc The main class of the PlotBoilerplate.
@@ -521,6 +524,12 @@ export class PlotBoilerplate {
       image: {
         color: "#a8a8a8",
         lineWidth: 1
+      },
+      text: {
+        color: "rgba(192,0,128,0.5)",
+        lineWidth: 1,
+        fill: true,
+        anchor: true
       }
     }; // END drawConfig
 
@@ -656,7 +665,7 @@ export class PlotBoilerplate {
     var blob = new Blob([svgCode], { type: "image/svg;charset=utf-8" });
     // See documentation for FileSaver.js for usage.
     //    https://github.com/eligrey/FileSaver.js
-    if (typeof globalThis["saveAs"] != "function")
+    if (typeof globalThis["saveAs"] !== "function")
       throw "Cannot save file; did you load the ./utils/savefile helper function and the eligrey/SaveFile library?";
     var _saveAs = globalThis["saveAs"];
     _saveAs(blob, "plotboilerplate.svg");
@@ -768,7 +777,6 @@ export class PlotBoilerplate {
   add(drawable: Drawable | Array<Drawable>, redraw?: boolean) {
     if (Array.isArray(drawable)) {
       const arr: Array<Drawable> = drawable as Array<Drawable>;
-      // for( var i in arr )
       for (var i = 0; i < arr.length; i++) {
         this.add(arr[i], false);
       }
@@ -806,8 +814,9 @@ export class PlotBoilerplate {
       this.drawables.push(drawable);
     } else if (drawable instanceof Polygon) {
       this.drawables.push(drawable);
-      // for( var i in drawable.vertices )
-      for (var i = 0; i < drawable.vertices.length; i++) this.vertices.push(drawable.vertices[i]);
+      for (var i = 0; i < drawable.vertices.length; i++) {
+        this.vertices.push(drawable.vertices[i]);
+      }
     } else if (drawable instanceof Triangle) {
       this.drawables.push(drawable);
       this.vertices.push(drawable.a);
@@ -817,7 +826,9 @@ export class PlotBoilerplate {
       this.drawables.push(drawable);
       const bezierPath: BezierPath = drawable as BezierPath;
       for (var i = 0; i < bezierPath.bezierCurves.length; i++) {
-        if (!drawable.adjustCircular && i == 0) this.vertices.push(bezierPath.bezierCurves[i].startPoint);
+        if (!drawable.adjustCircular && i == 0) {
+          this.vertices.push(bezierPath.bezierCurves[i].startPoint);
+        }
         this.vertices.push(bezierPath.bezierCurves[i].endPoint);
         this.vertices.push(bezierPath.bezierCurves[i].startControlPoint);
         this.vertices.push(bezierPath.bezierCurves[i].endControlPoint);
@@ -834,6 +845,10 @@ export class PlotBoilerplate {
         drawable.lowerRight.add(e.params.dragAmount);
       });
       drawable.lowerRight.attr.selectable = false;
+    } else if (drawable instanceof PBText) {
+      this.vertices.push(drawable.anchor);
+      this.drawables.push(drawable);
+      drawable.anchor.attr.selectable = false;
     } else {
       throw "Cannot add drawable of unrecognized type: " + typeof drawable + ".";
     }
@@ -923,6 +938,8 @@ export class PlotBoilerplate {
           } else if (drawable instanceof PBImage) {
             this.removeVertex(drawable.upperLeft, false);
             this.removeVertex(drawable.lowerRight, false);
+          } else if (drawable instanceof PBText) {
+            this.removeVertex(drawable.anchor, false);
           }
         } // END removeWithVertices
 
@@ -947,7 +964,9 @@ export class PlotBoilerplate {
     for (var i = 0; i < this.vertices.length; i++) {
       if (this.vertices[i] === vert) {
         this.vertices.splice(i, 1);
-        if (redraw) this.redraw();
+        if (redraw) {
+          this.redraw();
+        }
         return;
       }
     }
@@ -987,7 +1006,9 @@ export class PlotBoilerplate {
       this.transformMousePosition(pixelPosition.x, pixelPosition.y),
       pixelTolerance / Math.min(this.config.cssScaleX, this.config.cssScaleY)
     );
-    if (p && p.typeName == "vertex") return this.vertices[p.vindex];
+    if (p && p.typeName == "vertex") {
+      return this.vertices[p.vindex];
+    }
     return undefined;
   }
 
@@ -1320,6 +1341,15 @@ export class PlotBoilerplate {
         draw.circleHandle(d.lowerRight, 3, this.drawConfig.image.color);
         d.lowerRight.attr.renderTime = renderTime;
       }
+    } else if (d instanceof PBText) {
+      fill.setCurrentId(d.uid);
+      fill.text(d.text, d.anchor.x, d.anchor.y, d);
+      if (this.drawConfig.text.anchor) {
+        draw.setCurrentId(`${d.uid}_a0`);
+        draw.setCurrentClassName(`${d.className}-anchor`);
+        (this.drawConfig.text.fill ? fill : draw).point(d.anchor, this.drawConfig.text.color);
+      }
+      d.anchor.attr.renderTime = renderTime;
     } else {
       console.error("Cannot draw object. Unknown class.");
     }
@@ -1617,7 +1647,6 @@ export class PlotBoilerplate {
     // Apply the zoom (the tolerant area should not shrink or grow when zooming)
     tolerance /= _self.draw.scale.x;
     // Search in vertices
-    // for( var vindex in _self.vertices ) {
     for (var vindex = 0; vindex < _self.vertices.length; vindex++) {
       var vert: Vertex = _self.vertices[vindex];
       if ((vert.attr.draggable || vert.attr.selectable) && vert.distance(point) < tolerance) {
@@ -1638,10 +1667,7 @@ export class PlotBoilerplate {
    * @return {void}
    **/
   private handleClick(e: XMouseEvent) {
-    // x:number,y:number) {
     const _self: PlotBoilerplate = this;
-    // const x:number = e.params.pos.x;
-    //const y:number = e.params.pos.y;
     var p: IDraggable = this.locatePointNear(
       _self.transformMousePosition(e.params.pos.x, e.params.pos.y),
       PlotBoilerplate.DEFAULT_CLICK_TOLERANCE / Math.min(_self.config.cssScaleX, _self.config.cssScaleY)
@@ -1657,9 +1683,7 @@ export class PlotBoilerplate {
           if (vert.attr.selectable) vert.attr.isSelected = !vert.attr.isSelected;
         }
         _self.redraw();
-      } else if (
-        this.keyHandler.isDown("y") /* && p.type=='bpath' && (p.pid==BezierPath.START_POINT || p.pid==BezierPath.END_POINT) */
-      ) {
+      } else if (this.keyHandler.isDown("y")) {
         _self.vertices[p.vindex].attr.bezierAutoAdjust = !_self.vertices[p.vindex].attr.bezierAutoAdjust;
         _self.redraw();
       }
@@ -1961,7 +1985,8 @@ export class PlotBoilerplate {
             multiTouchStartScale = null;
             _self.draggedElements = [];
           };
-          const afProps = {
+          const afProps: AlloyFingerOptions = {
+            // touchStart: (evt: TouchEvent) => {
             touchStart: (evt: TouchEvent) => {
               if (evt.touches.length == 1) {
                 touchMovePos = new Vertex(relPos({ x: evt.touches[0].clientX, y: evt.touches[0].clientY }));
@@ -2065,10 +2090,13 @@ export class PlotBoilerplate {
               _self.setZoom(multiTouchStartScale.x * evt.zoom, multiTouchStartScale.y * evt.zoom, center);
               _self.redraw();
             }
-          }; // END afProps
-          if (window["createAlloyFinger"])
+          } as unknown as AlloyFingerOptions; // END afProps
+          if (window["createAlloyFinger"]) {
             window["createAlloyFinger"](this.eventCatcher ? this.eventCatcher : this.canvas, afProps);
-          else new AlloyFinger(this.eventCatcher ? this.eventCatcher : this.canvas, afProps);
+          } else {
+            /* tslint:disable-next-line */
+            new AlloyFinger(this.eventCatcher ? this.eventCatcher : this.canvas, afProps);
+          }
         } catch (e) {
           console.error("Failed to initialize AlloyFinger!");
           console.error(e);