plotboilerplate 1.18.0 → 1.19.0

package/src/esm/interfaces/index.js

@@ -1,4 +1,5 @@
 export * from "./core";
 export * from "./DrawLib";
 export * from "./externals";
+export * from "./additionals";
 //# sourceMappingURL=index.js.map

package/src/esm/interfaces/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}

package/src/esm/utils/algorithms/arrayShuffle.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Randomize a given array in-place.
+ *
+ * @author Ikaros Kappler
+ * @date 2022-10-09
+ * @version 1.0.0
+ **/
+export declare const arrayShuffle: (arr: Array<any>) => void;

package/src/esm/utils/algorithms/arrayShuffle.js

@@ -0,0 +1,11 @@
+/**
+ * Randomize a given array in-place.
+ *
+ * @author Ikaros Kappler
+ * @date 2022-10-09
+ * @version 1.0.0
+ **/
+export const arrayShuffle = (arr) => {
+    arr.sort(() => Math.random() - 0.5);
+};
+//# sourceMappingURL=arrayShuffle.js.map

package/src/esm/utils/algorithms/arrayShuffle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrayShuffle.js","sourceRoot":"","sources":["../../../ts/utils/algorithms/arrayShuffle.ts"],"names":[],"mappings":"AAAA;;;;;;IAMI;AAEJ,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAe,EAAQ,EAAE;IACpD,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC;AACtC,CAAC,CAAC"}

package/src/esm/utils/algorithms/detectPaths.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A function to detect connected paths on the plane given by a random set of segments.
+ *
+ * Note that is algorithm operates IN PLACE and will ALTER your INPUT array.
+ *
+ * @author  Ikaros Kappler
+ * @version 1.0.0
+ * @date    2022-10-17
+ */
+import { Path, PathSegment } from "../../interfaces";
+/**
+ * Run a path detection on the given set of path segments.
+ *
+ * Note that the array and some path segments may be altered (like reversal) IN PLACE.
+ *
+ * @param {Array<PathSegment>} segments - The total set (array) of available path segments.
+ * @param {number=1.0} epsilon - (optional) An epsilon to use to tell if two plane points should be considered 'equal'.
+ * @returns {Array<GenericPath>} An array containing all detected path (consisting of adjacent path segments of the original set).
+ */
+export declare const detectPaths: (segments: Array<PathSegment>, epsilon?: number) => Array<Path>;

package/src/esm/utils/algorithms/detectPaths.js

