plotboilerplate 1.27.0 → 1.28.0

package/src/_cjs/utils/algorithms/ContourLineDetection.d.ts

@@ -0,0 +1,150 @@
+/**
+ * A function to detect contour lines from 3D terrain data.
+ *
+ * For usage see demo `./demos/48-contour-plot`.
+ *
+ * @requires detectPaths
+ * @requires GenericPath
+ * @author   Ikaros Kappler
+ * @date     2023-11-05
+ * @modified 2023-11-20 Addig path detection on a triangle based grid.
+ * @version  1.0.0
+ */
+import { Line } from "../../Line";
+import { IDataGrid2d } from "../datastructures/DataGrid2d";
+import { GenericPath } from "../datastructures/GenericPath";
+export declare class ContourLineDetection {
+    private dataGrid;
+    private rawLinearPathSegments;
+    static CLOSE_GAP_TYPE_NONE: number;
+    static CLOSE_GAP_TYPE_ABOVE: number;
+    static CLOSE_GAP_TYPE_BELOW: number;
+    debugMode: boolean;
+    /**
+     * Creates a new instance for calculating contour lines from the given data grid.
+     * @param {IDataGrid2d<number>} dataGrid - The data grid to use. Must not contain any NaN or null values.
+     * @param {boolean=?} debugMode - (optional) Pass `true` to log warnings on (rare) critical edge cases where the algorithm might fail.
+     */
+    constructor(dataGrid: IDataGrid2d<number>, debugMode?: boolean);
+    /**
+     * Detect contour paths from the underlying data source.
+     *
+     * @param {number} criticalHeightValue - The height value. If above data's maximum or below data's minimum then the result will be empty (no intersections).
+     * @param {number} options.closeGapType - `CLOSE_GAP_TYPE_NONE` or `CLOSE_GAP_TYPE_ABOVE` or `CLOSE_GAP_TYPE_BELOW`.
+     * @param {boolean=false} options.useTriangles - If set to true the detection will split each face3 quad into two triangle faces.
+     * @param {pathDetectEpsilon=0.000001} options.pathDetectEpsilon - (optional) The epsilon to tell if two points are located 'in the same place'. Used for connected path detection. If not specified the value `0.0000001` is used.
+     * @param {pointEliminationEpsilon=0.0000001} options.pointEliminationEpsilon - (optional) The epsilon for duplicate point elimination (default is 0.000001).
+     * @param {function?} onRawSegmentsDetected - (optional) Get the interim result of all detected single lines before path detection starts; DO NOT MODIFY the array.
+     * @returns {Array<GenericPath>} - A list of connected paths that resemble the contour lines of the data/terrain at the given height value.
+     */
+    detectContourPaths(criticalHeightValue: number, options?: {
+        closeGapType: number;
+        useTriangles?: boolean;
+        pointEliminationEpsilon?: number;
+        pathDetectEpsilon?: number;
+        onRawSegmentsDetected?: (rawSegmentsDoNotModifiy: Array<Line>) => void;
+    }): Array<GenericPath>;
+    /**
+     * This function will calculate a single intersecion line of the given face4 data
+     * segment. If the given face does not intersect with the plane at the given `heightValue`
+     * then no segments will be stored.
+     *
+     * @param {number} xIndex - The x position (index) of the data face.
+     * @param {number} yIndex - The y position (index) of the data face.
+     * @param {[[number,number],[number,number]]} heightFace - The data sample that composes the face4 as a two-dimensional number array.
+     * @param {number} heightValue - The height value of the intersection plane to check for.
+     * @returns {Line|null}
+     */
+    private findHeight4FaceIntersectionLine;
+    /**
+     * This function will calculate a single intersecion line of the given face4 data
+     * segment. If the given face does not intersect with the plane at the given `heightValue`
+     * then no segments will be stored.
+     *
+     * @param {number} xIndex - The x position (index) of the data face.
+     * @param {number} yIndex - The y position (index) of the data face.
+     * @param {[[number,number],[number,number]]} heightFace - The data sample that composes the face4 as a two-dimensional number array.
+     * @param {number} heightValue - The height value of the intersection plane to check for.
+     * @returns {Line|null}
+     */
+    private findHeightFaceIntersectionLines;
+    /**
+     * This function will calculate a single intersecion line of the given face3 data
+     * segment. If the given face does not intersect with the plane at the given `heightValue`
+     * then no segments will be stored.
+     *
+     * @param {number} xIndexA - The x position (index) of the first triangle data point.
+     * @param {number} yIndexA - The y position (index) of the first triangle data point.
+     * @param {[[number,number],[number,number]]} heightFace - The data sample that composes the face4 as a two-dimensional number array.
+     * @param {number} heightValue - The height value of the intersection plane to check for.
+     * @returns {Line|null}
+     */
+    private findHeighteFace3IntersectionLine;
+    /**
+     * This procedure will look at the face4 at the ((x,y),(nextX,nextY)) position – which are four values –
+     * and determines the local contour lines for these cases.
+     *
+     * This is used to detect and calculate edge cases on the borders of the underliying height data:
+     *  * left and right border (x=0, x=data.xSegmentCount)
+     *  * top and bottom border (x=y, x=data.ySegmentCount)
+     *
+     * Resulting path segments will be stored in the global `rawLinearPathSegments` array for further processing.
+     *
+     * @param {number} x
+     * @param {number} y
+     * @param {number} nextX
+     * @param {number} nextY
+     * @param {number} criticalHeightValue
+     * @param {number} closeGapType - CLOSE_GAP_TYPE_ABOVE or CLOSE_GAP_TYPE_BELOW.
+     * @return {void}
+     */
+    detectAboveBelowLerpSegment(x: number, y: number, nextX: number, nextY: number, criticalHeightValue: number, closeGapType: number): void;
+    /**
+     * Checks if both value are on the same side of the critical value (above or below). The `closeGapType`
+     * indictes if `CLOSE_GAP_TYPE_BELOW` or `CLOSE_GAP_TYPE_ABOVE` should be used as a rule.
+     *
+     * @param {number} valueA
+     * @param {number} valueB
+     * @param {number} criticalValue
+     * @param {number} closeGapType
+     * @returns {boolean}
+     */
+    private areBothValuesOnRequiredPlaneSide;
+    /**
+     * Test if a given numeric value (`curValue`) is between the given values `valA` and `valB`.
+     * Value A and B don't need to be in ascending order, so `valA <= curValue <= valB` and `valB <= curvalue <= valA`
+     * will do the job.
+     *
+     * @param {number} valA - The first of the two bounds.
+     * @param {number} valB - The second of the two bounds.
+     * @param {number} curValue - The value to check if it is between (or equal) to the given bounds.
+     * @returns {boolean}
+     */
+    private isBetween;
+    /**
+     * Get a 'lerp' value - which is some sort of percentage/ratio for the `curValue` inside the
+     * range of the given interval `[valA ... valB]`.
+     *
+     * Examples:
+     *  * getLerpRatio(0,100,50) === 0.5
+     *  * getLerpRatio(50,100,75) === 0.5
+     *  * getLerpRatio(0,100,0) === 0.0
+     *  * getLerpRatio(0,100,100) === 1.0
+     *  * getLerpRatio(0,100,-50) === -0.5
+     *
+     * @param {number} valA
+     * @param {number} valB
+     * @param {number} curValue
+     * @returns
+     */
+    private getLerpRatio;
+    /**
+     * Helper function to lerp a numeric value.
+     *
+     * @param {number} min - The min (start) value. Doesn't necesarily need to be the smaller one.
+     * @param {number} max - The max (end) value. Doesn't necesarily need to be the larger one.
+     * @param {number} ratio - The lerp ratio; usually a value between 0.0 and 1.0, but other values a valid for linear interpolation, too.
+     * @returns {number}
+     */
+    private lerp;
+}

