plotboilerplate 1.20.2 → 1.22.0

package/src/esm/utils/datastructures/DataGrid2d.js

@@ -0,0 +1,19 @@
+/**
+ * A 2D datagrid interface for getting/storing data in some 2 dimensional array style types.
+ *
+ *  _|---- xIndex --->
+ *  |       d[0][0], d[1][0], d[2][0], ..., d[xSegmentCount-1][0]
+ *  yIndex
+ *  |       d[0][1], d[1][1], d[2][1], ..., d[xSegmentCount-1][1]
+ *  |
+ *  v       ...
+ *
+ *          d[0][ySegmentCount-1], ..., ..., d[xSegmentCount-1][ySegmentCount-1]
+ *
+ *
+ * @date    2023-11-04
+ * @author  Ikaros Kappler
+ * @version 1.0.0
+ */
+export {};
+//# sourceMappingURL=DataGrid2d.js.map

package/src/esm/utils/datastructures/DataGrid2d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataGrid2d.js","sourceRoot":"","sources":["../../../ts/utils/datastructures/DataGrid2d.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG"}

package/src/esm/utils/datastructures/DataGrid2dListAdapter.d.ts

@@ -0,0 +1,65 @@
+/**
+ * A DataGrid2d implementation on a linear array of triplets/Vector3.
+ *
+ * @author   Ikaros Kappler
+ * @date     2023-10-28
+ * @modified 2023-11-04 Converted to a Typescript class.
+ * @version  1.0.0
+ **/
+import { DataGridFace4, IDataGrid2d } from "./DataGrid2d";
+declare type Triplet<T> = {
+    x: T;
+    y: T;
+    z: T;
+};
+declare type RasterPosition = {
+    xIndex: number;
+    yIndex: number;
+    xRel?: number;
+    yRel?: number;
+};
+export declare class DataGrid2dListAdapter<T> implements IDataGrid2d<T> {
+    /**
+     * @override
+     */
+    readonly xSegmentCount: number;
+    /**
+     * @override
+     */
+    readonly ySegmentCount: number;
+    minDataValue: T;
+    maxDataValue: T;
+    minXValue: T;
+    maxXValue: T;
+    minYValue: T;
+    maxYValue: T;
+    private _dataList;
+    /**
+     * Create a new DataGrid2d from the given
+     * @throws Error if xSegmentCount*ySegmentCount is larger than the capacity of the array/list.
+     * @param list
+     * @param xSegmentCount
+     * @param ySegmentCount
+     */
+    constructor(list: Array<Triplet<T>>, xSegmentCount: number, ySegmentCount: number);
+    getIndicesFromBufferIndex(bufferIndex: number): RasterPosition;
+    getCoordsFromBufferIndex(bufferIndex: number): RasterPosition;
+    coordinateIndicesToBufferIndex(xIndex: number, yIndex: number): number;
+    /**
+     * @override
+     */
+    getMinDataValue(): T;
+    /**
+     * @override
+     */
+    getMaxDataValue(): T;
+    /**
+     * @override
+     */
+    getDataValueAt(xIndex: number, yIndex: number, isDebug?: boolean): T | null;
+    /**
+     * @override
+     */
+    getDataFace4At(xIndex: number, yIndex: number, buffer: DataGridFace4<T>): void;
+}
+export {};

package/src/esm/utils/datastructures/DataGrid2dListAdapter.js