@@ -0,0 +1,165 @@
+/**
+ * A function to detect connected paths on the plane given by a random set of segments.
+ *
+ * Note that is algorithm operates IN PLACE and will ALTER your INPUT array.
+ *
+ * @author  Ikaros Kappler
+ * @version 1.0.0
+ * @date    2022-10-17
+ */
+import { GenericPath } from "../datastructures/GenericPath";
+/**
+ * A private helper function that initializes the visitation tracking and reverses
+ * dangling path ends to connect them with preceding paths.
+ *
+ * Note that this function alters those dangling path segments IN PLACE!
+ *
+ * @param segments
+ * @param epsilon
+ * @returns
+ */
+const initVisitationArray = (segments, epsilon) => {
+    const result = []; // { visited: false, hasPredecessor: false }
+    for (var i = 0; i < segments.length; i++) {
+        result.push({ visited: false, hasPredecessor: false, hasSuccessor: false });
+        for (var j = 0; j < segments.length; j++) {
+            if (i === j) {
+                continue;
+            }
+            if (segments[i].getStartPoint().distance(segments[j].getEndPoint()) < epsilon ||
+                segments[i].getStartPoint().distance(segments[j].getStartPoint()) < epsilon) {
+                result[i].hasPredecessor = true;
+            }
+            if (segments[i].getEndPoint().distance(segments[j].getEndPoint()) < epsilon ||
+                segments[i].getEndPoint().distance(segments[j].getStartPoint()) < epsilon) {
+                result[i].hasSuccessor = true;
+            }
+        }
+    }
+    // After first initialization make sure that no loose path ends are dangling around
+    // if the affected path segment has a predecessor (but nu successor).
+    //
+    // Revert those segments. This makes the actual detection algorithm much easier.
+    for (var i = 0; i < segments.length; i++) {
+        if (!result[i].hasSuccessor && result[i].hasPredecessor) {
+            segments[i] = segments[i].reverse();
+            result[i].hasPredecessor = false;
+            result[i].hasSuccessor = true;
+        }
+    }
+    return result;
+};
+/**
+ * Find the next unvisited path segment (private helper function).
+ *
+ * There is a special order: starting path segments (those without any predecessor)
+ * will be preferred. If no more open paths are available (no starting path segments),
+ * then no more unvisited paths are available or all remaining paths are loops (without
+ * determined start/end).
+ *
+ * Doing this keeps us from the need to run a final loop to connect detected sub paths.
+ *
+ * @param {Array<PathSegment>} segments - The path segments to search in.
+ * @param { Array<Visitation>} isSegmentVisited
+ * @returns {number} The index of the next unvisited path segment or -1 if no more are available.
+ */
+const locateUnvisitedSegment = (segments, isSegmentVisited) => {
+    // First run: detect beginnings
+    for (var i = 0; i < segments.length; i++) {
+        if (!isSegmentVisited[i].hasPredecessor && !isSegmentVisited[i].visited) {
+            return i;
+        }
+    }
+    // Second run: if no beginnings exist -> use inner path segment
+    for (var i = 0; i < segments.length; i++) {
+        if (!isSegmentVisited[i].visited) {
+            return i;
+        }
+    }
+    return -1;
+};
+/**
+ * Get the next adjacent path segment to the given (current) segment. This is a private
+ * helper function.
+ *
+ * Note that the function will revert the adjacent path segment if required, so the next
+ * starting point 'equals' the current ending point.
+ *
+ * The visitation tracker will be updated if the adjacent segment was found.
+ *
+ * @param {Array<PathSegment>} segments - The total set of available path segments (visited and invisited).
+ * @param {Array<Visitation>} isSegmentVisited - A tracker of visited path segments so far.
+ * @param {PathSegment} currentSegment - The current path segment to find the adjacent segment for.
+ * @param {number} epsilon - The epsilon to use to detect 'equal' start/end points. Must be >= 0.
+ * @returns {PathSegment | null} The next adjacent path segment of null if no such exists.
+ */
+const getAdjacentSegment = (segments, isSegmentVisited, currentSegment, epsilon) => {
+    for (var j = 0; j < segments.length; j++) {
+        if (isSegmentVisited[j].visited) {
+            continue;
+        }
+        var nextSegment = segments[j];
+        // [start]---[end] [start]---[end]
+        if (currentSegment.getEndPoint().distance(nextSegment.getStartPoint()) < epsilon) {
+            isSegmentVisited[j].visited = true;
+            return nextSegment;
+        }
+        // [start]---[end] [end]---[start]
+        else if (currentSegment.getEndPoint().distance(nextSegment.getEndPoint()) < epsilon) {
+            isSegmentVisited[j].visited = true;
+            return nextSegment.reverse();
+        }
+    }
+    return null;
+};
+/**
+ * A private helper function to find the adjacent full path for the given path segment,
+ * considering the current path segment is a starting segment (or one inside a loop).
+ *
+ * @param {Array<PathSegment>} segments - The total set of available path segments.
+ * @param { Array<Visitation>} isSegmentVisited - A tracker to determine which segments have already been visited.
+ * @param {number} currentSegmentIndex - The index of the current segments to find the containing path for.
+ * @param {number} epsilon - The epsilon to use to determine 'equal' path points. Must be >= 0.
+ * @returns {GenericPath} The dected path which consists at least of the current path segment.
+ */
+const detectAdjacentPath = (segments, isSegmentVisited, currentSegmentIndex, epsilon) => {
+    var currentSegment = segments[currentSegmentIndex];
+    isSegmentVisited[currentSegmentIndex].visited = true;
+    const path = new GenericPath(currentSegment); // { segments: [currentSegment], reverse };
+    var i = 0;
+    // A safety break if something goes wrong
+    while (i < segments.length && currentSegment) {
+        currentSegment = getAdjacentSegment(segments, isSegmentVisited, currentSegment, epsilon);
+        if (currentSegment) {
+            path.segments.push(currentSegment);
+        }
+        i++;
+    }
+    return path;
+};
+/**
+ * Run a path detection on the given set of path segments.
+ *
+ * Note that the array and some path segments may be altered (like reversal) IN PLACE.
+ *
+ * @param {Array<PathSegment>} segments - The total set (array) of available path segments.
+ * @param {number=1.0} epsilon - (optional) An epsilon to use to tell if two plane points should be considered 'equal'.
+ * @returns {Array<GenericPath>} An array containing all detected path (consisting of adjacent path segments of the original set).
+ */
+export const detectPaths = (segments, epsilon) => {
+    const eps = typeof epsilon === "undefined" || epsilon < 0 ? 1.0 : epsilon;
+    const isSegmentVisited = initVisitationArray(segments, eps);
+    const resultPaths = [];
+    var nextSegmentIndex = -1;
+    var i = 0;
+    while ((nextSegmentIndex = locateUnvisitedSegment(segments, isSegmentVisited)) !== -1 && i < segments.length) {
+        isSegmentVisited[nextSegmentIndex].visited = true;
+        // A safety break (to avoid infinited loops during development).
+        i++;
+        const path = detectAdjacentPath(segments, isSegmentVisited, nextSegmentIndex, eps);
+        i += path.getSegmentCount() - 1;
+        resultPaths.push(path);
+    }
+    return resultPaths;
+};
+//# sourceMappingURL=detectPaths.js.map

