js-draw 0.18.0 → 0.18.1

package/dist/cjs/src/math/Path.js

@@ -1,655 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PathCommandType = void 0;
-const bezier_js_1 = require("bezier-js");
-const rounding_1 = require("./rounding");
-const LineSegment2_1 = __importDefault(require("./LineSegment2"));
-const Mat33_1 = __importDefault(require("./Mat33"));
-const Rect2_1 = __importDefault(require("./Rect2"));
-const Vec2_1 = require("./Vec2");
-var PathCommandType;
-(function (PathCommandType) {
-    PathCommandType[PathCommandType["LineTo"] = 0] = "LineTo";
-    PathCommandType[PathCommandType["MoveTo"] = 1] = "MoveTo";
-    PathCommandType[PathCommandType["CubicBezierTo"] = 2] = "CubicBezierTo";
-    PathCommandType[PathCommandType["QuadraticBezierTo"] = 3] = "QuadraticBezierTo";
-})(PathCommandType = exports.PathCommandType || (exports.PathCommandType = {}));
-class Path {
-    constructor(startPoint, parts) {
-        this.startPoint = startPoint;
-        this.parts = parts;
-        this.cachedGeometry = null;
-        this.cachedPolylineApproximation = null;
-        this.cachedStringVersion = null;
-        // Initial bounding box contains one point: the start point.
-        this.bbox = Rect2_1.default.bboxOf([startPoint]);
-        // Convert into a representation of the geometry (cache for faster intersection
-        // calculation)
-        for (const part of parts) {
-            this.bbox = this.bbox.union(Path.computeBBoxForSegment(startPoint, part));
-        }
-    }
-    // Lazy-loads and returns this path's geometry
-    get geometry() {
-        if (this.cachedGeometry) {
-            return this.cachedGeometry;
-        }
-        let startPoint = this.startPoint;
-        const geometry = [];
-        for (const part of this.parts) {
-            switch (part.kind) {
-                case PathCommandType.CubicBezierTo:
-                    geometry.push(new bezier_js_1.Bezier(startPoint.xy, part.controlPoint1.xy, part.controlPoint2.xy, part.endPoint.xy));
-                    startPoint = part.endPoint;
-                    break;
-                case PathCommandType.QuadraticBezierTo:
-                    geometry.push(new bezier_js_1.Bezier(startPoint.xy, part.controlPoint.xy, part.endPoint.xy));
-                    startPoint = part.endPoint;
-                    break;
-                case PathCommandType.LineTo:
-                    geometry.push(new LineSegment2_1.default(startPoint, part.point));
-                    startPoint = part.point;
-                    break;
-                case PathCommandType.MoveTo:
-                    startPoint = part.point;
-                    break;
-            }
-        }
-        this.cachedGeometry = geometry;
-        return this.cachedGeometry;
-    }
-    // Approximates this path with a group of line segments.
-    polylineApproximation() {
-        if (this.cachedPolylineApproximation) {
-            return this.cachedPolylineApproximation;
-        }
-        const points = [];
-        for (const part of this.parts) {
-            switch (part.kind) {
-                case PathCommandType.CubicBezierTo:
-                    points.push(part.controlPoint1, part.controlPoint2, part.endPoint);
-                    break;
-                case PathCommandType.QuadraticBezierTo:
-                    points.push(part.controlPoint, part.endPoint);
-                    break;
-                case PathCommandType.MoveTo:
-                case PathCommandType.LineTo:
-                    points.push(part.point);
-                    break;
-            }
-        }
-        const result = [];
-        let prevPoint = this.startPoint;
-        for (const point of points) {
-            result.push(new LineSegment2_1.default(prevPoint, point));
-            prevPoint = point;
-        }
-        return result;
-    }
-    static computeBBoxForSegment(startPoint, part) {
-        const points = [startPoint];
-        let exhaustivenessCheck;
-        switch (part.kind) {
-            case PathCommandType.MoveTo:
-            case PathCommandType.LineTo:
-                points.push(part.point);
-                break;
-            case PathCommandType.CubicBezierTo:
-                points.push(part.controlPoint1, part.controlPoint2, part.endPoint);
-                break;
-            case PathCommandType.QuadraticBezierTo:
-                points.push(part.controlPoint, part.endPoint);
-                break;
-            default:
-                exhaustivenessCheck = part;
-                return exhaustivenessCheck;
-        }
-        return Rect2_1.default.bboxOf(points);
-    }
-    intersection(line) {
-        if (!line.bbox.intersects(this.bbox)) {
-            return [];
-        }
-        const result = [];
-        for (const part of this.geometry) {
-            if (part instanceof LineSegment2_1.default) {
-                const intersection = part.intersection(line);
-                if (intersection) {
-                    result.push({
-                        curve: part,
-                        parameterValue: intersection.t,
-                        point: intersection.point,
-                    });
-                }
-            }
-            else {
-                const intersectionPoints = part.intersects(line).map(t => {
-                    // We're using the .intersects(line) function, which is documented
-                    // to always return numbers. However, to satisfy the type checker (and
-                    // possibly improperly-defined types),
-                    if (typeof t === 'string') {
-                        t = parseFloat(t);
-                    }
-                    const point = Vec2_1.Vec2.ofXY(part.get(t));
-                    // Ensure that the intersection is on the line
-                    if (point.minus(line.p1).magnitude() > line.length
-                        || point.minus(line.p2).magnitude() > line.length) {
-                        return null;
-                    }
-                    return {
-                        point,
-                        parameterValue: t,
-                        curve: part,
-                    };
-                }).filter(entry => entry !== null);
-                result.push(...intersectionPoints);
-            }
-        }
-        return result;
-    }
-    static mapPathCommand(part, mapping) {
-        switch (part.kind) {
-            case PathCommandType.MoveTo:
-            case PathCommandType.LineTo:
-                return {
-                    kind: part.kind,
-                    point: mapping(part.point),
-                };
-                break;
-            case PathCommandType.CubicBezierTo:
-                return {
-                    kind: part.kind,
-                    controlPoint1: mapping(part.controlPoint1),
-                    controlPoint2: mapping(part.controlPoint2),
-                    endPoint: mapping(part.endPoint),
-                };
-                break;
-            case PathCommandType.QuadraticBezierTo:
-                return {
-                    kind: part.kind,
-                    controlPoint: mapping(part.controlPoint),
-                    endPoint: mapping(part.endPoint),
-                };
-                break;
-        }
-        const exhaustivenessCheck = part;
-        return exhaustivenessCheck;
-    }
-    mapPoints(mapping) {
-        const startPoint = mapping(this.startPoint);
-        const newParts = [];
-        for (const part of this.parts) {
-            newParts.push(Path.mapPathCommand(part, mapping));
-        }
-        return new Path(startPoint, newParts);
-    }
-    transformedBy(affineTransfm) {
-        if (affineTransfm.isIdentity()) {
-            return this;
-        }
-        return this.mapPoints(point => affineTransfm.transformVec2(point));
-    }
-    // Creates a new path by joining [other] to the end of this path
-    union(other) {
-        if (!other) {
-            return this;
-        }
-        return new Path(this.startPoint, [
-            ...this.parts,
-            {
-                kind: PathCommandType.MoveTo,
-                point: other.startPoint,
-            },
-            ...other.parts,
-        ]);
-    }
-    getEndPoint() {
-        if (this.parts.length === 0) {
-            return this.startPoint;
-        }
-        const lastPart = this.parts[this.parts.length - 1];
-        if (lastPart.kind === PathCommandType.QuadraticBezierTo || lastPart.kind === PathCommandType.CubicBezierTo) {
-            return lastPart.endPoint;
-        }
-        else {
-            return lastPart.point;
-        }
-    }
-    roughlyIntersects(rect, strokeWidth = 0) {
-        if (this.parts.length === 0) {
-            return rect.containsPoint(this.startPoint);
-        }
-        const isClosed = this.startPoint.eq(this.getEndPoint());
-        if (isClosed && strokeWidth === 0) {
-            return this.closedRoughlyIntersects(rect);
-        }
-        if (rect.containsRect(this.bbox)) {
-            return true;
-        }
-        // Does the rectangle intersect the bounding boxes of any of this' parts?
-        let startPoint = this.startPoint;
-        for (const part of this.parts) {
-            const bbox = Path.computeBBoxForSegment(startPoint, part).grownBy(strokeWidth);
-            if (part.kind === PathCommandType.LineTo || part.kind === PathCommandType.MoveTo) {
-                startPoint = part.point;
-            }
-            else {
-                startPoint = part.endPoint;
-            }
-            if (rect.intersects(bbox)) {
-                return true;
-            }
-        }
-        return false;
-    }
-    // Treats this as a closed path and returns true if part of `rect` is roughly within
-    // this path's interior.
-    //
-    // Note: Assumes that this is a closed, non-self-intersecting path.
-    closedRoughlyIntersects(rect) {
-        if (rect.containsRect(this.bbox)) {
-            return true;
-        }
-        // Choose a point outside of the path.
-        const startPt = this.bbox.topLeft.minus(Vec2_1.Vec2.of(1, 1));
-        const testPts = rect.corners;
-        const polygon = this.polylineApproximation();
-        for (const point of testPts) {
-            const testLine = new LineSegment2_1.default(point, startPt);
-            let intersectionCount = 0;
-            for (const line of polygon) {
-                if (line.intersects(testLine)) {
-                    intersectionCount++;
-                }
-            }
-            // Odd? The point is within the polygon!
-            if (intersectionCount % 2 === 1) {
-                return true;
-            }
-        }
-        // Grow the rectangle for possible additional precision.
-        const grownRect = rect.grownBy(Math.min(rect.size.x, rect.size.y));
-        const edges = [];
-        for (const subrect of grownRect.divideIntoGrid(4, 4)) {
-            edges.push(...subrect.getEdges());
-        }
-        for (const edge of edges) {
-            for (const line of polygon) {
-                if (edge.intersects(line)) {
-                    return true;
-                }
-            }
-        }
-        // Even? Probably no intersection.
-        return false;
-    }
-    // Returns a path that outlines [rect]. If [lineWidth] is not given, the resultant path is
-    // the outline of [rect]. Otherwise, the resultant path represents a line of width [lineWidth]
-    // that traces [rect].
-    static fromRect(rect, lineWidth = null) {
-        const commands = [];
-        let corners;
-        let startPoint;
-        if (lineWidth !== null) {
-            // Vector from the top left corner or bottom right corner to the edge of the
-            // stroked region.
-            const cornerToEdge = Vec2_1.Vec2.of(lineWidth, lineWidth).times(0.5);
-            const innerRect = Rect2_1.default.fromCorners(rect.topLeft.plus(cornerToEdge), rect.bottomRight.minus(cornerToEdge));
-            const outerRect = Rect2_1.default.fromCorners(rect.topLeft.minus(cornerToEdge), rect.bottomRight.plus(cornerToEdge));
-            corners = [
-                innerRect.corners[3],
-                ...innerRect.corners,
-                ...outerRect.corners.reverse(),
-            ];
-            startPoint = outerRect.corners[3];
-        }
-        else {
-            corners = rect.corners.slice(1);
-            startPoint = rect.corners[0];
-        }
-        for (const corner of corners) {
-            commands.push({
-                kind: PathCommandType.LineTo,
-                point: corner,
-            });
-        }
-        // Close the shape
-        commands.push({
-            kind: PathCommandType.LineTo,
-            point: startPoint,
-        });
-        return new Path(startPoint, commands);
-    }
-    static fromRenderable(renderable) {
-        if (renderable.path) {
-            return renderable.path;
-        }
-        return new Path(renderable.startPoint, renderable.commands);
-    }
-    toRenderable(fill) {
-        return {
-            startPoint: this.startPoint,
-            style: fill,
-            commands: this.parts,
-            path: this,
-        };
-    }
-    /**
-     * @returns a Path that, when rendered, looks roughly equivalent to the given path.
-     */
-    static visualEquivalent(renderablePath, visibleRect) {
-        var _a, _b;
-        const path = Path.fromRenderable(renderablePath);
-        const strokeWidth = (_b = (_a = renderablePath.style.stroke) === null || _a === void 0 ? void 0 : _a.width) !== null && _b !== void 0 ? _b : 0;
-        const onlyStroked = strokeWidth > 0 && renderablePath.style.fill.a === 0;
-        // Scale the expanded rect --- the visual equivalent is only close for huge strokes.
-        const expandedRect = visibleRect.grownBy(strokeWidth)
-            .transformedBoundingBox(Mat33_1.default.scaling2D(2, visibleRect.center));
-        // TODO: Handle simplifying very small paths.
-        if (expandedRect.containsRect(path.bbox.grownBy(strokeWidth))) {
-            return renderablePath;
-        }
-        const parts = [];
-        let startPoint = path.startPoint;
-        for (const part of path.parts) {
-            const partBBox = Path.computeBBoxForSegment(startPoint, part).grownBy(strokeWidth);
-            let endPoint;
-            if (part.kind === PathCommandType.LineTo || part.kind === PathCommandType.MoveTo) {
-                endPoint = part.point;
-            }
-            else {
-                endPoint = part.endPoint;
-            }
-            const intersectsVisible = partBBox.intersects(visibleRect);
-            if (intersectsVisible) {
-                // TODO: Can we trim parts of paths that intersect the visible rectangle?
-                parts.push(part);
-            }
-            else if (onlyStroked || part.kind === PathCommandType.MoveTo) {
-                // We're stroking (not filling) and the path doesn't intersect the bounding box.
-                // Don't draw it, but preserve the endpoints.
-                parts.push({
-                    kind: PathCommandType.MoveTo,
-                    point: endPoint,
-                });
-            }
-            else {
-                // Otherwise, we may be filling. Try to roughly preserve the filled region.
-                parts.push({
-                    kind: PathCommandType.LineTo,
-                    point: endPoint,
-                });
-            }
-            startPoint = endPoint;
-        }
-        return new Path(path.startPoint, parts).toRenderable(renderablePath.style);
-    }
-    toString(useNonAbsCommands) {
-        if (this.cachedStringVersion) {
-            return this.cachedStringVersion;
-        }
-        if (useNonAbsCommands === undefined) {
-            // Hueristic: Try to determine whether converting absolute to relative commands is worth it.
-            useNonAbsCommands = Math.abs(this.bbox.topLeft.x) > 10 && Math.abs(this.bbox.topLeft.y) > 10;
-        }
-        const result = Path.toString(this.startPoint, this.parts, !useNonAbsCommands);
-        this.cachedStringVersion = result;
-        return result;
-    }
-    serialize() {
-        return this.toString();
-    }
-    // @param onlyAbsCommands - True if we should avoid converting absolute coordinates to relative offsets -- such
-    //   conversions can lead to smaller output strings, but also take time.
-    static toString(startPoint, parts, onlyAbsCommands) {
-        var _a;
-        const result = [];
-        let prevPoint;
-        const addCommand = (command, ...points) => {
-            const absoluteCommandParts = [];
-            const relativeCommandParts = [];
-            const makeAbsCommand = !prevPoint || onlyAbsCommands;
-            const roundedPrevX = prevPoint ? (0, rounding_1.toRoundedString)(prevPoint.x) : '';
-            const roundedPrevY = prevPoint ? (0, rounding_1.toRoundedString)(prevPoint.y) : '';
-            for (const point of points) {
-                const xComponent = (0, rounding_1.toRoundedString)(point.x);
-                const yComponent = (0, rounding_1.toRoundedString)(point.y);
-                // Relative commands are often shorter as strings than absolute commands.
-                if (!makeAbsCommand) {
-                    const xComponentRelative = (0, rounding_1.toStringOfSamePrecision)(point.x - prevPoint.x, xComponent, roundedPrevX, roundedPrevY);
-                    const yComponentRelative = (0, rounding_1.toStringOfSamePrecision)(point.y - prevPoint.y, yComponent, roundedPrevX, roundedPrevY);
-                    // No need for an additional separator if it starts with a '-'
-                    if (yComponentRelative.charAt(0) === '-') {
-                        relativeCommandParts.push(`${xComponentRelative}${yComponentRelative}`);
-                    }
-                    else {
-                        relativeCommandParts.push(`${xComponentRelative},${yComponentRelative}`);
-                    }
-                }
-                else {
-                    absoluteCommandParts.push(`${xComponent},${yComponent}`);
-                }
-            }
-            let commandString;
-            if (makeAbsCommand) {
-                commandString = `${command}${absoluteCommandParts.join(' ')}`;
-            }
-            else {
-                commandString = `${command.toLowerCase()}${relativeCommandParts.join(' ')}`;
-            }
-            // Don't add no-ops.
-            if (commandString === 'l0,0' || commandString === 'm0,0') {
-                return;
-            }
-            result.push(commandString);
-            if (points.length > 0) {
-                prevPoint = points[points.length - 1];
-            }
-        };
-        // Don't add two moveTos in a row (this can happen if
-        // the start point corresponds to a moveTo _and_ the first command is
-        // also a moveTo)
-        if (((_a = parts[0]) === null || _a === void 0 ? void 0 : _a.kind) !== PathCommandType.MoveTo) {
-            addCommand('M', startPoint);
-        }
-        let exhaustivenessCheck;
-        for (let i = 0; i < parts.length; i++) {
-            const part = parts[i];
-            switch (part.kind) {
-                case PathCommandType.MoveTo:
-                    addCommand('M', part.point);
-                    break;
-                case PathCommandType.LineTo:
-                    addCommand('L', part.point);
-                    break;
-                case PathCommandType.CubicBezierTo:
-                    addCommand('C', part.controlPoint1, part.controlPoint2, part.endPoint);
-                    break;
-                case PathCommandType.QuadraticBezierTo:
-                    addCommand('Q', part.controlPoint, part.endPoint);
-                    break;
-                default:
-                    exhaustivenessCheck = part;
-                    return exhaustivenessCheck;
-            }
-        }
-        return result.join('');
-    }
-    // Create a Path from a SVG path specification.
-    // TODO: Support a larger subset of SVG paths.
-    // TODO: Support `s`,`t` commands shorthands.
-    static fromString(pathString) {
-        // See the MDN reference:
-        // https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d
-        // and
-        // https://www.w3.org/TR/SVG2/paths.html
-        var _a;
-        // Remove linebreaks
-        pathString = pathString.split('\n').join(' ');
-        let lastPos = Vec2_1.Vec2.zero;
-        let firstPos = null;
-        let startPos = null;
-        let isFirstCommand = true;
-        const commands = [];
-        const moveTo = (point) => {
-            // The first moveTo/lineTo is already handled by the [startPoint] parameter of the Path constructor.
-            if (isFirstCommand) {
-                isFirstCommand = false;
-                return;
-            }
-            commands.push({
-                kind: PathCommandType.MoveTo,
-                point,
-            });
-        };
-        const lineTo = (point) => {
-            if (isFirstCommand) {
-                isFirstCommand = false;
-                return;
-            }
-            commands.push({
-                kind: PathCommandType.LineTo,
-                point,
-            });
-        };
-        const cubicBezierTo = (cp1, cp2, end) => {
-            commands.push({
-                kind: PathCommandType.CubicBezierTo,
-                controlPoint1: cp1,
-                controlPoint2: cp2,
-                endPoint: end,
-            });
-        };
-        const quadraticBeierTo = (controlPoint, endPoint) => {
-            commands.push({
-                kind: PathCommandType.QuadraticBezierTo,
-                controlPoint,
-                endPoint,
-            });
-        };
-        const commandArgCounts = {
-            'm': 1,
-            'l': 1,
-            'c': 3,
-            'q': 2,
-            'z': 0,
-            'h': 1,
-            'v': 1,
-        };
-        // Each command: Command character followed by anything that isn't a command character
-        const commandExp = /([MZLHVCSQTA])\s*([^MZLHVCSQTA]*)/ig;
-        let current;
-        while ((current = commandExp.exec(pathString)) !== null) {
-            const argParts = current[2].trim().split(/[^0-9Ee.-]/).filter(part => part.length > 0).reduce((accumualtor, current) => {
-                // As of 09/2022, iOS Safari doesn't support support lookbehind in regular
-                // expressions. As such, we need an alternative.
-                // Because '-' can be used as a path separator, unless preceeded by an 'e' (as in 1e-5),
-                // we need special cases:
-                current = current.replace(/([^eE])[-]/g, '$1 -');
-                const parts = current.split(' -');
-                if (parts[0] !== '') {
-                    accumualtor.push(parts[0]);
-                }
-                accumualtor.push(...parts.slice(1).map(part => `-${part}`));
-                return accumualtor;
-            }, []);
-            let numericArgs = argParts.map(arg => parseFloat(arg));
-            let commandChar = current[1].toLowerCase();
-            let uppercaseCommand = current[1] !== commandChar;
-            // Convert commands that don't take points into commands that do.
-            if (commandChar === 'v' || commandChar === 'h') {
-                numericArgs = numericArgs.reduce((accumulator, current) => {
-                    if (commandChar === 'v') {
-                        return accumulator.concat(uppercaseCommand ? lastPos.x : 0, current);
-                    }
-                    else {
-                        return accumulator.concat(current, uppercaseCommand ? lastPos.y : 0);
-                    }
-                }, []);
-                commandChar = 'l';
-            }
-            else if (commandChar === 'z') {
-                if (firstPos) {
-                    numericArgs = [firstPos.x, firstPos.y];
-                    firstPos = lastPos;
-                }
-                else {
-                    continue;
-                }
-                // 'z' always acts like an uppercase lineTo(startPos)
-                uppercaseCommand = true;
-                commandChar = 'l';
-            }
-            const commandArgCount = (_a = commandArgCounts[commandChar]) !== null && _a !== void 0 ? _a : 0;
-            const allArgs = numericArgs.reduce((accumulator, current, index, parts) => {
-                if (index % 2 !== 0) {
-                    const currentAsFloat = current;
-                    const prevAsFloat = parts[index - 1];
-                    return accumulator.concat(Vec2_1.Vec2.of(prevAsFloat, currentAsFloat));
-                }
-                else {
-                    return accumulator;
-                }
-            }, []).map((coordinate, index) => {
-                // Lowercase commands are relative, uppercase commands use absolute
-                // positioning
-                let newPos;
-                if (uppercaseCommand) {
-                    newPos = coordinate;
-                }
-                else {
-                    newPos = lastPos.plus(coordinate);
-                }
-                if ((index + 1) % commandArgCount === 0) {
-                    lastPos = newPos;
-                }
-                return newPos;
-            });
-            if (allArgs.length % commandArgCount !== 0) {
-                throw new Error([
-                    `Incorrect number of arguments: got ${JSON.stringify(allArgs)} with a length of ${allArgs.length} ≠ ${commandArgCount}k, k ∈ ℤ.`,
-                    `The number of arguments to ${commandChar} must be a multiple of ${commandArgCount}!`,
-                    `Command: ${current[0]}`,
-                ].join('\n'));
-            }
-            for (let argPos = 0; argPos < allArgs.length; argPos += commandArgCount) {
-                const args = allArgs.slice(argPos, argPos + commandArgCount);
-                switch (commandChar.toLowerCase()) {
-                    case 'm':
-                        if (argPos === 0) {
-                            moveTo(args[0]);
-                        }
-                        else {
-                            lineTo(args[0]);
-                        }
-                        break;
-                    case 'l':
-                        lineTo(args[0]);
-                        break;
-                    case 'c':
-                        cubicBezierTo(args[0], args[1], args[2]);
-                        break;
-                    case 'q':
-                        quadraticBeierTo(args[0], args[1]);
-                        break;
-                    default:
-                        throw new Error(`Unknown path command ${commandChar}`);
-                }
-                isFirstCommand = false;
-            }
-            if (allArgs.length > 0) {
-                firstPos !== null && firstPos !== void 0 ? firstPos : (firstPos = allArgs[0]);
-                startPos !== null && startPos !== void 0 ? startPos : (startPos = firstPos);
-                lastPos = allArgs[allArgs.length - 1];
-            }
-        }
-        const result = new Path(startPos !== null && startPos !== void 0 ? startPos : Vec2_1.Vec2.zero, commands);
-        result.cachedStringVersion = pathString;
-        return result;
-    }
-}
-exports.default = Path;
-Path.empty = new Path(Vec2_1.Vec2.zero, []);