@@ -0,0 +1,79 @@
+/**
+ * A DataGrid2d implementation on a linear array of triplets/Vector3.
+ *
+ * @author   Ikaros Kappler
+ * @date     2023-10-28
+ * @modified 2023-11-04 Converted to a Typescript class.
+ * @version  1.0.0
+ **/
+export class DataGrid2dListAdapter {
+    /**
+     * Create a new DataGrid2d from the given
+     * @throws Error if xSegmentCount*ySegmentCount is larger than the capacity of the array/list.
+     * @param list
+     * @param xSegmentCount
+     * @param ySegmentCount
+     */
+    constructor(list, xSegmentCount, ySegmentCount) {
+        if (xSegmentCount * ySegmentCount > list.length) {
+            throw `Cannot create DataGrid2dListAdapter, the list (length ${list.length}) does not provide enough items for ${xSegmentCount}x${ySegmentCount} required entries.`;
+        }
+        // this.canvas = document.getElementById(canvasId);
+        this.xSegmentCount = xSegmentCount;
+        this.ySegmentCount = ySegmentCount;
+        this._dataList = list;
+    }
+    getIndicesFromBufferIndex(bufferIndex) {
+        return { xIndex: Math.floor(bufferIndex % this.xSegmentCount), yIndex: Math.floor(bufferIndex / this.xSegmentCount) };
+    }
+    getCoordsFromBufferIndex(bufferIndex) {
+        var index = this.getIndicesFromBufferIndex(bufferIndex);
+        // Note that the xSegmentCount and ySegmentCount counts plane squares, each consisting of four vertices
+        index.xRel = index.xIndex / (this.xSegmentCount - 1);
+        index.yRel = index.yIndex / (this.ySegmentCount - 1);
+        return index;
+    }
+    coordinateIndicesToBufferIndex(xIndex, yIndex) {
+        return yIndex * this.xSegmentCount + xIndex;
+    }
+    /**
+     * @override
+     */
+    getMinDataValue() {
+        return this.minDataValue;
+    }
+    /**
+     * @override
+     */
+    getMaxDataValue() {
+        return this.maxDataValue;
+    }
+    /**
+     * @override
+     */
+    getDataValueAt(xIndex, yIndex, isDebug) {
+        // var bufferIndex = yIndex * this.xSegmentCount + xIndex;
+        var bufferIndex = this.coordinateIndicesToBufferIndex(xIndex, yIndex);
+        if (isDebug) {
+            console.log("xIndex", xIndex, "yIndex", yIndex, "bufferIndex", bufferIndex);
+        }
+        if (bufferIndex > this._dataList.length) {
+            console.error("ERR buffer index is out of bounds! xIndex", xIndex, "yIndex", yIndex, "bufferIndex", bufferIndex);
+        }
+        if (!this._dataList[bufferIndex]) {
+            console.error("ERR buffer element is null! xIndex", xIndex, "yIndex", yIndex, "bufferIndex", bufferIndex);
+        }
+        return this._dataList && bufferIndex < this._dataList.length ? this._dataList[bufferIndex].z : null;
+    }
+    /**
+     * @override
+     */
+    getDataFace4At(xIndex, yIndex, buffer) {
+        // buffer: array[2][2]
+        buffer[0][0] = this.getDataValueAt(xIndex, yIndex);
+        buffer[1][0] = this.getDataValueAt(xIndex + 1, yIndex);
+        buffer[1][1] = this.getDataValueAt(xIndex + 1, yIndex + 1);
+        buffer[0][1] = this.getDataValueAt(xIndex, yIndex + 1);
+    }
+}
+//# sourceMappingURL=DataGrid2dListAdapter.js.map

package/src/esm/utils/datastructures/DataGrid2dListAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataGrid2dListAdapter.js","sourceRoot":"","sources":["../../../ts/utils/datastructures/DataGrid2dListAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;IAOI;AAiBJ,MAAM,OAAO,qBAAqB;IAmBhC;;;;;;OAMG;IACH,YAAY,IAAuB,EAAE,aAAqB,EAAE,aAAqB;QAC/E,IAAI,aAAa,GAAG,aAAa,GAAG,IAAI,CAAC,MAAM,EAAE;YAC/C,MAAM,yDAAyD,IAAI,CAAC,MAAM,uCAAuC,aAAa,IAAI,aAAa,oBAAoB,CAAC;SACrK;QAED,mDAAmD;QACnD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAEnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAED,yBAAyB,CAAC,WAAmB;QAC3C,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;IACxH,CAAC;IAED,wBAAwB,CAAC,WAAmB;QAC1C,IAAI,KAAK,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;QACxD,uGAAuG;QACvG,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;QACrD,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B,CAAC,MAAc,EAAE,MAAc;QAC3D,OAAO,MAAM,GAAG,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,OAAiB;QAC9D,0DAA0D;QAC1D,IAAI,WAAW,GAAG,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtE,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;SAC7E;QACD,IAAI,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;YACvC,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;SAClH;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;YAChC,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;SAC3G;QACD,OAAO,IAAI,CAAC,SAAS,IAAI,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACtG,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,MAAc,EAAE,MAAc,EAAE,MAAwB;QACrE,sBAAsB;QACtB,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;QACvD,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;IACzD,CAAC;CACF"}