package/src/esm/utils/algorithms/detectPaths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detectPaths.js","sourceRoot":"","sources":["../../../ts/utils/algorithms/detectPaths.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAW5D;;;;;;;;;GASG;AACH,MAAM,mBAAmB,GAAG,CAAC,QAA4B,EAAE,OAAe,EAAqB,EAAE;IAC/F,MAAM,MAAM,GAAsB,EAAE,CAAC,CAAC,4CAA4C;IAClF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACxC,IAAI,CAAC,KAAK,CAAC,EAAE;gBACX,SAAS;aACV;YACD,IACE,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,OAAO;gBACzE,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,GAAG,OAAO,EAC3E;gBACA,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC;aACjC;YACD,IACE,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,OAAO;gBACvE,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,GAAG,OAAO,EACzE;gBACA,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC;aAC/B;SACF;KACF;IACD,mFAAmF;IACnF,qEAAqE;IACrE,EAAE;IACF,gFAAgF;IAChF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE;YACvD,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,GAAG,KAAK,CAAC;YACjC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC;SAC/B;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,sBAAsB,GAAG,CAAC,QAA4B,EAAE,gBAAmC,EAAU,EAAE;IAC3G,+BAA+B;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;YACvE,OAAO,CAAC,CAAC;SACV;KACF;IACD,+DAA+D;IAC/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;YAChC,OAAO,CAAC,CAAC;SACV;KACF;IACD,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,kBAAkB,GAAG,CACzB,QAA4B,EAC5B,gBAAmC,EACnC,cAA2B,EAC3B,OAAe,EACK,EAAE;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;YAC/B,SAAS;SACV;QACD,IAAI,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC9B,kCAAkC;QAClC,IAAI,cAAc,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC,GAAG,OAAO,EAAE;YAChF,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC;YACnC,OAAO,WAAW,CAAC;SACpB;QACD,kCAAkC;aAC7B,IAAI,cAAc,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,GAAG,OAAO,EAAE;YACnF,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC;YACnC,OAAO,WAAW,CAAC,OAAO,EAAE,CAAC;SAC9B;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,kBAAkB,GAAG,CACzB,QAA4B,EAC5B,gBAAmC,EACnC,mBAA2B,EAC3B,OAAe,EACF,EAAE;IACf,IAAI,cAAc,GAAuB,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACvE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC;IACrD,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,2CAA2C;IAEzF,IAAI,CAAC,GAAW,CAAC,CAAC;IAClB,yCAAyC;IACzC,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,IAAI,cAAc,EAAE;QAC5C,cAAc,GAAG,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;QACzF,IAAI,cAAc,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SACpC;QACD,CAAC,EAAE,CAAC;KACL;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAA4B,EAAE,OAAgB,EAAe,EAAE;IACzF,MAAM,GAAG,GAAG,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC;IAC1E,MAAM,gBAAgB,GAAsB,mBAAmB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC/E,MAAM,WAAW,GAAuB,EAAE,CAAC;IAC3C,IAAI,gBAAgB,GAAW,CAAC,CAAC,CAAC;IAClC,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE;QAC5G,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC;QAClD,gEAAgE;QAChE,CAAC,EAAE,CAAC;QACJ,MAAM,IAAI,GAAG,kBAAkB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAC;QACnF,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;QAChC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACxB;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC"}

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