package/src/_cjs/utils/algorithms/ContourLineDetection.js

@@ -0,0 +1,367 @@
+"use strict";
+/**
+ * A function to detect contour lines from 3D terrain data.
+ *
+ * For usage see demo `./demos/48-contour-plot`.
+ *
+ * @requires detectPaths
+ * @requires GenericPath
+ * @author   Ikaros Kappler
+ * @date     2023-11-05
+ * @modified 2023-11-20 Addig path detection on a triangle based grid.
+ * @version  1.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContourLineDetection = void 0;
+var Line_1 = require("../../Line");
+var Vertex_1 = require("../../Vertex");
+var detectPaths_1 = require("./detectPaths");
+var clearDuplicateVertices_1 = require("./clearDuplicateVertices");
+var ContourLineDetection = /** @class */ (function () {
+    /**
+     * Creates a new instance for calculating contour lines from the given data grid.
+     * @param {IDataGrid2d<number>} dataGrid - The data grid to use. Must not contain any NaN or null values.
+     * @param {boolean=?} debugMode - (optional) Pass `true` to log warnings on (rare) critical edge cases where the algorithm might fail.
+     */
+    function ContourLineDetection(dataGrid, debugMode) {
+        this.rawLinearPathSegments = [];
+        // Activates/deactivates warning messages on rare edge cases where local path detection fails.
+        this.debugMode = false;
+        this.dataGrid = dataGrid;
+        this.debugMode = Boolean(debugMode);
+    }
+    /**
+     * Detect contour paths from the underlying data source.
+     *
+     * @param {number} criticalHeightValue - The height value. If above data's maximum or below data's minimum then the result will be empty (no intersections).
+     * @param {number} options.closeGapType - `CLOSE_GAP_TYPE_NONE` or `CLOSE_GAP_TYPE_ABOVE` or `CLOSE_GAP_TYPE_BELOW`.
+     * @param {boolean=false} options.useTriangles - If set to true the detection will split each face3 quad into two triangle faces.
+     * @param {pathDetectEpsilon=0.000001} options.pathDetectEpsilon - (optional) The epsilon to tell if two points are located 'in the same place'. Used for connected path detection. If not specified the value `0.0000001` is used.
+     * @param {pointEliminationEpsilon=0.0000001} options.pointEliminationEpsilon - (optional) The epsilon for duplicate point elimination (default is 0.000001).
+     * @param {function?} onRawSegmentsDetected - (optional) Get the interim result of all detected single lines before path detection starts; DO NOT MODIFY the array.
+     * @returns {Array<GenericPath>} - A list of connected paths that resemble the contour lines of the data/terrain at the given height value.
+     */
+    ContourLineDetection.prototype.detectContourPaths = function (criticalHeightValue, options) {
+        var _a, _b;
+        options = options || { closeGapType: ContourLineDetection.CLOSE_GAP_TYPE_NONE };
+        // First: clear the buffer
+        this.rawLinearPathSegments = [];
+        // Imagine a face4 element like this
+        //    (x,y)       (x+1,y)
+        //         A-----B
+        //         |   / |
+        //         | /   |
+        //         D-----C
+        //  (x,y+1)        (x+1,y+1)
+        //	   then result in the buffer will be
+        //   [ [A,B],
+        //     [D,C] ]
+        // Note that the diagonal line (used for triangles) is optional; depends on `options.useTriangles`.
+        var heightFace = [
+            [0, 0],
+            [0, 0]
+        ];
+        for (var y = 0; y + 1 < this.dataGrid.ySegmentCount; y++) {
+            for (var x = 0; x + 1 < this.dataGrid.xSegmentCount; x++) {
+                this.dataGrid.getDataFace4At(x, y, heightFace);
+                this.findHeightFaceIntersectionLines(x, y, heightFace, criticalHeightValue, (_a = options.pointEliminationEpsilon) !== null && _a !== void 0 ? _a : 0.0000001, options.useTriangles);
+            }
+        }
+        // Collect value above/below on the y axis
+        if (options.closeGapType == ContourLineDetection.CLOSE_GAP_TYPE_ABOVE ||
+            options.closeGapType == ContourLineDetection.CLOSE_GAP_TYPE_BELOW) {
+            var xExtremes = [0, this.dataGrid.xSegmentCount - 1];
+            for (var i = 0; i < xExtremes.length; i++) {
+                var x_1 = xExtremes[i];
+                for (var y = 0; y + 1 < this.dataGrid.ySegmentCount; y++) {
+                    var nextX = x_1;
+                    var nextY = y + 1;
+                    this.detectAboveBelowLerpSegment(x_1, y, nextX, nextY, criticalHeightValue, options.closeGapType);
+                }
+            }
+            var yExtremes = [0, this.dataGrid.ySegmentCount - 1];
+            for (var j = 0; j < yExtremes.length; j++) {
+                var y = yExtremes[j];
+                for (var x = 0; x + 1 < this.dataGrid.xSegmentCount; x++) {
+                    var nextX = x + 1;
+                    var nextY = y;
+                    this.detectAboveBelowLerpSegment(x, y, nextX, nextY, criticalHeightValue, options.closeGapType);
+                }
+            }
+        }
+        if (options.onRawSegmentsDetected) {
+            options.onRawSegmentsDetected(this.rawLinearPathSegments);
+        }
+        // Detect connected paths
+        var pathSegments = (0, detectPaths_1.detectPaths)(this.rawLinearPathSegments, (_b = options.pathDetectEpsilon) !== null && _b !== void 0 ? _b : 0.0000001); // Epsilon
+        // Filter out segments with only a single line of length~=0
+        pathSegments = pathSegments.filter(function (pathSegment) {
+            return (pathSegment.segments.length != 1 ||
+                (pathSegment.segments.length === 1 && pathSegment.segments[0].length() > 0.1));
+        });
+        return pathSegments;
+    };
+    /**
+     * This function will calculate a single intersecion line of the given face4 data
+     * segment. If the given face does not intersect with the plane at the given `heightValue`
+     * then no segments will be stored.
+     *
+     * @param {number} xIndex - The x position (index) of the data face.
+     * @param {number} yIndex - The y position (index) of the data face.
+     * @param {[[number,number],[number,number]]} heightFace - The data sample that composes the face4 as a two-dimensional number array.
+     * @param {number} heightValue - The height value of the intersection plane to check for.
+     * @returns {Line|null}
+     */
+    ContourLineDetection.prototype.findHeight4FaceIntersectionLine = function (xIndex, yIndex, heightFace, heightValue, pointEliminationEpsilon) {
+        var heightValueA = heightFace[0][0]; // value at (x,y)
+        var heightValueB = heightFace[1][0];
+        var heightValueC = heightFace[1][1];
+        var heightValueD = heightFace[0][1];
+        if (heightValueA === null || heightValueB === null || heightValueC === null || heightValueD === null) {
+            throw "[findHeightFace4IntersectionLine] Cannot extract data face at (".concat(xIndex, ",").concat(yIndex, "). Some values are null.");
+        }
+        var points = [];
+        // Case A: use full quad face
+        if (this.isBetween(heightValueA, heightValueB, heightValue)) {
+            var lerpValueByHeight = this.getLerpRatio(heightValueA, heightValueB, heightValue);
+            points.push(new Vertex_1.Vertex(this.lerp(xIndex, xIndex + 1, lerpValueByHeight), yIndex));
+        }
+        if (this.isBetween(heightValueB, heightValueC, heightValue)) {
+            var lerpValueByHeight = this.getLerpRatio(heightValueB, heightValueC, heightValue);
+            points.push(new Vertex_1.Vertex(xIndex + 1, this.lerp(yIndex, yIndex + 1, lerpValueByHeight)));
+        }
+        if (this.isBetween(heightValueC, heightValueD, heightValue)) {
+            var lerpValueByHeight = this.getLerpRatio(heightValueC, heightValueD, heightValue);
+            points.push(new Vertex_1.Vertex(this.lerp(xIndex + 1, xIndex, lerpValueByHeight), yIndex + 1));
+        }
+        if (this.isBetween(heightValueD, heightValueA, heightValue)) {
+            var lerpValueByHeight = this.getLerpRatio(heightValueD, heightValueA, heightValue);
+            points.push(new Vertex_1.Vertex(xIndex, this.lerp(yIndex + 1, yIndex, lerpValueByHeight)));
+        }
+        // Warning: if a plane intersection point is located EXACTLY on the corner
+        // edge of a face, then the two adjacent edges will result in 2x the same
+        // intersecion point. This must be handled as one, so filter the point list
+        // by an epsilon.
+        points = (0, clearDuplicateVertices_1.clearDuplicateVertices)(points, pointEliminationEpsilon); // 0.000001);
+        if (points.length >= 2) {
+            var startPoint = points[0];
+            var endPoint = points[1];
+            if (this.debugMode && points.length > 2) {
+                console.warn("[findHeightFace4IntersectionLine] Detected more than 2 points on one face whre only 0 or 2 should appear. At ", xIndex, yIndex, points);
+            }
+            return new Line_1.Line(startPoint, endPoint);
+        }
+        else {
+            if (this.debugMode && points.length === 1) {
+                console.warn("[findHeightFace4IntersectionLine] Point list has only one point (should not happen).");
+            }
+            return null;
+        }
+    };
+    /**
+     * This function will calculate a single intersecion line of the given face4 data
+     * segment. If the given face does not intersect with the plane at the given `heightValue`
+     * then no segments will be stored.
+     *
+     * @param {number} xIndex - The x position (index) of the data face.
+     * @param {number} yIndex - The y position (index) of the data face.
+     * @param {[[number,number],[number,number]]} heightFace - The data sample that composes the face4 as a two-dimensional number array.
+     * @param {number} heightValue - The height value of the intersection plane to check for.
+     * @returns {Line|null}
+     */
+    ContourLineDetection.prototype.findHeightFaceIntersectionLines = function (xIndex, yIndex, heightFace, criticalHeightValue, pointEliminationEpsilon, useTriangles) {
+        // Imagine a face4 element like this
+        //    (x,y)       (x+1,y)
+        //         A-----B
+        //         |   / |
+        //         | /   |
+        //         D-----C
+        //  (x,y+1)        (x+1,y+1)
+        //	   then result in the buffer will be
+        //   [ [A,B],
+        //     [D,C] ]
+        if (useTriangles) {
+            var lineA = this.findHeighteFace3IntersectionLine(xIndex, yIndex, xIndex, yIndex + 1, xIndex + 1, yIndex, [heightFace[0][0], heightFace[0][1], heightFace[1][0]], criticalHeightValue, pointEliminationEpsilon);
+            if (lineA) {
+                this.rawLinearPathSegments.push(lineA);
+            }
+            var lineB = this.findHeighteFace3IntersectionLine(xIndex, yIndex + 1, xIndex + 1, yIndex + 1, xIndex + 1, yIndex, [heightFace[0][1], heightFace[1][1], heightFace[1][0]], criticalHeightValue, pointEliminationEpsilon);
+            if (lineB) {
+                this.rawLinearPathSegments.push(lineB);
+            }
+        }
+        else {
+            var line = this.findHeight4FaceIntersectionLine(xIndex, yIndex, heightFace, criticalHeightValue, pointEliminationEpsilon);
+            if (line) {
+                this.rawLinearPathSegments.push(line);
+            }
+        }
+    };
+    /**
+     * This function will calculate a single intersecion line of the given face3 data
+     * segment. If the given face does not intersect with the plane at the given `heightValue`
+     * then no segments will be stored.
+     *
+     * @param {number} xIndexA - The x position (index) of the first triangle data point.
+     * @param {number} yIndexA - The y position (index) of the first triangle data point.
+     * @param {[[number,number],[number,number]]} heightFace - The data sample that composes the face4 as a two-dimensional number array.
+     * @param {number} heightValue - The height value of the intersection plane to check for.
+     * @returns {Line|null}
+     */
+    ContourLineDetection.prototype.findHeighteFace3IntersectionLine = function (xIndexA, yIndexA, xIndexB, yIndexB, xIndexC, yIndexC, heightFace, heightValue, pointEliminationEpsilon) {
+        var heightValueA = heightFace[0]; // value at (x,y)
+        var heightValueB = heightFace[1];
+        var heightValueC = heightFace[2];
+        if (heightValueA === null || heightValueB === null || heightValueC === null) {
+            throw "[findHeightFace3IntersectionLine] Cannot extract data face at (".concat(xIndexA, ",").concat(yIndexA, "). Some values are null.");
+        }
+        var points = [];
+        // Case A: use full quad face
+        if (this.isBetween(heightValueA, heightValueB, heightValue)) {
+            var lerpValueByHeight = this.getLerpRatio(heightValueA, heightValueB, heightValue);
+            points.push(new Vertex_1.Vertex(this.lerp(xIndexA, xIndexB, lerpValueByHeight), this.lerp(yIndexA, yIndexB, lerpValueByHeight)));
+        }
+        if (this.isBetween(heightValueB, heightValueC, heightValue)) {
+            var lerpValueByHeight = this.getLerpRatio(heightValueB, heightValueC, heightValue);
+            // points.push(new Vertex(xIndex + 1, this.lerp(yIndex, yIndex + 1, lerpValueByHeight)));
+            points.push(new Vertex_1.Vertex(this.lerp(xIndexB, xIndexC, lerpValueByHeight), this.lerp(yIndexB, yIndexC, lerpValueByHeight)));
+        }
+        if (this.isBetween(heightValueC, heightValueA, heightValue)) {
+            var lerpValueByHeight = this.getLerpRatio(heightValueC, heightValueA, heightValue);
+            // points.push(new Vertex(this.lerp(xIndex + 1, xIndex, lerpValueByHeight), yIndex + 1));
+            points.push(new Vertex_1.Vertex(this.lerp(xIndexC, xIndexA, lerpValueByHeight), this.lerp(yIndexC, yIndexA, lerpValueByHeight)));
+        }
+        // Warning: if a plane intersection point is located EXACTLY on the corner
+        // edge of a face, then the two adjacent edges will result in 2x the same
+        // intersecion point. This must be handled as one, so filter the point list
+        // by an epsilon.
+        points = (0, clearDuplicateVertices_1.clearDuplicateVertices)(points, pointEliminationEpsilon); // 0.0000001);
+        if (points.length >= 2) {
+            var startPoint = points[0];
+            var endPoint = points[1];
+            if (this.debugMode && points.length > 2) {
+                console.warn("[findHeightFace3IntersectionLine] Detected more than 2 points on one face whre only 0 or 2 should appear. At ", xIndexA, yIndexA, points);
+            }
+            return new Line_1.Line(startPoint, endPoint);
+        }
+        else {
+            if (this.debugMode && points.length === 1) {
+                console.warn("[findHeightFace3IntersectionLine] Point list has only one point (should not happen).");
+            }
+            return null;
+        }
+    };
+    /**
+     * This procedure will look at the face4 at the ((x,y),(nextX,nextY)) position – which are four values –
+     * and determines the local contour lines for these cases.
+     *
+     * This is used to detect and calculate edge cases on the borders of the underliying height data:
+     *  * left and right border (x=0, x=data.xSegmentCount)
+     *  * top and bottom border (x=y, x=data.ySegmentCount)
+     *
+     * Resulting path segments will be stored in the global `rawLinearPathSegments` array for further processing.
+     *
+     * @param {number} x
+     * @param {number} y
+     * @param {number} nextX
+     * @param {number} nextY
+     * @param {number} criticalHeightValue
+     * @param {number} closeGapType - CLOSE_GAP_TYPE_ABOVE or CLOSE_GAP_TYPE_BELOW.
+     * @return {void}
+     */
+    ContourLineDetection.prototype.detectAboveBelowLerpSegment = function (x, y, nextX, nextY, criticalHeightValue, closeGapType) {
+        var heightValueA = this.dataGrid.getDataValueAt(x, y);
+        var heightValueB = this.dataGrid.getDataValueAt(nextX, nextY);
+        //   if (heightValueA >= criticalHeightValue && heightValueB >= criticalHeightValue) {
+        if (this.areBothValuesOnRequiredPlaneSide(heightValueA, heightValueB, criticalHeightValue, closeGapType)) {
+            //  Both above
+            var line = new Line_1.Line(new Vertex_1.Vertex(x, y), new Vertex_1.Vertex(nextX, nextY));
+            this.rawLinearPathSegments.push(line);
+        }
+        else if ((closeGapType == ContourLineDetection.CLOSE_GAP_TYPE_ABOVE &&
+            heightValueA >= criticalHeightValue &&
+            heightValueB <= criticalHeightValue) ||
+            (closeGapType == ContourLineDetection.CLOSE_GAP_TYPE_BELOW &&
+                heightValueA <= criticalHeightValue &&
+                heightValueB >= criticalHeightValue)) {
+            // Only one of both (first) is above -> interpolate to find exact intersection point
+            var lerpValueByHeight = this.getLerpRatio(heightValueA, heightValueB, criticalHeightValue);
+            var interpLine = new Line_1.Line(new Vertex_1.Vertex(x, y), new Vertex_1.Vertex(this.lerp(x, nextX, lerpValueByHeight), this.lerp(y, nextY, lerpValueByHeight)));
+            this.rawLinearPathSegments.push(interpLine);
+        }
+        else if ((closeGapType == ContourLineDetection.CLOSE_GAP_TYPE_ABOVE &&
+            heightValueA <= criticalHeightValue &&
+            heightValueB >= criticalHeightValue) ||
+            (closeGapType == ContourLineDetection.CLOSE_GAP_TYPE_BELOW &&
+                heightValueA >= criticalHeightValue &&
+                heightValueB <= criticalHeightValue)) {
+            // Only one of both (second) is above -> interpolate to find exact intersection point
+            var lerpValueByHeight = this.getLerpRatio(heightValueA, heightValueB, criticalHeightValue);
+            var interpLine = new Line_1.Line(new Vertex_1.Vertex(this.lerp(x, nextX, lerpValueByHeight), this.lerp(y, nextY, lerpValueByHeight)), new Vertex_1.Vertex(nextX, nextY));
+            this.rawLinearPathSegments.push(interpLine);
+        }
+    };
+    /**
+     * Checks if both value are on the same side of the critical value (above or below). The `closeGapType`
+     * indictes if `CLOSE_GAP_TYPE_BELOW` or `CLOSE_GAP_TYPE_ABOVE` should be used as a rule.
+     *
+     * @param {number} valueA
+     * @param {number} valueB
+     * @param {number} criticalValue
+     * @param {number} closeGapType
+     * @returns {boolean}
+     */
+    ContourLineDetection.prototype.areBothValuesOnRequiredPlaneSide = function (valueA, valueB, criticalValue, closeGapType) {
+        return ((closeGapType == ContourLineDetection.CLOSE_GAP_TYPE_BELOW && valueA <= criticalValue && valueB <= criticalValue) ||
+            (closeGapType == ContourLineDetection.CLOSE_GAP_TYPE_ABOVE && valueA >= criticalValue && valueB >= criticalValue));
+    };
+    /**
+     * Test if a given numeric value (`curValue`) is between the given values `valA` and `valB`.
+     * Value A and B don't need to be in ascending order, so `valA <= curValue <= valB` and `valB <= curvalue <= valA`
+     * will do the job.
+     *
+     * @param {number} valA - The first of the two bounds.
+     * @param {number} valB - The second of the two bounds.
+     * @param {number} curValue - The value to check if it is between (or equal) to the given bounds.
+     * @returns {boolean}
+     */
+    ContourLineDetection.prototype.isBetween = function (valA, valB, curValue) {
+        return (valA <= curValue && curValue <= valB) || (valB <= curValue && curValue <= valA);
+    };
+    /**
+     * Get a 'lerp' value - which is some sort of percentage/ratio for the `curValue` inside the
+     * range of the given interval `[valA ... valB]`.
+     *
+     * Examples:
+     *  * getLerpRatio(0,100,50) === 0.5
+     *  * getLerpRatio(50,100,75) === 0.5
+     *  * getLerpRatio(0,100,0) === 0.0
+     *  * getLerpRatio(0,100,100) === 1.0
+     *  * getLerpRatio(0,100,-50) === -0.5
+     *
+     * @param {number} valA
+     * @param {number} valB
+     * @param {number} curValue
+     * @returns
+     */
+    ContourLineDetection.prototype.getLerpRatio = function (valA, valB, curValue) {
+        return (curValue - valA) / (valB - valA);
+    };
+    /**
+     * Helper function to lerp a numeric value.
+     *
+     * @param {number} min - The min (start) value. Doesn't necesarily need to be the smaller one.
+     * @param {number} max - The max (end) value. Doesn't necesarily need to be the larger one.
+     * @param {number} ratio - The lerp ratio; usually a value between 0.0 and 1.0, but other values a valid for linear interpolation, too.
+     * @returns {number}
+     */
+    ContourLineDetection.prototype.lerp = function (min, max, ratio) {
+        return min + (max - min) * ratio;
+    };
+    ContourLineDetection.CLOSE_GAP_TYPE_NONE = 0;
+    ContourLineDetection.CLOSE_GAP_TYPE_ABOVE = 1;
+    ContourLineDetection.CLOSE_GAP_TYPE_BELOW = 2;
+    return ContourLineDetection;
+}());
+exports.ContourLineDetection = ContourLineDetection;
+//# sourceMappingURL=ContourLineDetection.js.map