package/src/esm/utils/datastructures/GenericPath.d.ts

@@ -1,7 +1,8 @@
 /**
- * @author  Ikaros Kappler
- * @version 1.0.0
- * @date    2022-10-17
+ * @author   Ikaros Kappler
+ * @version  1.1.0
+ * @date     2022-10-17
+ * @modified 2023-11-27 Added the `GenericPath.getAllStartEndPoints()` function.
  */
 import { Path, PathSegment } from "../../interfaces/additionals";
 import { Vertex } from "../../Vertex";
@@ -72,4 +73,14 @@ export declare class GenericPath implements Path {
      * @return {Vertex} The end point of the ending point's tangent.
      */
     getEndTangent(): Vertex;
+    /**
+     * Get the sequence of all start/end points of this path.
+     * Assumption is: each path segment's end point is located on the next segment's start point
+     * to shape a full connected path.
+     *
+     * No arcs are considered here, just plain linear segments.
+     *
+     * @returns {Array<Vertex>}
+     */
+    getAllStartEndPoints(): Array<Vertex>;
 }

package/src/esm/utils/datastructures/GenericPath.js

@@ -1,7 +1,8 @@
 /**
- * @author  Ikaros Kappler
- * @version 1.0.0
- * @date    2022-10-17
+ * @author   Ikaros Kappler
+ * @version  1.1.0
+ * @date     2022-10-17
+ * @modified 2023-11-27 Added the `GenericPath.getAllStartEndPoints()` function.
  */
 export class GenericPath {
     constructor(startSegment) {
@@ -96,5 +97,21 @@ export class GenericPath {
     getEndTangent() {
         return this.segments[this.segments.length - 1].getEndTangent();
     }
+    /**
+     * Get the sequence of all start/end points of this path.
+     * Assumption is: each path segment's end point is located on the next segment's start point
+     * to shape a full connected path.
+     *
+     * No arcs are considered here, just plain linear segments.
+     *
+     * @returns {Array<Vertex>}
+     */
+    getAllStartEndPoints() {
+        const verts = [this.segments[0].getStartPoint()];
+        this.segments.forEach((segment) => {
+            verts.push(segment.getEndPoint());
+        });
+        return verts;
+    }
 }
 //# sourceMappingURL=GenericPath.js.map

package/src/esm/utils/datastructures/GenericPath.js.map

@@ -1 +1 @@
-{"version":3,"file":"GenericPath.js","sourceRoot":"","sources":["../../../ts/utils/datastructures/GenericPath.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,MAAM,OAAO,WAAW;IAGtB,YAAY,YAAyB;QACnC,IAAI,CAAC,QAAQ,GAAG,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,KAAa;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3F,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAClD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3D;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,OAAO;QACL,MAAM,WAAW,GAAuB,EAAE,CAAC;QAC3C,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAClD,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC9C;QACD,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACjE,CAAC;CACF"}
+{"version":3,"file":"GenericPath.js","sourceRoot":"","sources":["../../../ts/utils/datastructures/GenericPath.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,MAAM,OAAO,WAAW;IAGtB,YAAY,YAAyB;QACnC,IAAI,CAAC,QAAQ,GAAG,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,KAAa;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3F,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAClD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3D;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,OAAO;QACL,MAAM,WAAW,GAAuB,EAAE,CAAC;QAC3C,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAClD,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC9C;QACD,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACjE,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB;QAClB,MAAM,KAAK,GAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAoB,EAAE,EAAE;YAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/src/esm/utils/detectDarkMode.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author  Ikaros Kappler
+ * @date    2021-11-07
+ * @modified 2023-09-25 Ported to Typescript and added system darkmode detection.
+ * @version 1.1.0
+ *
+ * @param {Record<string,string>} GUP
+ * @returns {boolean}
+ */
+export declare const detectDarkMode: (GUP?: Record<string, string>) => boolean;

package/src/esm/utils/detectDarkMode.js

@@ -0,0 +1,28 @@
+/**
+ * @author  Ikaros Kappler
+ * @date    2021-11-07
+ * @modified 2023-09-25 Ported to Typescript and added system darkmode detection.
+ * @version 1.1.0
+ *
+ * @param {Record<string,string>} GUP
+ * @returns {boolean}
+ */
+export const detectDarkMode = (GUP) => {
+    // Respect overrides
+    if (typeof GUP !== "undefined" && GUP.hasOwnProperty("darkmode") && GUP["darkmode"]) {
+        // const overrideValue = PlotBoilerplate.utils.fetch.bool(GUP, "darkmode", null);
+        const overrideValue = !!JSON.parse(GUP["darkmode"]);
+        if (overrideValue !== null) {
+            return overrideValue;
+        }
+    }
+    if (globalThis.matchMedia && globalThis.matchMedia("(prefers-color-scheme: dark)").matches) {
+        // dark mode by system
+        return true;
+    }
+    // else: dark mode by daytime
+    const hours = new Date().getHours();
+    const isDayTime = hours > 6 && hours < 18;
+    return !isDayTime;
+};
+//# sourceMappingURL=detectDarkMode.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"detectDarkMode.js","sourceRoot":"","sources":["../../ts/utils/detectDarkMode.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAA4B,EAAE,EAAE;IAC7D,oBAAoB;IACpB,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,EAAE;QACnF,iFAAiF;QACjF,MAAM,aAAa,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QACpD,IAAI,aAAa,KAAK,IAAI,EAAE;YAC1B,OAAO,aAAa,CAAC;SACtB;KACF;IACD,IAAI,UAAU,CAAC,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC,OAAO,EAAE;QAC1F,sBAAsB;QACtB,OAAO,IAAI,CAAC;KACb;IACD,6BAA6B;IAC7B,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC;IACpC,MAAM,SAAS,GAAG,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;IAC1C,OAAO,CAAC,SAAS,CAAC;AACpB,CAAC,CAAC"}

package/src/ts/BezierPath.ts

@@ -23,7 +23,9 @@
  * @modified 2022-01-31 Added `BezierPath.getEvenDistributionVertices(number)`.
  * @modified 2022-02-02 Added the `destroy` method.
  * @modified 2022-02-02 Cleared the `toSVGString` function (deprecated). Use `drawutilssvg` instead.
- * @version 2.5.0
+ * @modified 2023-10-06 Adding the `BezierPath.toPathPoints()` method.
+ * @modified 2023-10-07 Adding the `BezierPath.fromCurve(CubicBezierCurve)` static function.
+ * @version 2.6.0
  *
  * @file BezierPath
  * @public
@@ -139,10 +141,13 @@ export class BezierPath implements SVGSerializable {
    * @name BezierPath
    * @param {Vertex[]} pathPoints - An array of path vertices (no control points).
    **/
-  private constructor(pathPoints: Array<Vertex> | undefined | null) {
+  private constructor() {
+    // pathPoints: Array<Vertex> | undefined | null) {
     this.uid = UIDGenerator.next();
 
-    if (!pathPoints) pathPoints = [];
+    // if (!pathPoints) {
+    //   pathPoints = [];
+    // }
     this.totalArcLength = 0.0;
     // Set this flag to true if you want the first point and
     // last point of the path to be auto adjusted, too.
@@ -300,220 +305,6 @@ export class BezierPath implements SVGSerializable {
     return this.bezierCurves[curveIndex];
   }
 
-  /**
-   * Remove the end point of this path (which removes the last curve from this path).<br>
-   * <br>
-   * Please note that this function does never remove the first curve, thus the path
-   * cannot be empty after this call.
-   *
-   * @method removeEndPoint
-   * @instance
-   * @memberof BezierPath
-   * @return {boolean} Indicating if the last curve was removed.
-   **/
-  /*
-    BezierPath.prototype.removeEndPoint = function() {
-	if( this.bezierCurves.length <= 1 )
-	    return false;
-	
-	var newArray = [ this.bezierCurves.length-1 ];
-	for( var i = 0; i < this.bezierCurves.length-1; i++ ) {
-	    newArray[i] = this.bezierCurves[i];
-	}
-	
-	// Update arc length
-	this.totalArcLength -= this.bezierCurves[ this.bezierCurves.length-1 ].getLength();
-	this.bezierCurves = newArray;	
-	return true;
-    }
-    */
-
-  /**
-   * Remove the start point of this path (which removes the first curve from this path).<br>
-   * <br>
-   * Please note that this function does never remove the last curve, thus the path
-   * cannot be empty after this call.<br>
-   *
-   * @method removeStartPoint
-   * @instance
-   * @memberof BezierPath
-   * @return {boolean} Indicating if the first curve was removed.
-   **/
-  /*
-    BezierPath.prototype.removeStartPoint = function() {
-
-	if( this.bezierCurves.length <= 1 )
-	    return false;
-
-	var newArray = [ this.bezierCurves.length-1 ];
-	for( var i = 1; i < this.bezierCurves.length; i++ ) {
-
-	    newArray[i-1] = this.bezierCurves[i];
-
-	}
-	
-	// Update arc length
-	this.totalArcLength -= this.bezierCurves[ 0 ].getLength();
-	this.bezierCurves = newArray;
-	
-	return true;
-    }
-    */
-
-  /**
-   * Removes a path point inside the path.
-   *
-   * This function joins the bezier curve at the given index with
-   * its predecessor, which means that the start point at the given
-   * curve index will be removed.
-   *
-   * @method joinAt
-   * @param {number} curveIndex - The index of the curve to be joined with its predecessor.
-   * @instance
-   * @memberof BezierPath
-   * @return {boolean} True if the passed index indicated an inner vertex and the two curves were joined.
-   **/
-  /*
-    BezierPath.prototype.joinAt = function( curveIndex ) {
-
-	if( curveIndex < 0 || curveIndex >= this.bezierCurves.length )
-	    return false;
-	
-	var leftCurve  = this.bezierCurves[ curveIndex-1 ];
-	var rightCurve = this.bezierCurves[ curveIndex ];
-
-	// Make the length of the new handle double that long
-	var leftControlPoint = leftCurve.getStartControlPoint().clone();
-	leftControlPoint.sub( leftCurve.getStartPoint() );
-	leftControlPoint.multiplyScalar( 2.0 );
-	leftControlPoint.add( leftCurve.getStartPoint() );
-	
-	var rightControlPoint = rightCurve.getEndControlPoint().clone();
-	rightControlPoint.sub( rightCurve.getEndPoint() );
-	rightControlPoint.multiplyScalar( 2.0 );
-	rightControlPoint.add( rightCurve.getEndPoint() );	
-
-	var newCurve = new IKRS.CubicBezierCurve( leftCurve.getStartPoint(),
-						  rightCurve.getEndPoint(),
-						  leftControlPoint,
-						  rightControlPoint 
-						);	
-	// Place into array
-	var newArray = [ this.bezierCurves.length - 1 ];
-
-	for( var i = 0; i < curveIndex-1; i++ ) 
-	    newArray[ i ] = this.bezierCurves[i];
-	
-	newArray[ curveIndex-1 ] = newCurve;
-	
-	// Shift trailing curves left
-	for( var i = curveIndex; i+1 < this.bezierCurves.length; i++ ) 
-	    newArray[ i ] = this.bezierCurves[ i+1 ];
-		
-	this.bezierCurves = newArray;
-	this.updateArcLengths();
-
-	return true;
-    }
-    */
-
-  /**
-   * Add a new inner curve point to the path.<br>
-   * <br>
-   * This function splits the bezier curve at the given index and given
-   * curve segment index.
-   *
-   * @method splitAt
-   * @param {number} curveIndex - The index of the curve to split.
-   * @param {nunber} segmentIndex - The index of the curve segment where the split should be performed.
-   * @instance
-   * @memberof BezierPath
-   * @return {boolean} True if the passed indices were valid and the path was split.
-   **/
-  /*
-    BezierPath.prototype.splitAt = function( curveIndex,
-					     segmentIndex 
-					   ) {
-	// Must be a valid curve index
-	if( curveIndex < 0 || curveIndex >= this.bezierCurves.length )
-	    return false;
-
-	var oldCurve = this.bezierCurves[ curveIndex ];
-
-	// Segment must be an INNER point!
-	// (the outer points are already bezier end/start points!)
-	if( segmentIndex < 1 || segmentIndex-1 >= oldCurve.segmentCache.length )
-	    return false;
-
-	// Make room for a new curve
-	for( var c = this.bezierCurves.length; c > curveIndex; c-- ) {
-	    // Move one position to the right
-	    this.bezierCurves[ c ] = this.bezierCurves[ c-1 ];	    
-	}
-
-	// Accumulate segment lengths
-	var u = 0;
-	for( var i = 0; i < segmentIndex; i++ )
-	    u += oldCurve.segmentLengths[i];
-	//var tangent = oldCurve.getTangentAt( u );
-	var tangent = oldCurve.getTangent( u );
-	tangent = tangent.multiplyScalar( 0.25 ); 
-
-	var leftEndControlPoint = oldCurve.segmentCache[ segmentIndex ].clone();
-	leftEndControlPoint.sub( tangent );
-	
-	var rightStartControlPoint = oldCurve.segmentCache[ segmentIndex ].clone();
-	rightStartControlPoint.add( tangent );
-	
-	// Make the old existing handles a quarter that long
-	var leftStartControlPoint = oldCurve.getStartControlPoint().clone();
-	// move to (0,0)
-	leftStartControlPoint.sub( oldCurve.getStartPoint() );
-	leftStartControlPoint.multiplyScalar( 0.25 );
-	leftStartControlPoint.add( oldCurve.getStartPoint() );
-
-	var rightEndControlPoint = oldCurve.getEndControlPoint().clone(); 
-	// move to (0,0)
-	rightEndControlPoint.sub( oldCurve.getEndPoint() );
-	rightEndControlPoint.multiplyScalar( 0.25 );
-	rightEndControlPoint.add( oldCurve.getEndPoint() );
-
-	var newLeft  = new CubicBezierCurve( oldCurve.getStartPoint(),                      // old start point
-					     oldCurve.segmentCache[ segmentIndex ],         // new end point
-					     leftStartControlPoint,                         // old start control point 
-					     leftEndControlPoint                            // new end control point
-					   );
-	var newRight = new CubicBezierCurve( oldCurve.segmentCache[ segmentIndex ],         // new start point
-					     oldCurve.getEndPoint(),                        // old end point
-					     rightStartControlPoint,                        // new start control point 
-					     rightEndControlPoint                           // old end control point
-					   );
-	
-	// Insert split curve(s) at free index
-	this.bezierCurves[ curveIndex ]     = newLeft;
-	this.bezierCurves[ curveIndex + 1 ] = newRight;
-	
-	// Update total arc length, even if there is only a very little change!
-	this.totalArcLength -= oldCurve.getLength();
-	this.totalArcLength += newLeft.getLength();
-	this.totalArcLength += newRight.getLength();
-
-	return true;
-    };
-    */
-
-  /*
-    insertVertexAt( t:number ) : void {
-	console.log('Inserting vertex at', t );
-	// Find the curve index
-	var u : number = 0;
-	var curveIndex : number = -1;
-	var localT : number = 0.0;
-	for( var i = 0; curveIndex == -1 && i < this.bezierCurves.length; i++ ) {
-	    
-	}
-    }; */
-
   /**
    * Move the whole bezier path by the given (x,y)-amount.
    *
@@ -551,24 +342,6 @@ export class BezierPath implements SVGSerializable {
    * @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);
   }
 
@@ -1132,7 +905,7 @@ export class BezierPath implements SVGSerializable {
    * @return {BezierPath}
    **/
   clone(): BezierPath {
-    var path: BezierPath = new BezierPath(undefined);
+    var path: BezierPath = new BezierPath(); // undefined);
     for (var i = 0; i < this.bezierCurves.length; i++) {
       path.bezierCurves.push(this.bezierCurves[i].clone());
       // Connect splines
@@ -1168,6 +941,10 @@ export class BezierPath implements SVGSerializable {
    * 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
    * should not be used.
+   *
+   * @method destroy
+   * @instance
+   * @memberof BezierPath
    */
   destroy() {
     for (var i = 0; i < this.bezierCurves.length; i++) {
@@ -1176,6 +953,42 @@ export class BezierPath implements SVGSerializable {
     this.isDestroyed = true;
   }
 
+  /**
+   * Convert this path to an array of path points that can be drawn by the default DrawLib
+   * implementations.
+   *
+   * @method toPathPoints
+   * @instance
+   * @memberof BezierPath
+   * @return {Array<XYCoords>}
+   */
+  toPathPoints(): Array<XYCoords> {
+    if (this.bezierCurves.length === 0) {
+      return [];
+    }
+    if (this.bezierCurves.length === 1) {
+      return [
+        this.bezierCurves[0].startPoint,
+        this.bezierCurves[0].startControlPoint,
+        this.bezierCurves[0].endControlPoint,
+        this.bezierCurves[0].endPoint
+      ];
+    }
+    const arr: Array<XYCoords> = [];
+    arr.push(this.bezierCurves[0].startPoint);
+    arr.push(this.bezierCurves[0].startControlPoint);
+    for (var i = 1; i < this.bezierCurves.length; i++) {
+      arr.push(this.bezierCurves[i - 1].endControlPoint);
+      arr.push(this.bezierCurves[i - 1].endPoint);
+      arr.push(this.bezierCurves[i].startPoint);
+      arr.push(this.bezierCurves[i].startControlPoint);
+    }
+    arr.push(this.bezierCurves[0].endControlPoint);
+    arr.push(this.bezierCurves[0].endPoint);
+
+    return arr;
+  }
+
   /**
    * Create a JSON string representation of this bézier curve.
    *
@@ -1215,6 +1028,21 @@ export class BezierPath implements SVGSerializable {
     return BezierPath.fromArray(obj);
   }
 
+  /**
+   * Construct a new path with a single curve. Adding more curves is always possible.
+   *
+   * @method fromCurve
+   * @param {CubicBezierCurve} curve - The curve to construct a new path from.
+   * @static
+   * @memberof BezierPath
+   * @return {BezierPath} The constructed bezier path instance.
+   */
+  static fromCurve(curve: CubicBezierCurve): BezierPath {
+    const path = new BezierPath(); // []);
+    path.addCurve(curve);
+    return path;
+  }
+
   /**
    * Create a BezierPath instance from the given array.
    *
@@ -1225,16 +1053,19 @@ export class BezierPath implements SVGSerializable {
    * @memberof BezierPath
    * @return {BezierPath} The bezier path instance retrieved from the array data.
    **/
-  static fromArray(obj: any) {
-    if (!Array.isArray(obj)) throw "[BezierPath.fromArray] Passed object must be an array.";
+  static fromArray(obj: any): BezierPath {
+    if (!Array.isArray(obj)) {
+      throw "[BezierPath.fromArray] Passed object must be an array.";
+    }
 
     const arr: Array<any> = obj as Array<Array<Vertex>>; // FORCE?
 
-    if (arr.length < 1)
+    if (arr.length < 1) {
       throw "[BezierPath.fromArray] Passed array must contain at least one bezier curve (has " + arr.length + ").";
+    }
 
     // Create an empty bezier path
-    var bPath: BezierPath = new BezierPath(undefined);
+    var bPath: BezierPath = new BezierPath(); // undefined);
     var lastCurve: CubicBezierCurve | null = null;
     for (var i = 0; i < arr.length; i++) {
       // Convert object (or array?) to bezier curve
@@ -1352,7 +1183,7 @@ export class BezierPath implements SVGSerializable {
    */
   static fromReducedList(pointArray: Array<number>, adjustCircular?: boolean): BezierPath {
     // Convert to object
-    var bezierPath: BezierPath = new BezierPath(null); // No points yet
+    var bezierPath: BezierPath = new BezierPath(); // null); // No points yet
 
     var startPoint: Vertex = new Vertex();
     var startControlPoint: Vertex;