svg-path-simplify 0.0.2 → 0.0.4

package/src/pathSimplify-main.js

@@ -1,3 +1,4 @@
+import { detectInputType } from './detect_input';
 import { combineCubicPairs } from './pathData_simplify_cubic';
 import { getPathDataVertices, pointAtT } from './svgii/geometry';
 import { getPolyBBox } from './svgii/geometry_bbox';
@@ -14,9 +15,10 @@ import { pathDataToPolyPlus } from './svgii/pathData_toPolygon';
 import { analyzePoly } from './svgii/poly_analyze';
 import { getCurvePathData } from './svgii/poly_to_pathdata';
 import { detectAccuracy } from './svgii/rounding';
+import { cleanUpSVG } from './svgii/svg_cleanup';
 import { renderPoint } from './svgii/visualize';
 
-export function svgPathSimplify(d = '', {
+export function svgPathSimplify(input = '', {
     toAbsolute = true,
     toRelative = true,
     toShorthands = true,
@@ -45,147 +47,251 @@ export function svgPathSimplify(d = '', {
     revertToQuadratics = true,
     minifyD = 0,
     tolerance = 1,
-    reverse = false
+    reverse = false,
+
+    // svg cleanup options
+    removeHidden = true,
+    removeUnused = true,
+
+    // return svg markup or object
+    getObject = false
+
 } = {}) {
 
+    // clamp tolerance 
+    tolerance = Math.max(0.1, tolerance);
+
+    let inputType = detectInputType(input);
 
-    let pathDataO = parsePathDataNormalized(d, { quadraticToCubic, toAbsolute, arcToCubic });
+    let svg = '';
+    let svgSize = 0;
+    let svgSizeOpt = 0;
+    let compression = 0;
+    let report = {};
+    let d = '';
+    let mode = inputType === 'svgMarkup' ? 1 : 0;
 
-    // create clone for fallback
-    let pathData = JSON.parse(JSON.stringify(pathDataO));
+    let paths = []
 
-    // count commands for evaluation
-    let comCount = pathDataO.length
 
     /**
-     * get sub paths
+     * normalize input
+     * switch mode
      */
-    let subPathArr = splitSubpaths(pathData);
 
-    // cleaned up pathData
-    let pathDataArrN = [];
+    // original size
+    svgSize = new Blob([input]).size;
 
-    for (let i = 0, l = subPathArr.length; i < l; i++) {
+    // single path
+    if (!mode) {
+        if (inputType === 'pathDataString') {
+            d = input
+        } else if (inputType === 'polyString') {
+            d = 'M' + input
+        }
+        paths.push({ d, el: null })
+    }
+    // process svg
+    else {
+        //sanitize
+        let returnDom = true
+        svg = cleanUpSVG(input, { returnDom, removeHidden, removeUnused }
+        );
+
+        // collect paths
+        let pathEls = svg.querySelectorAll('path')
+        pathEls.forEach(path => {
+            paths.push({ d: path.getAttribute('d'), el: path })
+        })
+    }
 
-        //let { pathData, bb } = subPathArr[i];
-        let pathDataSub = subPathArr[i];
+    //console.log(paths);
+    //console.log('inputType', inputType, 'mode',  mode);
 
-        // try simplification in reversed order
-        if (reverse) pathDataSub = reversePathData(pathDataSub);
+    /**
+     * process all paths
+     */
+    paths.forEach(path => {
+        let { d, el } = path;
 
-        // remove zero length linetos
-        if (removeColinear) pathDataSub = removeZeroLengthLinetos(pathDataSub)
+        let pathDataO = parsePathDataNormalized(d, { quadraticToCubic, toAbsolute, arcToCubic });
+        //console.log(pathDataO);
 
-        // add extremes
-        //let tMin=0.2, tMax=0.8;
-        let tMin = 0, tMax = 1;
-        if (addExtremes) pathDataSub = addExtremePoints(pathDataSub, tMin, tMax)
+        // create clone for fallback
+        let pathData = JSON.parse(JSON.stringify(pathDataO));
 
+        // count commands for evaluation
+        let comCount = pathDataO.length
 
-        // sort to top left
-        if (optimizeOrder) pathDataSub = pathDataToTopLeft(pathDataSub);
+        /**
+         * get sub paths
+         */
+        let subPathArr = splitSubpaths(pathData);
 
-        // remove colinear/flat
-        if (removeColinear) pathDataSub = pathDataRemoveColinear(pathDataSub, tolerance, flatBezierToLinetos);
+        // cleaned up pathData
+        let pathDataArrN = [];
 
-        // analyze pathdata to add info about signicant properties such as extremes, corners
-        let pathDataPlus = analyzePathData(pathDataSub);
+        for (let i = 0, l = subPathArr.length; i < l; i++) {
 
+            //let { pathData, bb } = subPathArr[i];
+            let pathDataSub = subPathArr[i];
 
-        // simplify beziers
-        let { pathData, bb, dimA } = pathDataPlus;
+            // try simplification in reversed order
+            if (reverse) pathDataSub = reversePathData(pathDataSub);
 
+            // remove zero length linetos
+            if (removeColinear) pathDataSub = removeZeroLengthLinetos(pathDataSub)
 
+            // add extremes
+            //let tMin=0.2, tMax=0.8;
+            let tMin = 0, tMax = 1;
+            if (addExtremes) pathDataSub = addExtremePoints(pathDataSub, tMin, tMax)
 
 
+            // sort to top left
+            if (optimizeOrder) pathDataSub = pathDataToTopLeft(pathDataSub);
 
-        let pathDataN = pathData;
+            // remove colinear/flat
+            if (removeColinear) pathDataSub = pathDataRemoveColinear(pathDataSub, tolerance, flatBezierToLinetos);
 
+            // analyze pathdata to add info about signicant properties such as extremes, corners
+            let pathDataPlus = analyzePathData(pathDataSub);
 
 
-        
-        pathDataN = simplifyBezier ? simplifyPathData(pathDataN, { simplifyBezier, keepInflections, keepExtremes, keepCorners, extrapolateDominant, revertToQuadratics, tolerance, reverse }) : pathDataN;
+            // simplify beziers
+            let { pathData, bb, dimA } = pathDataPlus;
 
+            //let pathDataN = pathData;
 
+            //console.log(pathDataPlus);
 
-        // cubic to arcs
-        if(cubicToArc){
+            pathData = simplifyBezier ? simplifyPathData(pathData, { simplifyBezier, keepInflections, keepExtremes, keepCorners, extrapolateDominant, revertToQuadratics, tolerance, reverse }) : pathData;
 
-            let thresh = 3;
 
-            pathDataN.forEach((com, c) => {
-                let { type, values, p0, cp1 = null, cp2 = null, p = null } = com;
-                if (type === 'C') {
-                    //console.log(com);
-                    let comA = cubicCommandToArc(p0, cp1, cp2, p, thresh)
-                    if(comA.isArc) pathDataN[c] = comA.com;
-                    //if (comQ.type === 'Q') pathDataN[c] = comQ
-                }
-            })
+            // cubic to arcs
+            if (cubicToArc) {
+
+                let thresh = 3;
 
-            // combine adjacent cubics
-            pathDataN = combineArcs(pathDataN)
+                pathData.forEach((com, c) => {
+                    let { type, values, p0, cp1 = null, cp2 = null, p = null } = com;
+                    if (type === 'C') {
+                        //console.log(com);
+                        let comA = cubicCommandToArc(p0, cp1, cp2, p, thresh)
+                        if (comA.isArc) pathData[c] = comA.com;
+                        //if (comQ.type === 'Q') pathDataN[c] = comQ
+                    }
+                })
 
+                // combine adjacent cubics
+                pathData = combineArcs(pathData)
+
+            }
+
+
+            // simplify to quadratics
+            if (revertToQuadratics) {
+                pathData.forEach((com, c) => {
+                    let { type, values, p0, cp1 = null, cp2 = null, p = null } = com;
+                    if (type === 'C') {
+                        //console.log(com);
+                        let comQ = revertCubicQuadratic(p0, cp1, cp2, p)
+                        if (comQ.type === 'Q') pathData[c] = comQ
+                    }
+                })
+            }
+
+
+            // update
+            pathDataArrN.push(pathData)
         }
 
 
-        // simplify to quadratics
-        if (revertToQuadratics) {
-            pathDataN.forEach((com, c) => {
-                let { type, values, p0, cp1 = null, cp2 = null, p = null } = com;
-                if (type === 'C') {
-                    //console.log(com);
-                    let comQ = revertCubicQuadratic(p0, cp1, cp2, p)
-                    if (comQ.type === 'Q') pathDataN[c] = comQ
-                }
-            })
+        // flatten compound paths 
+        pathData = pathDataArrN.flat();
+
+        /**
+         * detect accuracy
+         */
+        if (autoAccuracy) {
+            decimals = detectAccuracy(pathData)
         }
 
 
+        // optimize
+        let pathOptions = {
+            toRelative,
+            toShorthands,
+            decimals,
+        }
 
 
-        // update
-        pathDataArrN.push(pathDataN)
-    }
+        // optimize path data
+        pathData = convertPathData(pathData, pathOptions)
 
 
-    // merge pathdata
-    let pathDataFlat = pathDataArrN.flat();
+        // remove zero-length segments introduced by rounding
+        let pathDataOpt = []
 
-    /**
-     * detect accuracy
-     */
-    if (autoAccuracy) {
-        decimals = detectAccuracy(pathDataFlat)
-    }
+        pathData.forEach((com, i) => {
+            let { type, values } = com;
+            if (type === 'l' || type === 'v' || type === 'h') {
+                let hasLength = type === 'l' ? (values.join('') !== '00') : values[0] !== 0
+                if (hasLength) pathDataOpt.push(com)
+            } else {
+                pathDataOpt.push(com)
+            }
+        })
 
+        pathData = pathDataOpt;
 
 
-    // compare command count
-    let comCountS = pathDataFlat.length
+        // compare command count
+        let comCountS = pathData.length
 
-    // optimize
-    let pathOptions = {
-        toRelative,
-        toShorthands,
-        decimals,
-    }
+        let dOpt = pathDataToD(pathData, minifyD)
+        svgSizeOpt = new Blob([dOpt]).size;
+        //compression = +(100/svgSize * (svgSize - svgSizeOpt)).toFixed(2)
+        compression = +(100 / svgSize * (svgSizeOpt)).toFixed(2)
+
+
+        path.d = dOpt
+        path.report = {
+            original: comCount,
+            new: comCountS,
+            saved: comCount - comCountS,
+            compression,
+            decimals,
+            //success: comCountS < comCount
+        }
 
+        // apply new path for svgs
+        if (el) el.setAttribute('d', dOpt)
 
-    // optimize path data
-    pathData = convertPathData(pathDataFlat, pathOptions)
-    let dOpt = pathDataToD(pathData, minifyD)
+    });
+
+    // stringify new SVG
+    if (mode) {
+        svg = new XMLSerializer().serializeToString(svg);
+        svgSizeOpt = new Blob([svg]).size
+        //compression = +(100/svgSize * (svgSize-svgSizeOpt)).toFixed(2)
+        compression = +(100 / svgSize * (svgSizeOpt)).toFixed(2)
+
+        svgSize = +(svgSize / 1024).toFixed(3)
+        svgSizeOpt = +(svgSizeOpt / 1024).toFixed(3)
+
+        report = {
+            svgSize,
+            svgSizeOpt,
+            compression
+        }
 
-    let report = {
-        original: comCount,
-        new: comCountS,
-        saved: comCount - comCountS,
-        decimals,
-        success: comCountS < comCount
+    } else {
+        ({ d, report } = paths[0]);
     }
 
-    return { pathData, d: dOpt, report };
 
+    return !getObject ? (d ? d : svg) : { svg, d, report, inputType, mode };
 
 }
 
@@ -221,9 +327,9 @@ function simplifyPathData(pathData, {
 
             // cannot be combined as crossing extremes or corners
             if (
-                    (keepInflections && isDirChangeN) ||
-                    (keepCorners && corner) ||
-                    (!isDirChange && keepExtremes && extreme)
+                (keepInflections && isDirChangeN) ||
+                (keepCorners && corner) ||
+                (!isDirChange && keepExtremes && extreme)
             ) {
                 //renderPoint(markers, p, 'red', '1%')
                 pathDataN.push(com)

package/src/svg_getViewbox.js

@@ -0,0 +1,32 @@
+/**
+ * get viewBox 
+ * either from explicit attribute or
+ * width and height attributes
+ */
+
+export function getViewBox(svg = null, round = false) {
+
+    // browser default
+    if (!svg) return { x: 0, y: 0, width: 300, height: 150 }
+
+    let style = window.getComputedStyle(svg);
+
+    // the baseVal API method also converts physical units to pixels/user-units
+    let w = svg.hasAttribute('width') ? svg.width.baseVal.value : parseFloat(style.width) || 300;
+    let h = svg.hasAttribute('height') ? svg.height.baseVal.value : parseFloat(style.height) || 150;
+
+    let viewBox = svg.getAttribute('viewBox') ? svg.viewBox.baseVal : { x: 0, y: 0, width: w, height: h };
+
+    // remove SVG constructor
+    let { x, y, width, height } = viewBox;
+    viewBox = { x, y, width, height };
+
+    // round to integers
+    if (round) {
+        for (let prop in viewBox) {
+            viewBox[prop] = Math.ceil(viewBox[prop]);
+        }
+    }
+
+    return viewBox
+}

package/src/svgii/geometry.js

@@ -52,7 +52,7 @@ export function checkLineIntersection(p1, p2, p3, p4, exact = true) {
         y: p1.y + (a * (p2.y - p1.y))
     }
 
-   // console.log('intersectionPoint', intersectionPoint, p1, p2);
+    // console.log('intersectionPoint', intersectionPoint, p1, p2);
 
 
 
@@ -985,16 +985,63 @@ export function commandIsFlat(points, tolerance = 0.025) {
 }
 
 
+export function checkBezierFlatness(p0, cpts, p) {
 
+    let isFlat = false;
+
+    let isCubic = cpts.length===2;
+
+    let cp1 = cpts[0]
+    let cp2 = isCubic ? cpts[1] : cp1;
+
+    if(p0.x===cp1.x && p0.y===cp1.y && p.x===cp2.x && p.y===cp2.y) return true;
+
+    let dx1 = cp1.x - p0.x;
+    let dy1 = cp1.y - p0.y;
+
+    let dx2 = p.x - cp2.x;
+    let dy2 = p.y - cp2.y;
+
+    let cross1 = Math.abs(dx1 * dy2 - dy1 * dx2);
+
+    if(!cross1) return true
+
+    let dx0 = p.x - p0.x;
+    let dy0 = p.y - p0.y;
+    let cross0 = Math.abs(dx0 * dy1 - dy0 * dx1);
+
+    if(!cross0) return true
+
+    //let diff = Math.abs(cross0 - cross1)
+    //let rat0 = 1/cross0 * diff;
+    let rat = (cross0/cross1)
+
+    if (rat<1.1 ) {
+        //console.log('cross', cross0, cross1, 'rat', rat, rat0, diff );
+        isFlat = true;
+    }
+
+    return isFlat;
+
+}
 
 /**
  * sloppy distance calculation
  * based on x/y differences
  */
 export function getDistAv(pt1, pt2) {
-    let diffX = Math.abs(pt1.x - pt2.x);
-    let diffY = Math.abs(pt1.y - pt2.y);
+
+    let diffX = Math.abs(pt2.x - pt1.x);
+    let diffY = Math.abs(pt2.y - pt1.y);
     let diff = (diffX + diffY) / 2;
+
+    /*
+    let diffX = pt2.x - pt1.x;
+    let diffY = pt2.y - pt1.y;
+    let diff = Math.abs(diffX + diffY) / 2;
+    */
+
+
     return diff;
 }
 
@@ -1067,7 +1114,7 @@ export function reducePoints(points, maxPoints = 48) {
 }
 
 
-export function mirrorCpts(cpt2_0, pt0, cpt2, pt1, outgoing = true, t=0.666) {
+export function mirrorCpts(cpt2_0, pt0, cpt2, pt1, outgoing = true, t = 0.666) {
 
     // hypotenuse angle
     let ang0 = getAngle(pt0, pt1, true);

package/src/svgii/pathData_remove_collinear.js

@@ -1,4 +1,4 @@
-import { getSquareDistance } from "./geometry.js";
+import { checkBezierFlatness, getDistAv, getSquareDistance } from "./geometry.js";
 import { getPolygonArea } from "./geometry_area.js";
 import { renderPoint } from "./visualize.js";
 
@@ -17,49 +17,62 @@ export function pathDataRemoveColinear(pathData, tolerance = 1, flatBezierToLine
         let comPrev = pathData[c - 1];
         let com = pathData[c];
         let comN = pathData[c + 1] || pathData[l - 1];
-        let p1 = comN.type === 'Z' ? M : { x: comN.values[comN.values.length - 2], y: comN.values[comN.values.length - 1] }
+        let p1 = comN.type.toLowerCase() === 'z' ? M : { x: comN.values[comN.values.length - 2], y: comN.values[comN.values.length - 1] }
 
         let { type, values } = com;
         let valsL = values.slice(-2)
         p = type !== 'Z' ? { x: valsL[0], y: valsL[1] } : M;
 
-        let cpts = type === 'C' ?
-            [{ x: values[0], y: values[1] }, { x: values[2], y: values[3] }] :
-            (type === 'Q' ? [{ x: values[0], y: values[1] }] : []);
+        let area = getPolygonArea([p0, p, p1], true)
 
+        let distSquare = getSquareDistance(p0, p1)
+        let distMax = distSquare / 100 * tolerance
 
-        let area = getPolygonArea([p0, ...cpts, p, p1], true)
-        let distSquare = getSquareDistance(p0, p)
-        let distMax = distSquare / 500 * tolerance
+        let isFlat = area < distMax;
+        let isFlatBez = false;
 
-        let isFlat = area < distMax 
-        
-        if(!flatBezierToLinetos && type==='C') isFlat = false;
-        //let isFlat = flatBezierToLinetos && type === 'C' ? area < distMax : false
 
+        if (!flatBezierToLinetos && type === 'C') isFlat = false;
+        //let isFlat = flatBezierToLinetos && type === 'C' ? area < distMax : false
 
         // convert flat beziers to linetos
-        if (flatBezierToLinetos && type === 'C') {
+        if (flatBezierToLinetos && (type === 'C' || type === 'Q')) {
+
+            let cpts = type === 'C' ?
+            [{ x: values[0], y: values[1] }, { x: values[2], y: values[3] }] :
+            (type === 'Q' ? [{ x: values[0], y: values[1] }] : []);
 
-            let areaBez = getPolygonArea([p0, ...cpts, p], true)
-            let isFlatBez = areaBez < distSquare / 1000
 
-            if (isFlatBez && comPrev.type !== 'C') {
+            //let areaBez = getPolygonArea([p0, ...cpts, p], true)
+
+            isFlatBez = checkBezierFlatness(p0, cpts, p)
+           // console.log();
+
+            //isFlatBez = areaBez < distMax * 0.25
+            //console.log('isFlatBez', isFlatBez);
+            //isFlatBez = false
+
+            //&& comPrev.type !== 'C'
+            if (isFlatBez  && c < l - 1 && comPrev.type !== 'C') {
+                type = "L"
                 com.type = "L"
                 com.values = valsL
+
+                //renderPoint(markers, p)
             }
 
         }
 
-
         // update end point
         p0 = p;
 
         // colinear – exclude arcs (as always =) as semicircles won't have an area
-        if (type !== 'A' && isFlat && c < l - 1) {
+        if ( isFlat && c < l - 1 && (type === 'L' || (flatBezierToLinetos && isFlatBez))) {
+            //console.log(area,distMax );
             continue;
         }
 
+
         if (type === 'M') {
             M = p
             p0 = M

package/src/svgii/pathData_reorder.js

@@ -7,8 +7,42 @@ import { renderPoint, renderPath } from './visualize.js';
 import { getPolygonArea } from './geometry_area.js';
 
 
+export function pathDataToTopLeft(pathData) {
 
-export function pathDataToTopLeft(pathData, removeFinalLineto = false, reorder = true) {
+    let len = pathData.length;
+    let isClosed = pathData[len - 1].type.toLowerCase() === 'z'
+
+    // we can't change starting point for non closed paths
+    if (!isClosed) {
+        return pathData
+    }
+
+    let newIndex = 0;
+
+    //get top most index
+    let indices = [];
+    for (let i = 0; i < len; i++) {
+        let com = pathData[i];
+        let { type, values } = com;
+        let valsLen = values.length
+        if (valsLen) {
+            let p = { type: type, x: values[valsLen-2], y: values[valsLen-1], index: 0}
+            p.index = i
+            indices.push(p)
+        }
+    }
+
+    // reorder  to top left most
+    indices = indices.sort((a, b) => +a.y.toFixed(3) - +b.y.toFixed(3) || a.x - b.x);
+    newIndex = indices[0].index
+
+    return  newIndex ? shiftSvgStartingPoint(pathData, newIndex) : pathData;
+}
+
+
+
+
+export function optimizeClosePath(pathData, removeFinalLineto = false, reorder = true) {
 
     let pathDataNew = [];
     let len = pathData.length;
@@ -21,18 +55,18 @@ export function pathDataToTopLeft(pathData, removeFinalLineto = false, reorder =
     // check if order is ideal
     let penultimateCom = pathData[len - 2];
     let penultimateType = penultimateCom.type;
-    let penultimateComCoords = penultimateCom.values.slice(-2).map(val=>+val.toFixed(8))
+    let penultimateComCoords = penultimateCom.values.slice(-2).map(val => +val.toFixed(8))
 
     // last L command ends at M 
-    let isClosingCommand =  penultimateComCoords[0] === M.x && penultimateComCoords[1] === M.y
+    let isClosingCommand = penultimateComCoords[0] === M.x && penultimateComCoords[1] === M.y
 
     // if last segment is not closing or a lineto
-    let skipReorder = pathData[1].type!=='L' && (!isClosingCommand || penultimateType==='L' )
-    skipReorder=false
+    let skipReorder = pathData[1].type !== 'L' && (!isClosingCommand || penultimateType === 'L')
+    skipReorder = false
 
 
     // we can't change starting point for non closed paths
-    if (!isClosed ) {
+    if (!isClosed) {
         return pathData
     }
 
@@ -62,15 +96,15 @@ export function pathDataToTopLeft(pathData, removeFinalLineto = false, reorder =
         // find top most lineto
 
         if (linetos.length) {
-            let curveAfterLine = indices.filter(com => (com.type !== 'L' && com.type !== 'M') && com.prevCom && 
-            com.prevCom === 'L' || com.prevCom==='M' && penultimateType==='L' ).sort((a, b) => a.y - b.y || a.x-b.x)[0]
+            let curveAfterLine = indices.filter(com => (com.type !== 'L' && com.type !== 'M') && com.prevCom &&
+                com.prevCom === 'L' || com.prevCom === 'M' && penultimateType === 'L').sort((a, b) => a.y - b.y || a.x - b.x)[0]
 
             newIndex = curveAfterLine ? curveAfterLine.index - 1 : 0
 
         }
         // use top most command
         else {
-            indices = indices.sort((a, b) => +a.y.toFixed(1) - +b.y.toFixed(1) || a.x - b.x  );
+            indices = indices.sort((a, b) => +a.y.toFixed(1) - +b.y.toFixed(1) || a.x - b.x);
             newIndex = indices[0].index
         }