@@ -0,0 +1,75 @@
+/**
+ * @author  Ikaros Kappler
+ * @version 1.0.0
+ * @date    2022-10-17
+ */
+import { Path, PathSegment } from "../../interfaces/additionals";
+import { Vertex } from "../../Vertex";
+export declare class GenericPath implements Path {
+    segments: Array<PathSegment>;
+    constructor(startSegment: PathSegment);
+    /**
+     * Get the number of segments in this path.
+     *
+     * @method getSegmentCount
+     * @memberof Path
+     * @return {number} The number (integer) of path segments.
+     */
+    getSegmentCount(): number;
+    /**
+     * Get the path segment at the given index.
+     *
+     * @method getSegmentAt
+     * @memberof Path
+     * @return {PathSegment} The paths segment at the given index.
+     */
+    getSegmentAt(index: number): PathSegment;
+    /**
+     * Create a deep clone of this path.
+     *
+     * @method clone
+     * @memberof Path
+     * @return {Path} A deep clone/copy of this path.
+     */
+    clone(): GenericPath;
+    /**
+     * Reverse this path (swap start and end and thus – the direction) in-place.
+     *
+     * @method reverse
+     * @memberof Path
+     * @return {PathSegment} This path instance.
+     */
+    reverse(): this;
+    /**
+     * Get the start point of this path segment.
+     *
+     * @method getStartPoint
+     * @memberof PathSegment
+     * @return {Vertex} The start point of this path segment.
+     */
+    getStartPoint(): Vertex;
+    /**
+     * Get the end point of this path segment.
+     *
+     * @method getEndPoint
+     * @memberof PathSegment
+     * @return {Vertex} The end point of this path segment.
+     */
+    getEndPoint(): Vertex;
+    /**
+     * Get the tangent's end point at the start point of this segment.
+     *
+     * @method getStartTangent
+     * @memberof PathSegment
+     * @return {Vertex} The end point of the starting point's tangent.
+     */
+    getStartTangent(): Vertex;
+    /**
+     * Get the tangent's end point at the end point of this segment.
+     *
+     * @method getEndTangent
+     * @memberof PathSegment
+     * @return {Vertex} The end point of the ending point's tangent.
+     */
+    getEndTangent(): Vertex;
+}

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

@@ -0,0 +1,100 @@
+/**
+ * @author  Ikaros Kappler
+ * @version 1.0.0
+ * @date    2022-10-17
+ */
+export class GenericPath {
+    constructor(startSegment) {
+        this.segments = [startSegment];
+    }
+    /**
+     * Get the number of segments in this path.
+     *
+     * @method getSegmentCount
+     * @memberof Path
+     * @return {number} The number (integer) of path segments.
+     */
+    getSegmentCount() {
+        return this.segments.length;
+    }
+    /**
+     * Get the path segment at the given index.
+     *
+     * @method getSegmentAt
+     * @memberof Path
+     * @return {PathSegment} The paths segment at the given index.
+     */
+    getSegmentAt(index) {
+        return this.segments[index];
+    }
+    /**
+     * Create a deep clone of this path.
+     *
+     * @method clone
+     * @memberof Path
+     * @return {Path} A deep clone/copy of this path.
+     */
+    clone() {
+        const newPath = new GenericPath(this.segments[this.segments.length - 1].clone().reverse());
+        for (var i = this.segments.length - 2; i >= 0; i--) {
+            newPath.segments.push(this.segments[i].clone().reverse());
+        }
+        return newPath;
+    }
+    /**
+     * Reverse this path (swap start and end and thus – the direction) in-place.
+     *
+     * @method reverse
+     * @memberof Path
+     * @return {PathSegment} This path instance.
+     */
+    reverse() {
+        const newSegments = [];
+        for (var i = this.segments.length - 1; i >= 0; i--) {
+            newSegments.push(this.segments[i].reverse());
+        }
+        this.segments = newSegments;
+        return this;
+    }
+    /**
+     * Get the start point of this path segment.
+     *
+     * @method getStartPoint
+     * @memberof PathSegment
+     * @return {Vertex} The start point of this path segment.
+     */
+    getStartPoint() {
+        return this.segments[0].getStartPoint();
+    }
+    /**
+     * Get the end point of this path segment.
+     *
+     * @method getEndPoint
+     * @memberof PathSegment
+     * @return {Vertex} The end point of this path segment.
+     */
+    getEndPoint() {
+        return this.segments[this.segments.length - 1].getEndPoint();
+    }
+    /**
+     * Get the tangent's end point at the start point of this segment.
+     *
+     * @method getStartTangent
+     * @memberof PathSegment
+     * @return {Vertex} The end point of the starting point's tangent.
+     */
+    getStartTangent() {
+        return this.segments[0].getStartTangent();
+    }
+    /**
+     * Get the tangent's end point at the end point of this segment.
+     *
+     * @method getEndTangent
+     * @memberof PathSegment
+     * @return {Vertex} The end point of the ending point's tangent.
+     */
+    getEndTangent() {
+        return this.segments[this.segments.length - 1].getEndTangent();
+    }
+}
+//# sourceMappingURL=GenericPath.js.map

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

