flo-mat 3.0.14 → 4.0.1

package/src/find-mat/mat-options.ts

@@ -9,7 +9,7 @@ interface MatOptions {
      * * Defaults to `0.05`.
      * * The value is clipped in the range `[0.01,3]`.
      */
-    maxCurviness?: number;
+    readonly maxCurviness?: number;
 
     /**
      * The maximum length a curve can have before an additional MAT 
@@ -21,7 +21,7 @@ interface MatOptions {
      * * Defaults to `40`.
      * * The value is clipped in `[1,1024]`.
      */
-    maxLength?: number;
+    readonly maxLength?: number;
 
     /**
      * If `true` then `toScaleAxis` will be applied to the MAT (and before
@@ -29,7 +29,7 @@ interface MatOptions {
      * 
      * * Defaults to `true`
      */
-    applySat?: boolean;
+    readonly applySat?: boolean;
 
     /**
      * The higher this value, the more aggresively the
@@ -37,10 +37,10 @@ interface MatOptions {
      * 
      * * Only applies if `applySat` is `true`
      * * Defaults to 2
-     * * The value is clipped in `[1,Number.POSITIVE_INFINITY]`
+     * * The value is clipped in `[1,Infinity]`
      * * Should be larger than one to have an effect
      */
-    satScale?: number;
+    readonly satScale?: number;
 
     /**
      * If `true` then the `simplyfiMats` will be applied which will replace
@@ -50,7 +50,7 @@ interface MatOptions {
      * 
      * * Defaults to `true`
      */
-    simplify?: boolean;
+    readonly simplify?: boolean;
 
     /**
      * The tolerance, given as the Hausdorff distance between curves, to
@@ -65,7 +65,7 @@ interface MatOptions {
      * 512x400 then the accuracy is scaled to `1/2` a pixel. This ensures
      * scale invariance on the accuracy.
      */
-    simplifyTolerance?: number;
+    readonly simplifyTolerance?: number;
 
     /**
      * Minimum bezier length before no `CpNode` will attach to it.
@@ -74,7 +74,7 @@ interface MatOptions {
      * * scaled to a 1024x1024 vector image size
      * * Defaults to `1/16`
      */
-    minBezLength?: number;
+    readonly minBezLength?: number;
 
     /**
      * Angle (in degrees) increments around sharp obtuse corners. The lower the
@@ -82,7 +82,7 @@ interface MatOptions {
      * 
      * * Defaults to `15`
      */
-    angleIncrement?: number;
+    readonly angleIncrement?: number;
 
     /**
      * If `true` then 2-prongs will be inserted apatively according to the
@@ -106,25 +106,27 @@ const defaultMatOptions: Required<MatOptions> = {
 
 
 type MatOptionMeta = {
-    range: [number,number],
-    scaleByMaxCoordinate?: boolean | undefined,
-    scaleByMaxRadius?: boolean | undefined
+    readonly range: [number,number],
+    readonly scaleByMaxCoordinate: boolean,
 }
 
 
-const matOptionRanges: Partial<{ [K in keyof MatOptions]: MatOptionMeta }> = {
+const matOptionRanges: Omit<Required<{ [K in keyof MatOptions]: MatOptionMeta }>, 'applySat' | 'simplify'> = {
     maxCurviness: {
-        range: [0.01,3]
+        range: [0.01,3],
+        scaleByMaxCoordinate: false
     },
     maxLength: {
         range: [1,1024],
-        scaleByMaxRadius: true
+        scaleByMaxCoordinate: true
     },
     angleIncrement: {
-        range: [0.1, 360]
+        range: [0.1, 360],
+        scaleByMaxCoordinate: false
     },
     satScale: {
-        range: [1, Number.POSITIVE_INFINITY],
+        range: [1, Infinity],
+        scaleByMaxCoordinate: false
     },
     simplifyTolerance: {
         range: [2**-20,2**20],
@@ -134,7 +136,8 @@ const matOptionRanges: Partial<{ [K in keyof MatOptions]: MatOptionMeta }> = {
         range: [2**-20,2],
         scaleByMaxCoordinate: true
     }
-}
+};
 
 
-export { MatOptions, MatOptionMeta, defaultMatOptions, matOptionRanges }
+export type { MatOptions, MatOptionMeta }
+export { defaultMatOptions, matOptionRanges }

package/src/floyd-warshall/floyd-warshall.ts

@@ -72,7 +72,7 @@ export { floydWarshall }
 //           3
 
 
-// const INF = Number.POSITIVE_INFINITY;
+// const INF = Infinity;
 // const graph = [
 //     [0, 5, INF, 10],
 //     [INF, 0, 3, INF],

package/src/floyd-warshall/get-graph.ts

@@ -26,7 +26,7 @@ function getGraph(
                 continue;
             }
 
-            let minD = Number.POSITIVE_INFINITY;
+            let minD = Infinity;
             for (const toChild of getAllOnCircle(cpNodeA)) {
                 let d = getMatDistanceToNext$(toChild);
                 let child = toChild.next;
@@ -41,7 +41,7 @@ function getGraph(
                     }
                     if (isVertexSpecial(child)) {
                         // we only find the immediate next special ones
-                        d = Number.POSITIVE_INFINITY;
+                        d = Infinity;
                         break;  // Next special vertex found but it's not B
                     }
 

package/src/floyd-warshall/get-hole-closer-pairs.ts

@@ -6,8 +6,8 @@ import type { CpNode } from "../cp-node/cp-node.js";
  * @param holeClosers 
  * @returns 
  */
-// TODO - this function is currently O(n^2) but could be made O(n).
-// TODO - only `pointOnShape.p` is checked but `pointOnShape.t` should also be checked
+// FUTURE - this function is currently O(n^2) but could be made O(n).
+// FUTURE - only `pointOnShape.p` is checked but `pointOnShape.t` should also be checked
 // or better yet, `CpNode.cp.order` and `CpNode.cp.order2`, etc.
 function getHoleCloserPairs(
         holeClosers: CpNode[]): Map<CpNode,CpNode> {
@@ -15,10 +15,10 @@ function getHoleCloserPairs(
     const pairs: Map<CpNode,CpNode> = new Map();
     for (let hcA of holeClosers) {
         for (let hcB of holeClosers) {
-            const cA = hcA.cp.circle.center;
-            const cB = hcB.cp.circle.center;
-            const cpA = hcA.cp.pointOnShape.p;
-            const cpB = hcB.cp.pointOnShape.p;
+            const cA = hcA.pointOnShape!.circle!.center;
+            const cB = hcB.pointOnShape!.circle!.center;
+            const cpA = hcA.pointOnShape!.p;
+            const cpB = hcB.pointOnShape!.p;
             if (hcB !== hcA &&
                 cA[0] === cB[0] && cA[1] === cB[1] &&
                 cpA[0] === cpB[0] && cpA[1] === cpB[1]) {

package/src/geometry/circle.ts

@@ -5,8 +5,8 @@ import { squaredDistanceBetween } from 'flo-vector2d';
  * Canonical circle representation.
  */
 interface Circle {
-    center: number[];
-    radius: number;
+    readonly center: number[];
+    readonly radius: number;
 }
 
 
@@ -22,6 +22,7 @@ function scaleCircle(circle: Circle, s: number): Circle {
 
 /**
  * Returns true if the first circle engulfs the second.
+ * 
  * @param c1 
  * @param c2 
  */
@@ -29,7 +30,7 @@ function engulfsCircle(c1: Circle, c2: Circle) {
     if (c1.radius <= c2.radius) { 
         return false; 
     }
-    
+
     const d = squaredDistanceBetween(c1.center, c2.center);
     const dr = c1.radius - c2.radius; 
     const δ = dr*dr;
@@ -38,12 +39,5 @@ function engulfsCircle(c1: Circle, c2: Circle) {
 }
 
 
-/**
- * Returns a human-readable string description of the given circle.
- * @param circle
- */
-function toString(circle: Circle): string {
-    return 'c: ' + circle.center + ' r: ' + circle.radius;
-}
-
-export { Circle, scaleCircle, engulfsCircle }
+export type { Circle }
+export { scaleCircle, engulfsCircle }

package/src/geometry/get-closest-square-distance-to-rect.ts

@@ -1,6 +1,4 @@
-import { squaredDistanceBetween as squaredDistanceBetween_ } from 'flo-vector2d';
-
-const squaredDistanceBetween = squaredDistanceBetween_;
+import { squaredDistanceBetween } from 'flo-vector2d';
 
 
 /**
@@ -14,13 +12,10 @@ function getClosestSquareDistanceToRect(
     const x0 = p0[0];
     const y0 = p0[1];
     const x1 = p1[0];
-    const y1 = p1[1];    
+    const y1 = p1[1];
     const xp = p[0];
     const yp = p[1];
 
-    //let [[x0,y0],[x1,y1]] = box;
-    //let [xp,yp] = p;
-    
     if (xp < x0) {
         if (yp < y0) {
             return squaredDistanceBetween(box[0], p);
@@ -43,7 +38,7 @@ function getClosestSquareDistanceToRect(
         } else if (yp > y1) {
             return (yp - y1)**2;
         } 
-            
+
         return 0;
     }
 }

package/src/geometry/get-closest-squared-distance-to-rotated-rect.ts

@@ -7,10 +7,11 @@ import {
  * @internal
  */
 function getClosestSquaredDistanceToRotatedRect(ps: number[][], p: number[]) {
-    const ds = [0,1,2,3].map(i => squaredDistanceBetweenPointAndLineSegment(
+    const ds = [0,1,2,3]
+    .map(i => squaredDistanceBetweenPointAndLineSegment(
             p, 
             [ps[i], ps[(i + 1) % 4]]
-        )                
+        )
     );
     
     const width  = squaredDistanceBetween(ps[0], ps[1]);

package/src/index.ts

@@ -1,17 +1,13 @@
-
+export type { Curve, Loop } from 'flo-boolean';
 export { loopFromBeziers, beziersToSvgPathStr, getPathsFromStr } from 'flo-boolean';
 
 export type { MatMeta } from './mat/mat-meta.js';
-export type { Loop } from 'flo-boolean';    
 export type { Mat } from './mat/mat.js';
-export type { Curve } from './curve/curve.js';
 export type { CpNode  } from './cp-node/cp-node.js';
 export type { PointOnShape } from './point-on-shape/point-on-shape.js';
 export type { Circle } from './geometry/circle.js';
-export type { ContactPoint } from './contact-point/contact-point.js';
 export type { CurvePiece } from './mat/curve-piece.js';
 export type { DrawElemFunctions } from './debug/functions/draw-elem/draw-elem.js';
-export type { ICpNodeForDebugging } from './debug/cp-node-for-debugging.js';
 export type { ITiming } from './debug/debug.js';
 export type { DebugElems } from './debug/debug-elem-types.js';
 export type { Debug } from './debug/debug.js';
@@ -22,7 +18,6 @@ export { drawBeziersAsSinglePath } from './debug/functions/draw/draw-beziers-as-
 export { floydWarshall } from './floyd-warshall/floyd-warshall.js';
 export { CpNodeFs } from './cp-node/cp-node-fs.js';
 export { isVertexSpecial } from './cp-node/fs/is-vertex-special.js';
-export { createPos } from './point-on-shape/create-pos.js';
 export { findMats } from './find-mat/find-mats.js';
 export { trimMat } from './mat/trim-mat.js';
 export { toScaleAxis } from './sat/to-scale-axis.js';
@@ -37,8 +32,6 @@ export { simplifyMat } from './mat/simplify-mat.js';
 export { drawElemFs, drawElemFsDetailed } from './debug/functions/draw-elem/draw-elem.js';
 export { sweepLine } from './sweep-line/sweep-line.js';
 export { getClosestSquareDistanceToRect } from './geometry/get-closest-square-distance-to-rect.js';
-export { connectHoleClosers } from './mat/connect-hole-closers.js';
-export { findAndAdd2Prong } from './find-2-prong/find-and-add-2-prong.js';
 export { getImpliedBoundaryBezierBetween } from './cp-node/fs/get-implied-boundary-bezier-between.js';
 export { getSatCulls } from './sat/get-sat-culls.js';
 export { getGraph } from './floyd-warshall/get-graph.js';
@@ -84,7 +77,6 @@ export { getEdgeDirection } from './cp-node/fs/get-edge-direction.js';
 export { getBoundaryBeziersBetween } from './cp-node/fs/get-boundary-beziers-between.js';
 export { getMatCurvesBetween } from './cp-node/fs/get-mat-curves-between.js';
 export { getHoleClosers } from './cp-node/fs/get-hole-closers.js';
-export { getSpeed } from './cp-node/fs/get-speed.js';
-export { getSmoothedSpeed$ } from './cp-node/fs/get-smoothed-speed.js';
 export { getInitialDegAngleBetweenMatCurves } from './cp-node/fs/get-angle-between-mat-curves.js';
-export { getAllVertices } from './cp-node/fs/get-all-vertices.js';
+export { getAllVertices } from './cp-node/fs/get-all-vertices.js';
+export { isTrivial } from './cp-node/fs/is-trivial.js';

package/src/loop/get-max-coordinate.ts

@@ -1,5 +1,4 @@
-const max = Math.max;
-const abs = Math.abs;
+const { max, abs } = Math;
 
 
 /**
@@ -9,13 +8,14 @@ const abs = Math.abs;
  */
 function getLoopsMetrics(loops: number[][][][]): { 
         maxCoordinate: number,
-        maxRadius: number } {
+        width: number,
+        height: number } {
 
     let maxCoordinate = 0;
-    let minX = Number.POSITIVE_INFINITY;
-    let maxX = Number.NEGATIVE_INFINITY;
-    let minY = Number.POSITIVE_INFINITY;
-    let maxY = Number.NEGATIVE_INFINITY;
+    let minX = +Infinity;
+    let maxX = -Infinity;
+    let minY = +Infinity;
+    let maxY = -Infinity;
 
     for (const loop of loops) { for (const ps of loop) { for (const p of ps) {
         const x = p[0];
@@ -30,9 +30,8 @@ function getLoopsMetrics(loops: number[][][][]): {
 
     const width  = maxX - minX;
     const height = maxY - minY;
-    const maxRadius = max(width, height);
 
-    return { maxCoordinate, maxRadius };
+    return { maxCoordinate, width, height };
 }
 
 

package/src/mat/add-to-cp-tree.ts

@@ -1,8 +1,7 @@
-import type  { Circle } from '../geometry/circle.js';
-import type  { ContactPoint } from '../contact-point/contact-point.js';
-import type  { PointOnShape } from '../point-on-shape/point-on-shape.js';
-import type  { CpNode } from '../cp-node/cp-node.js';
-import type { MatMeta } from '../index.js';
+import type { Circle } from '../geometry/circle.js';
+import type { PointOnShape, PrePointOnShape } from '../point-on-shape/point-on-shape.js';
+import type { CpNode } from '../cp-node/cp-node.js';
+import type { MatMeta } from '../mat/mat-meta.js';
 import { getCpNodeToLeftOrSame } from './get-cp-node-to-left-or-same.js';
 import { insertCpNode } from '../cp-node/fs/insert-cp-node.js';
 import { joinSpokes } from '../add-n-prong.ts/join-spokes.js';
@@ -23,19 +22,19 @@ function addToCpTree(
         circle: Circle, 
         orders: number[],
         meta: MatMeta,
-        poss: PointOnShape[],
+        poss: PrePointOnShape[],
         neighbors?: CpNode[]): { anyFailed: boolean, cpNodes: (CpNode | undefined) [] } {
 
     const { cpTrees } = meta;
 
     let anyFailed = false;
-    const cpNodes = poss.map((pos,i) => {
+    const cpNodes = poss.map((ppos,i) => {
         const order = orders[i];
-        const cpTree = cpTrees.get(pos.curve.loop)!;
-        const cp: ContactPoint = { pointOnShape: pos, circle, order, order2: 0 };
+        const cpTree = cpTrees.get(ppos.curve.loop)!;
+        const pos: PointOnShape = { ...ppos, circle, order, order2: 0 };
 
         const pred = neighbors === undefined
-            ? getCpNodeToLeftOrSame(cpTree, pos, order, 0)
+            ? getCpNodeToLeftOrSame(cpTree, ppos, order, 0)
             : neighbors[i];
 
         const cpNode = insertCpNode(
@@ -43,7 +42,7 @@ function addToCpTree(
             isHoleClosing,
             false,
             cpTree,
-            cp,
+            pos,
             pred,
             meta.lastInsertId
         );

package/src/mat/clone-mat.ts

@@ -1,12 +1,16 @@
+import type { Mat } from "./mat.js";
 import { clone } from "../cp-node/fs/clone.js";
 import { cloneMeta } from "./clone-meta.js";
-import { Mat } from "./mat.js";
 
 
-function cloneMat(mat: Mat): Mat {
+function cloneMat(
+        mat: Mat): Mat {
+
+    const { cpNode, meta } = mat;
+
     return {
-        cpNode: clone(mat.cpNode),
-        meta: cloneMeta(mat.meta)
+        cpNode: clone(cpNode),
+        meta: cloneMeta(cpNode, meta)
     }
 }
 

package/src/mat/clone-meta.ts

@@ -1,16 +1,28 @@
-import { MatMeta } from './mat-meta.js';
+import type { MatMeta } from './mat-meta.js';
+import type { CpNode } from '../cp-node/cp-node.js';
+import { createNewCpTrees } from './create-new-cp-trees.js';
 
 
-function cloneMeta(meta: MatMeta): MatMeta {
-    // const {
-    //     boundingHulls, cpTrees, dullCorners,
-    //     loops, looseBoundingBoxes, pointToCpNode, sharpCorners,
-    //     tightBoundingBoxes, salientCulls, satCulls, maxCoordinate,
-    //     squaredDiagonalLength
-    // } = meta;
+function cloneMeta(
+        cpNode: CpNode,
+        meta: MatMeta): MatMeta {
 
-    // TODO2
-    return { ...meta }
+    const {
+        // pointToCpNode,
+        lastInsertId,
+        cpTrees,
+        ...rest
+    } = meta;
+
+    const cpTrees_ = createNewCpTrees(cpNode);
+    const lastInsertId_ = { id: lastInsertId.id };
+
+    return {
+        cpTrees: cpTrees_,
+        lastInsertId: lastInsertId_,
+        // pointToCpNode,
+        ...rest
+    }
 }
 
 

package/src/mat/create-new-cp-trees.ts

@@ -0,0 +1,35 @@
+import type { Loop } from 'flo-boolean';
+import type { CpNode } from '../cp-node/cp-node.js';
+import { LlRbTree } from 'flo-ll-rb-tree';
+import { cpNodeComparator } from '../cp-node/fs/cp-node-comparator.js';
+import { getAllOnLoop } from '../cp-node/fs/get-all-on-loop.js';
+
+
+
+/**
+ * @param cpNode 
+ * 
+ * @internal
+ */
+function createNewCpTrees(
+        cpNode: CpNode) {
+
+    const cpTrees_: Map<Loop,LlRbTree<CpNode>> = new Map();
+
+    getAllOnLoop(cpNode).forEach(createNewCpTree_);
+
+    function createNewCpTree_(cpNode: CpNode) {
+        const loop = cpNode.pointOnShape.curve.loop;
+        let cpTree = cpTrees_.get(loop);
+        if (!cpTree) { 
+            cpTree = new LlRbTree(cpNodeComparator, false); 
+            cpTrees_.set(loop, cpTree);
+        }
+        cpTree.insert(cpNode);
+    }
+
+    return cpTrees_;
+}
+
+
+export { createNewCpTrees }

package/src/mat/curve-piece.ts

@@ -1,4 +1,4 @@
-import { Curve } from '../curve/curve.js';
+import type { Curve } from 'flo-boolean';
 
 
 /**
@@ -7,10 +7,10 @@ import { Curve } from '../curve/curve.js';
  */
 interface CurvePiece {
     /** A bezier curve within the shape boundary. */
-    curve: Curve;
+    readonly curve: Curve;
     /** The start and end t parameter values of the bezier curve. */
-    ts: number[];
+    readonly ts: number[];
 }
 
 
-export { CurvePiece }
+export type { CurvePiece }