package/src/_cjs/utils/algorithms/ContourLineDetection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContourLineDetection.js","sourceRoot":"","sources":["../../../ts/utils/algorithms/ContourLineDetection.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AAEH,mCAAkC;AAClC,uCAAsC;AAEtC,6CAA4C;AAC5C,mEAAkE;AAQlE;IAYE;;;;OAIG;IACH,8BAAY,QAA6B,EAAE,SAAmB;QAdtD,0BAAqB,GAAgB,EAAE,CAAC;QAMhD,8FAA8F;QACvF,cAAS,GAAY,KAAK,CAAC;QAQhC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;OAUG;IACH,iDAAkB,GAAlB,UACE,mBAA2B,EAC3B,OAMC;;QAED,OAAO,GAAG,OAAO,IAAI,EAAE,YAAY,EAAE,oBAAoB,CAAC,mBAAmB,EAAE,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAC;QAEhC,oCAAoC;QACpC,yBAAyB;QACzB,kBAAkB;QAClB,kBAAkB;QAClB,kBAAkB;QAClB,kBAAkB;QAClB,4BAA4B;QAC5B,uCAAuC;QACvC,aAAa;QACb,cAAc;QACd,mGAAmG;QACnG,IAAM,UAAU,GAA0B;YACxC,CAAC,CAAC,EAAE,CAAC,CAAC;YACN,CAAC,CAAC,EAAE,CAAC,CAAC;SACP,CAAC;QACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;YACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzD,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;gBAC/C,IAAI,CAAC,+BAA+B,CAClC,CAAC,EACD,CAAC,EACD,UAAU,EACV,mBAAmB,EACnB,MAAA,OAAO,CAAC,uBAAuB,mCAAI,SAAS,EAC5C,OAAO,CAAC,YAAY,CACrB,CAAC;YACJ,CAAC;QACH,CAAC;QAED,0CAA0C;QAC1C,IACE,OAAO,CAAC,YAAY,IAAI,oBAAoB,CAAC,oBAAoB;YACjE,OAAO,CAAC,YAAY,IAAI,oBAAoB,CAAC,oBAAoB,EACjE,CAAC;YACD,IAAM,SAAS,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;YACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,IAAM,GAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;oBACzD,IAAM,KAAK,GAAG,GAAC,CAAC;oBAChB,IAAM,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;oBACpB,IAAI,CAAC,2BAA2B,CAAC,GAAC,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;gBAClG,CAAC;YACH,CAAC;YACD,IAAM,SAAS,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;YACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;oBACzD,IAAM,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;oBACpB,IAAM,KAAK,GAAG,CAAC,CAAC;oBAChB,IAAI,CAAC,2BAA2B,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;gBAClG,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAClC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC5D,CAAC;QAED,yBAAyB;QACzB,IAAI,YAAY,GAAuB,IAAA,yBAAW,EAAC,IAAI,CAAC,qBAAqB,EAAE,MAAA,OAAO,CAAC,iBAAiB,mCAAI,SAAS,CAAC,CAAC,CAAC,UAAU;QAClI,2DAA2D;QAC3D,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,UAAU,WAAW;YACtD,OAAO,CACL,WAAW,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC;gBAChC,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAK,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAU,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CACxF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACK,8DAA+B,GAAvC,UACE,MAAc,EACd,MAAc,EACd,UAAiC,EACjC,WAAmB,EACnB,uBAA+B;QAE/B,IAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB;QACxD,IAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,IAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,IAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEtC,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YACrG,MAAM,yEAAkE,MAAM,cAAI,MAAM,6BAA0B,CAAC;QACrH,CAAC;QAED,IAAI,MAAM,GAAkB,EAAE,CAAC;QAE/B,6BAA6B;QAC7B,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;YAC5D,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACrF,MAAM,CAAC,IAAI,CAAC,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QACpF,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;YAC5D,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACrF,MAAM,CAAC,IAAI,CAAC,IAAI,eAAM,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;QACxF,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;YAC5D,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACrF,MAAM,CAAC,IAAI,CAAC,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QACxF,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;YAC5D,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACrF,MAAM,CAAC,IAAI,CAAC,IAAI,eAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;QACpF,CAAC;QAED,0EAA0E;QAC1E,yEAAyE;QACzE,2EAA2E;QAC3E,iBAAiB;QACjB,MAAM,GAAG,IAAA,+CAAsB,EAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,aAAa;QAE/E,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACvB,IAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,OAAO,CAAC,IAAI,CACV,+GAA+G,EAC/G,MAAM,EACN,MAAM,EACN,MAAM,CACP,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,WAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC1C,OAAO,CAAC,IAAI,CAAC,sFAAsF,CAAC,CAAC;YACvG,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACK,8DAA+B,GAAvC,UACE,MAAc,EACd,MAAc,EACd,UAAiC,EACjC,mBAA2B,EAC3B,uBAA+B,EAC/B,YAAsB;QAEtB,oCAAoC;QACpC,yBAAyB;QACzB,kBAAkB;QAClB,kBAAkB;QAClB,kBAAkB;QAClB,kBAAkB;QAClB,4BAA4B;QAC5B,uCAAuC;QACvC,aAAa;QACb,cAAc;QACd,IAAI,YAAY,EAAE,CAAC;YACjB,IAAM,KAAK,GAAG,IAAI,CAAC,gCAAgC,CACjD,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,GAAG,CAAC,EACV,MAAM,GAAG,CAAC,EACV,MAAM,EACN,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACtD,mBAAmB,EACnB,uBAAuB,CACxB,CAAC;YACF,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC;YACD,IAAM,KAAK,GAAG,IAAI,CAAC,gCAAgC,CACjD,MAAM,EACN,MAAM,GAAG,CAAC,EACV,MAAM,GAAG,CAAC,EACV,MAAM,GAAG,CAAC,EACV,MAAM,GAAG,CAAC,EACV,MAAM,EACN,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACtD,mBAAmB,EACnB,uBAAuB,CACxB,CAAC;YACF,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAM,IAAI,GAAG,IAAI,CAAC,+BAA+B,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,uBAAuB,CAAC,CAAC;YAC5H,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACK,+DAAgC,GAAxC,UACE,OAAe,EACf,OAAe,EACf,OAAe,EACf,OAAe,EACf,OAAe,EACf,OAAe,EACf,UAAiC,EACjC,WAAmB,EACnB,uBAA+B;QAE/B,IAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB;QACrD,IAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QACnC,IAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAEnC,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YAC5E,MAAM,yEAAkE,OAAO,cAAI,OAAO,6BAA0B,CAAC;QACvH,CAAC;QAED,IAAI,MAAM,GAAkB,EAAE,CAAC;QAE/B,6BAA6B;QAC7B,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;YAC5D,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACrF,MAAM,CAAC,IAAI,CAAC,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAC1H,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;YAC5D,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACrF,yFAAyF;YACzF,MAAM,CAAC,IAAI,CAAC,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAC1H,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;YAC5D,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACrF,yFAAyF;YACzF,MAAM,CAAC,IAAI,CAAC,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAC1H,CAAC;QAED,0EAA0E;QAC1E,yEAAyE;QACzE,2EAA2E;QAC3E,iBAAiB;QACjB,MAAM,GAAG,IAAA,+CAAsB,EAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,CAAC,cAAc;QAEhF,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACvB,IAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,OAAO,CAAC,IAAI,CACV,+GAA+G,EAC/G,OAAO,EACP,OAAO,EACP,MAAM,CACP,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,WAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC1C,OAAO,CAAC,IAAI,CAAC,sFAAsF,CAAC,CAAC;YACvG,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,0DAA2B,GAA3B,UACE,CAAS,EACT,CAAS,EACT,KAAa,EACb,KAAa,EACb,mBAA2B,EAC3B,YAAoB;QAEpB,IAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxD,IAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAChE,sFAAsF;QACtF,IAAI,IAAI,CAAC,gCAAgC,CAAC,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,CAAC,EAAE,CAAC;YACzG,cAAc;YACd,IAAM,IAAI,GAAG,IAAI,WAAI,CAAC,IAAI,eAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,eAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YAClE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;aAAM,IACL,CAAC,YAAY,IAAI,oBAAoB,CAAC,oBAAoB;YACxD,YAAY,IAAI,mBAAmB;YACnC,YAAY,IAAI,mBAAmB,CAAC;YACtC,CAAC,YAAY,IAAI,oBAAoB,CAAC,oBAAoB;gBACxD,YAAY,IAAI,mBAAmB;gBACnC,YAAY,IAAI,mBAAmB,CAAC,EACtC,CAAC;YACD,oFAAoF;YACpF,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC;YAC7F,IAAM,UAAU,GAAG,IAAI,WAAI,CACzB,IAAI,eAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAChB,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAC3F,CAAC;YACF,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,CAAC;aAAM,IACL,CAAC,YAAY,IAAI,oBAAoB,CAAC,oBAAoB;YACxD,YAAY,IAAI,mBAAmB;YACnC,YAAY,IAAI,mBAAmB,CAAC;YACtC,CAAC,YAAY,IAAI,oBAAoB,CAAC,oBAAoB;gBACxD,YAAY,IAAI,mBAAmB;gBACnC,YAAY,IAAI,mBAAmB,CAAC,EACtC,CAAC;YACD,qFAAqF;YACrF,IAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC;YAC7F,IAAM,UAAU,GAAG,IAAI,WAAI,CACzB,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC,EAC1F,IAAI,eAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CACzB,CAAC;YACF,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACK,+DAAgC,GAAxC,UAAyC,MAAc,EAAE,MAAc,EAAE,aAAqB,EAAE,YAAoB;QAClH,OAAO,CACL,CAAC,YAAY,IAAI,oBAAoB,CAAC,oBAAoB,IAAI,MAAM,IAAI,aAAa,IAAI,MAAM,IAAI,aAAa,CAAC;YACjH,CAAC,YAAY,IAAI,oBAAoB,CAAC,oBAAoB,IAAI,MAAM,IAAI,aAAa,IAAI,MAAM,IAAI,aAAa,CAAC,CAClH,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACK,wCAAS,GAAjB,UAAkB,IAAY,EAAE,IAAY,EAAE,QAAgB;QAC5D,OAAO,CAAC,IAAI,IAAI,QAAQ,IAAI,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,QAAQ,IAAI,QAAQ,IAAI,IAAI,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACK,2CAAY,GAApB,UAAqB,IAAY,EAAE,IAAY,EAAE,QAAgB;QAC/D,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;OAOG;IACK,mCAAI,GAAZ,UAAa,GAAW,EAAE,GAAW,EAAE,KAAa;QAClD,OAAO,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC;IACnC,CAAC;IArcM,wCAAmB,GAAG,CAAC,AAAJ,CAAK;IACxB,yCAAoB,GAAG,CAAC,AAAJ,CAAK;IACzB,yCAAoB,GAAG,CAAC,AAAJ,CAAK;IAoclC,2BAAC;CAAA,AA3cD,IA2cC;AA3cY,oDAAoB"}

