plotboilerplate 1.17.1 → 1.18.0

package/README.md

@@ -47,12 +47,18 @@ often use for the visualization of 2D geometries. Basic features are
   - text
     ([docs](https://plotboilerplate.io/docs_typedoc/classes/pbtext.html "PBText class"),
     [example](https://plotboilerplate.io/repo/demos/basic-PBText "PBText example"))
-- configuration of the canvas behavior (fullsize, interaction, raster)
-- mouse interaction (zoom, pan, drag elements)
-- keyboard interaction
-- touch interaction for dragging vertices (mobile devices: zoom, pan, drag elements)
-
-The compressed library has 128kb.
+- configuration of the canvas behavior
+  - fullsize and auto-resizing
+  - enable/disable mouse, touch or keyboard interaction
+  - draw rasters
+  - default colors and darkmode
+- mouse and touch interaction
+  - zoom
+  - pan
+  - drag and select elements
+- keyboard interaction customizable
+
+The compressed library has 133kb.
 
 ## Install the package via npm
 
@@ -143,6 +149,8 @@ globalThis.addEventListener("load", () => {
 });
 ```
 
+For a guide of how to [Getting Started click here](https://github.com/IkarosKappler/plotboilerplate/blob/master/Getting-Started.md "Getting Started click here.").
+
 A full working demo repository about the [Usage with Typescript is here](https://github.com/IkarosKappler/plotboilerplate-typescript-example "usage with Typescript is here").
 
 ### Screenshot
@@ -442,6 +450,55 @@ vert.listeners.addDragListener(function (e) {
 - Touch & move (2 fingers): Pan the area
 - Touch & pinch: Zoom in/out
 
+## Custom keyboard events
+
+```javascript
+new KeyHandler({ trackAll: true })
+  .down("enter", function () {
+    console.log("ENTER was hit.");
+  })
+  .press("enter", function () {
+    console.log("ENTER was pressed.");
+  })
+  .up("enter", function () {
+    console.log("ENTER was released.");
+  })
+  .down("e", function () {
+    console.log("e was hit. shift is pressed?", keyHandler.isDown("shift"));
+  })
+  .up("spacebar", function () {
+    console.log("spacebar was released.");
+  });
+```
+
+For a list of all supported key codes see [Full list of supported key codes](https://github.com/IkarosKappler/plotboilerplate/blob/master/keycodes.md "Full list of supported key codes").
+
+## Custom mouse event
+
+```javascript
+new MouseHandler(document.getElementById("mycanvas"))
+  .drag(function (e) {
+    console.log("Mouse dragged: " + JSON.stringify(e));
+    if (e.params.leftMouse);
+    else if (e.params.rightMouse);
+  })
+  .move(function (e) {
+    console.log("Mouse moved: " + JSON.stringify(e.params));
+  })
+  .up(function (e) {
+    console.log("Mouse up. Was dragged?", e.params.wasDragged);
+  })
+  .down(function (e) {
+    console.log("Mouse down.");
+  })
+  .click(function (e) {
+    console.log("Click.");
+  })
+  .wheel(function (e) {
+    console.log("Wheel. delta=" + e.deltaY);
+  });
+```
+
 ## Build the package
 
 [Compile and build howto](https://github.com/IkarosKappler/plotboilerplate/blob/master/build.md "Compile and build howto")

package/changelog.md

@@ -1,8 +1,17 @@
 # Changelog
 
-<!-- - 2022-06-21 (Midsommer)
-  - Added `Bounds.clone()`. -->
-
+- 2022-09-11
+  - Added the extended circle-line-intersection demo (because I am stupid and need visual confirmation).
+- 2022-08-23
+  - Added the `Circle.lineIntersection(Vertex,Vertex)` function.
+  - Added the `Circle.closestPoint(XYCoords)` function.
+  - Fixed a type issue in the `draw.polyline` function.
+  - Fixed a type issue in the `draw.setConfiguration` function.
+  - Fixed a type issue in the `draw.path` function.
+- 2022-08-16
+  - MouseHandler: Fixed a bug in the mouse button detection.
+- 2022-08-15
+  - Added the `Circle.containsPoint(XYCoords)` function.
 - 2022-08-01
   - Added `title` param to the `PBParams` interface.
 - 2022-07-26

package/dist/index.esm.js

@@ -3945,7 +3945,10 @@ class Line extends VertTuple {
  * @modified 2021-01-20 Added UID.
  * @modified 2022-02-02 Added the `destroy` method.
  * @modified 2022-02-02 Cleared the `toSVGString` function (deprecated). Use `drawutilssvg` instead.
- * @version  1.3.0
+ * @modified 2022-08-15 Added the `containsPoint` function.
+ * @modified 2022-08-23 Added the `lineIntersection` function.
+ * @modified 2022-08-23 Added the `closestPoint` function.
+ * @version  1.4.0
  **/
 /**
  * @classdesc A simple circle: center point and radius.
@@ -3976,6 +3979,18 @@ class Circle {
         this.center = center;
         this.radius = radius;
     }
+    /**
+     * Check if the given circle is fully contained inside this circle.
+     *
+     * @method containsPoint
+     * @param {XYCoords} point - The point to check if it is contained in this circle.
+     * @instance
+     * @memberof Circle
+     * @return {boolean} `true` if the given point is inside this circle.
+     */
+    containsPoint(point) {
+        return this.center.distance(point) < this.radius;
+    }
     /**
      * Check if the given circle is fully contained inside this circle.
      *
@@ -4087,6 +4102,71 @@ class Circle {
         var y4 = p2.y + (h * (p1.x - p0.x)) / d;
         return new Line(new Vertex(x3, y3), new Vertex(x4, y4));
     }
+    /**
+     * Calculate the intersection points (if exists) with the given infinite line (defined by two points).
+     *
+     * @method lineIntersection
+     * @instance
+     * @memberof Circle
+     * @param {Vertex} a- The first of the two points defining the line.
+     * @param {Vertex} b - The second of the two points defining the line.
+     * @return {Line|null} The intersection points (as a line) or null if this circle does not intersect the line given.
+     **/
+    lineIntersection(a, b) {
+        // Based on the math from
+        //    https://mathworld.wolfram.com/Circle-LineIntersection.html
+        const interA = new Vertex();
+        const interB = new Vertex();
+        // First do a transformation, because the calculation is based on a cicle at (0,0)
+        const transA = new Vertex(a).sub(this.center);
+        const transB = new Vertex(b).sub(this.center);
+        const diff = transA.difference(transB);
+        // There is a special case if diff.y=0, where the intersection is not calcuatable.
+        // Use an non-zero epsilon here to approximate this case.
+        // TODO for the future: find a better solution
+        if (Math.abs(diff.y) === 0) {
+            diff.y = 0.000001;
+        }
+        const dist = transA.distance(transB);
+        const det = transA.x * transB.y - transA.y * transB.x;
+        const distSquared = dist * dist;
+        const radiusSquared = this.radius * this.radius;
+        // Check if circle and line have an intersection at all
+        if (radiusSquared * distSquared - det * det < 0) {
+            return null;
+        }
+        const belowSqrt = this.radius * this.radius * dist * dist - det * det;
+        const sqrt = Math.sqrt(belowSqrt);
+        interA.x = (det * diff.y + Math.sign(diff.y) * diff.x * sqrt) / distSquared;
+        interB.x = (det * diff.y - Math.sign(diff.y) * diff.x * sqrt) / distSquared;
+        interA.y = (-det * diff.x + Math.abs(diff.y) * sqrt) / distSquared;
+        interB.y = (-det * diff.x - Math.abs(diff.y) * sqrt) / distSquared;
+        return new Line(interA.add(this.center), interB.add(this.center));
+        // return new Line(interA, interB);
+    }
+    /**
+     * Calculate the closest point on the outline of this circle to the given point.
+     *
+     * @method closestPoint
+     * @instance
+     * @memberof Circle
+     * @param {XYCoords} vert - The point to find the closest circle point for.
+     * @return {Vertex} The closest point on this circle.
+     **/
+    closestPoint(vert) {
+        const lineIntersection = this.lineIntersection(this.center, vert);
+        if (!lineIntersection) {
+            // Note: this case should not happen as a radial from the center always intersect this circle.
+            return new Vertex();
+        }
+        // Return closed of both
+        if (lineIntersection.a.distance(vert) < lineIntersection.b.distance(vert)) {
+            return lineIntersection.a;
+        }
+        else {
+            return lineIntersection.b;
+        }
+    }
     /**
      * This function should invalidate any installed listeners and invalidate this object.
      * After calling this function the object might not hold valid data any more and
@@ -5608,7 +5688,10 @@ drawutilssvg.HEAD_XML = [
  * @modified 2022-03-27 Added the `texturedPoly` function.
  * @modified 2022-06-01 Tweaked the `polyline` function; lineWidth now scales with scale.x.
  * @modified 2022-07-26 Adding `alpha` to the `image(...)` function.
- * @version  1.12.2
+ * @modified 2022-08-23 Fixed a type issue in the `polyline` function.
+ * @modified 2022-08-23 Fixed a type issue in the `setConfiguration` function.
+ * @modified 2022-08-23 Fixed a type issue in the `path` function.
+ * @version  1.12.3
  **/
 // Todo: rename this class to Drawutils?
 /**
@@ -5662,7 +5745,7 @@ class drawutils {
      * @param {DrawLibConfiguration} configuration - The new configuration settings to use for the next render methods.
      */
     setConfiguration(configuration) {
-        this.ctx.globalCompositeOperation = configuration.blendMode;
+        this.ctx.globalCompositeOperation = configuration.blendMode || "source-over";
     }
     /**
      * This method shouled be called each time the currently drawn `Drawable` changes.
@@ -6371,7 +6454,7 @@ class drawutils {
         }
         this.ctx.save();
         this.ctx.beginPath();
-        this.ctx.lineWidth = lineWidth * this.scale.x || 1.0;
+        this.ctx.lineWidth = (lineWidth || 1.0) * this.scale.x;
         this.ctx.moveTo(this.offset.x + vertices[0].x * this.scale.x, this.offset.y + vertices[0].y * this.scale.y);
         for (var i = 0; i < vertices.length; i++) {
             this.ctx.lineTo(this.offset.x + vertices[i].x * this.scale.x, this.offset.y + vertices[i].y * this.scale.y);
@@ -6488,14 +6571,20 @@ class drawutils {
     path(pathData, color, lineWidth, options) {
         const d = options && options.inplace ? pathData : drawutilssvg.copyPathData(pathData);
         drawutilssvg.transformPathData(d, this.offset, this.scale);
-        this.ctx.strokeStyle = color;
+        if (color) {
+            this.ctx.strokeStyle = color;
+        }
         this.ctx.lineWidth = lineWidth || 1;
         if (this.fillShapes) {
-            this.ctx.fillStyle = color;
+            if (color) {
+                this.ctx.fillStyle = color;
+            }
             this.ctx.fill(new Path2D(d.join(" ")));
         }
         else {
-            this.ctx.strokeStyle = color;
+            if (color) {
+                this.ctx.strokeStyle = color;
+            }
             this.ctx.stroke(new Path2D(d.join(" ")));
         }
     }
@@ -8280,7 +8369,8 @@ KeyHandler.KEY_CODES = {
  * @modified 2020-10-04 Added extended JSDoc comments.
  * @modified 2020-11-25 Added the `isTouchEvent` param.
  * @modified 2021-01-10 The mouse handler is now also working with SVGElements.
- * @version  1.2.0
+ * @modified 2022-08-16 Fixed a bug in the mouse button detection.
+ * @version  1.2.1
  *
  * @file MouseHandler
  * @public
@@ -8370,8 +8460,8 @@ class MouseHandler {
         // +-------------------------------------------------
         this.name = name;
         this.element = element;
-        this.mouseDownPos = null;
-        this.mouseDragPos = null;
+        this.mouseDownPos = undefined;
+        this.mouseDragPos = undefined;
         // this.mousePos     = null;
         this.mouseButton = -1;
         this.listeners = {};
@@ -8440,26 +8530,27 @@ class MouseHandler {
      * @memberof MouseHandler
      * @instance
      * @private
-     * @param {MouseEvent} e - The mouse event to get the relative position for.
+     * @param {MouseEvent} event - The mouse event to get the relative position for.
      * @param {string} eventName - The name of the firing event.
      * @return {XMouseEvent}
      */
-    mkParams(e, eventName) {
-        const rel = this.relPos(e);
-        const xEvent = e;
+    mkParams(event, eventName) {
+        var _a, _b;
+        const rel = this.relPos(event);
+        const xEvent = event;
         xEvent.params = {
             element: this.element,
             name: eventName,
             isTouchEvent: false,
             pos: rel,
-            button: this.mouseButton,
-            leftButton: this.mouseButton == 0,
-            middleButton: this.mouseButton == 1,
-            rightButton: this.mouseButton == 2,
-            mouseDownPos: this.mouseDownPos,
-            draggedFrom: this.mouseDragPos,
+            button: event.button,
+            leftButton: event.button === 0,
+            middleButton: event.button === 1,
+            rightButton: event.button === 2,
+            mouseDownPos: (_a = this.mouseDownPos) !== null && _a !== void 0 ? _a : { x: NaN, y: NaN },
+            draggedFrom: (_b = this.mouseDragPos) !== null && _b !== void 0 ? _b : { x: NaN, y: NaN },
             wasDragged: this.mouseDownPos != null && (this.mouseDownPos.x != rel.x || this.mouseDownPos.y != rel.y),
-            dragAmount: this.mouseDownPos != null ? { x: rel.x - this.mouseDragPos.x, y: rel.y - this.mouseDragPos.y } : { x: 0, y: 0 }
+            dragAmount: this.mouseDragPos != null ? { x: rel.x - this.mouseDragPos.x, y: rel.y - this.mouseDragPos.y } : { x: 0, y: 0 }
         };
         return xEvent;
     }