@@ -0,0 +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"}

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

@@ -225,7 +225,7 @@ export declare abstract class GirihTile extends Polygon {
      * @param {Polygon} neighbourTile - The polygon (or tile) you want to find adjacency for at the specified edge.
      * @return {Polygon|null} the passed tile itself if adjacency was found, null otherwise.
      */
-    transformTilePositionToAdjacency<P extends Polygon>(baseEdgeIndex: number, neighbourTile: P): P;
+    transformTilePositionToAdjacency<P extends Polygon>(baseEdgeIndex: number, neighbourTile: P): P | null;
     /**
      * Get the inner tile polygon at the given index.
      * This function applies MOD to the index.

package/src/ts/Bounds.ts

@@ -6,7 +6,8 @@
  * @modified 2021-02-02 Added the `toPolygon` method.
  * @modified 2021-06-21 (mid-summer) Added `getCenter` method.
  * @modified 2022-02-01 Added the `toString` function.
- * @version  1.4.0
+ * @modified 2022-10-09 Added the `fromDimension` function.
+ * @version  1.5.0
  **/
 
 import { Polygon } from "./Polygon";
@@ -154,4 +155,16 @@ export class Bounds implements IBounds, XYDimension {
     }
     return new Bounds(new Vertex(xMin, yMin), new Vertex(xMax, yMax));
   }
+
+  /**
+   * Create a new `Bounds` instance just from `width` and `height`, located at (0,0) or the optionally given origin.
+   *
+   * @param {number} width - The width of the bounds
+   * @param {number} height  - The height of the bounds
+   * @param {XYCoords={x:0,y:0}} origin - [optional] A origin to locate the new Bounds object at.
+   * @returns {Bounds} A new `Bounds` instance width given width and height, located at (0,0) or the given origin..
+   */
+  static fromDimension(width: number, height: number, origin?: XYCoords): Bounds {
+    return new Bounds(origin ?? { x: 0, y: 0 }, { x: (origin ? origin.x : 0) + width, y: (origin ? origin.y : 0) + height });
+  }
 } // END class bounds

package/src/ts/CubicBezierCurve.ts

@@ -20,7 +20,8 @@
  * @modified 2021-01-20 Added UID.
  * @modified 2022-02-02 Added the `destroy` method.
  * @modified 2022-02-02 Cleared the `toSVGPathData` function (deprecated). Use `drawutilssvg` instead.
- * @version 2.6.0
+ * @modified 2022-10-17 The `CubicBezierCurve` class now implements the new `PathSegment` interface.
+ * @version 2.7.1
  *
  * @file CubicBezierCurve
  * @public
@@ -30,7 +31,7 @@ import { Bounds } from "./Bounds";
 import { UIDGenerator } from "./UIDGenerator";
 import { Vertex } from "./Vertex";
 import { Vector } from "./Vector";
-import { XYCoords, UID } from "./interfaces";
+import { XYCoords, UID, PathSegment } from "./interfaces";
 
 /**
  * @classdesc A refactored cubic bezier curve class.
@@ -42,7 +43,7 @@ import { XYCoords, UID } from "./interfaces";
  * @requires UID
  * @requires UIDGenerator
  */