package/src/_cjs/utils/algorithms/CubicSplinePath.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @author   Ikaros Kappler (ported from basic script to class).
+ * @date     2020-04-15
+ * @modified 2020-08-19 Ported this class from vanilla JS to TypeScript.
+ * @version  1.0.0
+ *
+ * @file CubicSplinePath
+ * @public
+ **/
+import { CubicBezierCurve } from "../../CubicBezierCurve";
+import { Vertex } from "../../Vertex";
+interface IControlCoords {
+    start: Array<number>;
+    end: Array<number>;
+}
+/**
+ * @classdesc Compute a natural cubic Bézier spline path from a given sequence of points/vertices.
+ *
+ * Inspired by http://weitz.de/hobby/
+ *
+ * @requires CubicBezierCurve
+ * @requires HobbyPath
+ * @requires Vertex
+ */
+export declare class CubicSplinePath {
+    /**
+     * @member {Array<Vertex>} vertices
+     * @memberof CatmullRomPath
+     * @type {Array<Vertex>}
+     * @instance
+     **/
+    private vertices;
+    /**
+     * @constructor
+     * @name CubicSplinePath
+     * @param {Array<Vertex>=} vertices? - An optional array of vertices to initialize the path with.
+     **/
+    constructor(vertices?: Array<Vertex>);
+    /**
+    * Add a new point to the end of the vertex sequence.
+    *
+    * @name addPoint
+    * @memberof CubicSplinePath
+    * @instance
+    * @param {Vertex} p - The vertex (point) to add.
+    **/
+    addPoint(p: Vertex): void;
+    /**
+     * Generate a sequence of cubic Bézier curves from the point set.
+     *
+     * @name generateCurve
+     * @memberof CubicSplinePath
+     * @instance
+     * @param {boolean=} circular - Specify if the path should be closed.
+     * @return Array<CubicBezierCurve>
+     **/
+    generateCurve(circular?: boolean): Array<CubicBezierCurve>;
+    static utils: {
+        naturalControlsClosed: (coords: Array<number>) => IControlCoords;
+        naturalControlsOpen: (coords: Array<number>) => IControlCoords;
+    };
+}
+export {};