-export class CubicBezierCurve {
+export class CubicBezierCurve implements PathSegment {
   /** @constant {number} */
   static readonly START_POINT: number = 0;
   /** @constant {number} */
@@ -157,7 +158,7 @@ export class CubicBezierCurve {
     // An array of floats
     this.segmentLengths = [];
     // float
-    this.arcLength = null;
+    // this.arcLength = null;
 
     this.updateArcLengths();
   }
@@ -627,6 +628,30 @@ export class CubicBezierCurve {
     );
   }
 
+  //---BEGIN PathSegment-------------------------
+  /**
+   * Get the tangent's end point at the start point of this segment.
+   *
+   * @method getStartTangent
+   * @memberof PathSegment
+   * @return {Vertex} The end point of the starting point's tangent.
+   */
+  getStartTangent(): Vertex {
+    return this.startControlPoint;
+  }
+
+  /**
+   * Get the tangent's end point at the end point of this segment.
+   *
+   * @method getEndTangent
+   * @memberof PathSegment
+   * @return {Vertex} The end point of the ending point's tangent.
+   */
+  getEndTangent(): Vertex {
+    return this.endControlPoint;
+  }
+  //---END PathSegment-------------------------
+
   /**
    * Check if this and the specified curve are equal.<br>
    * <br>

package/src/ts/Line.ts

@@ -13,7 +13,9 @@
  * @modified 2020-03-23 Ported to Typescript from JS.
  * @modified 2020-12-04 The `intersection` function returns undefined if both lines are parallel.
  * @modified 2022-02-02 Added the `destroy` method.
- * @version  2.2.0
+ * @modified 2022-10-09 Changed the actual return value of the `intersection` function to null (was undefined before).
+ * @modified 2022-10-17 Adding these methods from the `PathSegment` interface: getStartPoint, getEndPoint, revert.
+ * @version  2.3.0
  *
  * @file Line
  * @public
@@ -21,7 +23,7 @@
 
 import { VertTuple } from "./VertTuple";
 import { Vertex } from "./Vertex";
-import { SVGSerializable } from "./interfaces";
+import { PathSegment, SVGSerializable } from "./interfaces";
 
 /**
  * @classdesc A line consists of two vertices a and b.<br>
@@ -31,7 +33,7 @@ import { SVGSerializable } from "./interfaces";
  *
  * @requires Vertex
  */
-export class Line extends VertTuple<Line> implements SVGSerializable {
+export class Line extends VertTuple<Line> implements SVGSerializable, PathSegment {
   /**
    * Required to generate proper CSS classes and other class related IDs.
    **/
@@ -59,9 +61,11 @@ export class Line extends VertTuple<Line> implements SVGSerializable {
    * @memberof Line
    **/
   // !!! DO NOT MOVE TO VertTuple
-  intersection(line: Line): Vertex | undefined {
+  intersection(line: Line): Vertex | null {
     const denominator: number = this.denominator(line);
-    if (denominator == 0) return null;
+    if (denominator == 0) {
+      return null;
+    }
 
     let a: number = this.a.y - line.a.y;
     let b: number = this.a.x - line.a.x;
@@ -75,10 +79,70 @@ export class Line extends VertTuple<Line> implements SVGSerializable {
     const y: number = this.a.y + a * (this.b.y - this.a.y);
 
     if (isNaN(a) || isNaN(x) || isNaN(y)) {
-      return undefined;
+      return null;
     }
 
     // if we cast these lines infinitely in both directions, they intersect here:
     return new Vertex(x, y);
   }
+
+  //--- Implement PathSegment ---
+  /**
+   * Get the start point of this path segment.
+   *
+   * @method getStartPoint
+   * @memberof PathSegment
+   * @return {Vertex} The start point of this path segment.
+   */
+  getStartPoint(): Vertex {
+    return this.a;
+  }
+
+  /**
+   * Get the end point of this path segment.
+   *
+   * @method getEndPoint
+   * @memberof PathSegment
+   * @return {Vertex} The end point of this path segment.
+   */
+  getEndPoint(): Vertex {
+    return this.b;
+  }
+
+  /**
+   * Get the tangent's end point at the start point of this segment.
+   *
+   * @method getStartTangent
+   * @memberof PathSegment
+   * @return {Vertex} The end point of the starting point's tangent.
+   */
+  getStartTangent(): Vertex {
+    return this.b;
+  }
+
+  /**
+   * Get the tangent's end point at the end point of this segment.
+   *
+   * @method getEndTangent
+   * @memberof PathSegment
+   * @return {Vertex} The end point of the ending point's tangent.
+   */
+  getEndTangent(): Vertex {
+    return this.a;
+  }
+
+  /**
+   * Inverse this path segment (in-place) and return this same instance (useful for chaining).
+   *
+   * @method reverse
+   * @memberof PathSegment
+   * @return {PathSegment} This path segment instance (for chaining).
+   */
+  reverse(): Line {
+    var tmp = this.a;
+    this.a = this.b;
+    this.b = tmp;
+    return this;
+  }
+  //--- END Implement PathSegment ---
 }