@immugio/three-math-extensions 0.3.4 → 0.3.7

package/eslint.config.mjs

@@ -1,112 +1,112 @@
-import react from "eslint-plugin-react";
-import typescriptEslint from "@typescript-eslint/eslint-plugin";
-import globals from "globals";
-import tsParser from "@typescript-eslint/parser";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
-import stylistic from "@stylistic/eslint-plugin";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-    baseDirectory: __dirname,
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all
-});
-
-export default [
-    {
-        ignores: ["cjs/", "esm/", "types/"],
-    },
-    ...compat.extends("eslint:recommended",
-        "plugin:react/recommended",
-        "plugin:@typescript-eslint/recommended"),
-    {
-        plugins: {
-            react,
-            "@typescript-eslint": typescriptEslint,
-            "@stylistic": stylistic
-        },
-
-        languageOptions: {
-            globals: {
-                ...globals.browser,
-                ...globals.jest,
-            },
-
-            parser: tsParser,
-            ecmaVersion: 11,
-            sourceType: "module",
-
-            parserOptions: {
-                ecmaFeatures: {
-                    jsx: true,
-                },
-                lib: ["esnext", "dom"]
-            },
-        },
-
-        settings: {
-            react: {
-                pragma: "dom",
-                version: "17.0"
-            },
-        },
-
-        rules: {
-            "@stylistic/indent": ["warn", 4, { "SwitchCase": 1 }],
-            "@stylistic/linebreak-style": ["error", "windows"],
-            "@stylistic/quotes": ["error", "double"],
-            "@stylistic/semi": ["error", "always"],
-            "@stylistic/no-extra-semi": ["error"],
-            "@stylistic/no-trailing-spaces": ["error"],
-            "@stylistic/no-multiple-empty-lines": ["error", { max: 1 }],
-            "@stylistic/space-in-parens": ["error", "never"],
-            "@stylistic/space-infix-ops": ["error", { int32Hint: false }],
-            "@stylistic/no-mixed-spaces-and-tabs": ["error"],
-            "@stylistic/space-before-blocks": ["error", "always"],
-            "@stylistic/function-call-spacing": ["error", "never"],
-            "@stylistic/key-spacing": ["error", { "beforeColon": false, "afterColon": true }],
-            "@stylistic/array-bracket-spacing": ["error", "never"],
-            "@stylistic/arrow-spacing": ["error", { "before": true, "after": true }],
-            "@stylistic/block-spacing": ["error", "always"],
-            "@stylistic/brace-style": ["error", "1tbs", { "allowSingleLine": true }],
-            "@stylistic/semi-spacing": ["error", { "before": false, "after": true }],
-            "@stylistic/space-before-function-paren": ["error", "never"],
-            "@stylistic/switch-colon-spacing": ["error", { "after": true, "before": false }],
-            "@stylistic/template-curly-spacing": ["error", "never"],
-            "@stylistic/type-annotation-spacing": ["error", { "after": true }],
-            "@stylistic/object-curly-spacing": ["error", "always"],
-            "@stylistic/keyword-spacing": ["error", { "before": true, "after": true }],
-            "no-undef": "error",
-            "consistent-return": "error",
-            "no-invalid-this": "error",
-            "arrow-parens": ["error", "as-needed"],
-            "eol-last": ["error", "never"],
-            "@typescript-eslint/no-inferrable-types": "off",
-            "@typescript-eslint/no-empty-interface": "off",
-            "@typescript-eslint/no-this-alias": "off",
-            "no-inv": "off",
-            "no-prototype-builtins": "off",
-            "react/react-in-jsx-scope": "off",
-            "react/no-unknown-property": "off",
-            "react/no-unescaped-entities": "off",
-            "react/jsx-key": "off",
-            "react/prop-types": "off",
-            "react/no-is-mounted": "off",
-            "@typescript-eslint/explicit-member-accessibility": ["error", {
-                "accessibility": "explicit",
-                "overrides": {
-                    "constructors": "no-public"
-                }
-            }],
-            "react/self-closing-comp": ["warn", {
-                "component": true,
-                "html": true
-            }],
-            "@typescript-eslint/explicit-module-boundary-types": "error",
-            "eqeqeq": ["error", "always"]
-        },
+import react from "eslint-plugin-react";
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import globals from "globals";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+import stylistic from "@stylistic/eslint-plugin";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [
+    {
+        ignores: ["cjs/", "esm/", "types/"],
+    },
+    ...compat.extends("eslint:recommended",
+        "plugin:react/recommended",
+        "plugin:@typescript-eslint/recommended"),
+    {
+        plugins: {
+            react,
+            "@typescript-eslint": typescriptEslint,
+            "@stylistic": stylistic
+        },
+
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.jest,
+            },
+
+            parser: tsParser,
+            ecmaVersion: 11,
+            sourceType: "module",
+
+            parserOptions: {
+                ecmaFeatures: {
+                    jsx: true,
+                },
+                lib: ["esnext", "dom"]
+            },
+        },
+
+        settings: {
+            react: {
+                pragma: "dom",
+                version: "17.0"
+            },
+        },
+
+        rules: {
+            "@stylistic/indent": ["warn", 4, { "SwitchCase": 1 }],
+            "@stylistic/linebreak-style": ["error", "windows"],
+            "@stylistic/quotes": ["error", "double"],
+            "@stylistic/semi": ["error", "always"],
+            "@stylistic/no-extra-semi": ["error"],
+            "@stylistic/no-trailing-spaces": ["error"],
+            "@stylistic/no-multiple-empty-lines": ["error", { max: 1 }],
+            "@stylistic/space-in-parens": ["error", "never"],
+            "@stylistic/space-infix-ops": ["error", { int32Hint: false }],
+            "@stylistic/no-mixed-spaces-and-tabs": ["error"],
+            "@stylistic/space-before-blocks": ["error", "always"],
+            "@stylistic/function-call-spacing": ["error", "never"],
+            "@stylistic/key-spacing": ["error", { "beforeColon": false, "afterColon": true }],
+            "@stylistic/array-bracket-spacing": ["error", "never"],
+            "@stylistic/arrow-spacing": ["error", { "before": true, "after": true }],
+            "@stylistic/block-spacing": ["error", "always"],
+            "@stylistic/brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+            "@stylistic/semi-spacing": ["error", { "before": false, "after": true }],
+            "@stylistic/space-before-function-paren": ["error", "never"],
+            "@stylistic/switch-colon-spacing": ["error", { "after": true, "before": false }],
+            "@stylistic/template-curly-spacing": ["error", "never"],
+            "@stylistic/type-annotation-spacing": ["error", { "after": true }],
+            "@stylistic/object-curly-spacing": ["error", "always"],
+            "@stylistic/keyword-spacing": ["error", { "before": true, "after": true }],
+            "no-undef": "error",
+            "consistent-return": "error",
+            "no-invalid-this": "error",
+            "arrow-parens": ["error", "as-needed"],
+            "eol-last": ["error", "never"],
+            "@typescript-eslint/no-inferrable-types": "off",
+            "@typescript-eslint/no-empty-interface": "off",
+            "@typescript-eslint/no-this-alias": "off",
+            "no-inv": "off",
+            "no-prototype-builtins": "off",
+            "react/react-in-jsx-scope": "off",
+            "react/no-unknown-property": "off",
+            "react/no-unescaped-entities": "off",
+            "react/jsx-key": "off",
+            "react/prop-types": "off",
+            "react/no-is-mounted": "off",
+            "@typescript-eslint/explicit-member-accessibility": ["error", {
+                "accessibility": "explicit",
+                "overrides": {
+                    "constructors": "no-public"
+                }
+            }],
+            "react/self-closing-comp": ["warn", {
+                "component": true,
+                "html": true
+            }],
+            "@typescript-eslint/explicit-module-boundary-types": "error",
+            "eqeqeq": ["error", "always"]
+        },
     }];

package/esm/Line2D.js

@@ -261,14 +261,63 @@ export class Line2D {
     }
     /**
      * Returns true if other line is collinear and overlaps or at least touching this line.
+     * Uses tolerances to allow for small gaps and angle differences.
      * @param other
-     */
-    isCollinearWithTouchOrOverlap(other) {
-        if (!this.isPointOnInfiniteLine(other.start) || !this.isPointOnInfiniteLine(other.end)) {
+     * @param distanceTolerance Maximum distance between lines or points to be considered touching/overlapping
+     * @param parallelTolerance Maximum angle difference in radians for lines to be considered parallel
+     */
+    isCollinearWithTouchOrOverlap(other, distanceTolerance = 0, parallelTolerance = 0) {
+        // Exact logic (no tolerances)
+        if (!distanceTolerance && !parallelTolerance) {
+            if (!this.isPointOnInfiniteLine(other.start) || !this.isPointOnInfiniteLine(other.end)) {
+                return false;
+            }
+            return this.isPointOnLineSection(other.start) || this.isPointOnLineSection(other.end) ||
+                other.isPointOnLineSection(this.start) || other.isPointOnLineSection(this.end);
+        }
+        // If tolerances are provided, use tolerance-aware logic
+        // Check if lines are parallel
+        if (!this.isParallelTo(other, parallelTolerance)) {
+            return false;
+        }
+        // Check if points are close enough to the infinite line
+        const otherStartDistance = this.distanceToPointOnInfiniteLine(other.start);
+        const otherEndDistance = this.distanceToPointOnInfiniteLine(other.end);
+        const thisStartDistance = other.distanceToPointOnInfiniteLine(this.start);
+        const thisEndDistance = other.distanceToPointOnInfiniteLine(this.end);
+        if (otherStartDistance > distanceTolerance || otherEndDistance > distanceTolerance ||
+            thisStartDistance > distanceTolerance || thisEndDistance > distanceTolerance) {
             return false;
         }
-        return this.isPointOnLineSection(other.start) || this.isPointOnLineSection(other.end) ||
-            other.isPointOnLineSection(this.start) || other.isPointOnLineSection(this.end);
+        // Check if any endpoint is close to and beside the other line section
+        // OR if the lines are close enough to each other (for gap handling)
+        const hasOverlap = this.isPointCloseToAndBesideLineSection(other.start, distanceTolerance) ||
+            this.isPointCloseToAndBesideLineSection(other.end, distanceTolerance) ||
+            other.isPointCloseToAndBesideLineSection(this.start, distanceTolerance) ||
+            other.isPointCloseToAndBesideLineSection(this.end, distanceTolerance);
+        if (hasOverlap) {
+            return true;
+        }
+        // Check if lines are close enough to bridge a gap
+        // Project all endpoints onto the line's direction and check if projections are within tolerance
+        const direction = this.direction;
+        const startPoint = this.start;
+        // Project all points onto the line's direction vector
+        const projectPoint = (p) => {
+            const toPoint = new Vec2().subVectors(p, startPoint);
+            return toPoint.dot(direction);
+        };
+        const thisStartProj = projectPoint(this.start);
+        const thisEndProj = projectPoint(this.end);
+        const otherStartProj = projectPoint(other.start);
+        const otherEndProj = projectPoint(other.end);
+        const minThis = Math.min(thisStartProj, thisEndProj);
+        const maxThis = Math.max(thisStartProj, thisEndProj);
+        const minOther = Math.min(otherStartProj, otherEndProj);
+        const maxOther = Math.max(otherStartProj, otherEndProj);
+        // Check if projections overlap or are within tolerance
+        const gap = Math.max(minThis, minOther) - Math.min(maxThis, maxOther);
+        return gap <= distanceTolerance;
     }
     /**
      * Returns true if there is any overlap between this line and the @other line section.
@@ -326,27 +375,55 @@ export class Line2D {
     }
     /**
      * Joins a copy of @line with the @other line.
-     * Other must be parallel to this line.
+     * Other must be parallel to this line (within tolerance).
      * Returns null if there is no overlap
      * Clones the line, does not modify.
      * @param line
      * @param other
+     * @param distanceTolerance Maximum distance between lines or points to be considered touching/overlapping
+     * @param parallelTolerance Maximum angle difference in radians for lines to be considered parallel
      */
-    static joinLine(line, other) {
-        if (!line.isCollinearWithTouchOrOverlap(other)) {
+    static joinLine(line, other, distanceTolerance = 0, parallelTolerance = 0) {
+        if (!line.isCollinearWithTouchOrOverlap(other, distanceTolerance, parallelTolerance)) {
             return null;
         }
-        const p1 = !line.isPointOnLineSection(other.start) ? other.start : line.start;
-        const p2 = !line.isPointOnLineSection(other.end) ? other.end : line.end;
+        // When using tolerances, we need to check if points are close enough to the line section
+        const useTolerance = distanceTolerance > 0 || parallelTolerance > 0;
+        if (!useTolerance) {
+            const p1 = !line.isPointOnLineSection(other.start) ? other.start : line.start;
+            const p2 = !line.isPointOnLineSection(other.end) ? other.end : line.end;
+            return new Line2D(p1.clone(), p2.clone(), line.index);
+        }
+        // Determine the endpoints of the joined line
+        // We want the outermost points that encompass both lines
+        const points = [line.start, line.end, other.start, other.end];
+        // Project all points onto the line's direction to find min/max
+        const direction = line.direction;
+        const startPoint = line.start;
+        // Project each point onto the line's direction vector
+        const projections = points.map(p => {
+            const toPoint = new Vec2().subVectors(p, startPoint);
+            const t = toPoint.dot(direction);
+            return { point: p, t };
+        });
+        // Find the points with min and max projections
+        const minProj = projections.reduce((min, curr) => curr.t < min.t ? curr : min);
+        const maxProj = projections.reduce((max, curr) => curr.t > max.t ? curr : max);
+        const p1 = minProj.point;
+        const p2 = maxProj.point;
         return new Line2D(p1.clone(), p2.clone(), line.index);
     }
     /**
      * Joins provided lines into several joined lines.
-     * Lines must be parallel for joining.
+     * Lines must be parallel for joining (within tolerance).
      * Clone the lines, does not modify.
      * @param lines
+     * @param distanceTolerance Maximum distance between lines or points to be considered touching/overlapping
+     * @param parallelTolerance Maximum angle difference in radians for lines to be considered parallel
      */
-    static joinLines(lines) {
+    static joinLines(lines, distanceTolerance, parallelTolerance) {
+        const distTol = distanceTolerance ?? 0;
+        const parTol = parallelTolerance ?? 0;
         if (lines.length < 2) {
             return lines.map(x => x.clone());
         }
@@ -359,7 +436,7 @@ export class Line2D {
             // Try to join each pair of lines
             for (let i = 0; i < result.length; i++) {
                 for (let j = i + 1; j < result.length; j++) {
-                    const joinedLine = Line2D.joinLine(result[i], result[j]);
+                    const joinedLine = Line2D.joinLine(result[i], result[j], distTol, parTol);
                     if (joinedLine) {
                         // Replace the first line with the joined line and remove the second
                         result[i] = joinedLine;

package/esm/Polygon.js

@@ -77,6 +77,9 @@ export class Polygon {
         return getPolygonArea(this.contour);
     }
     boundingBox() {
+        if (!this.contour.length) {
+            return new BoundingBox(0, 0, 0, 0);
+        }
         let minX = Infinity, maxX = -Infinity, minY = Infinity, maxY = -Infinity;
         for (const p of this.contour) {
             if (minX > p.x)

package/package.json

@@ -1,62 +1,62 @@
-{
-    "name": "@immugio/three-math-extensions",
-    "version": "0.3.4",
-    "description": "Set of utilities for 2d and 3d line math built on top of three.js",
-    "author": "Jan Mikeska <janmikeska@gmail.com>",
-    "license": "ISC",
-    "keywords": [
-        "threejs",
-        "three",
-        "math"
-    ],
-    "bugs": {
-        "url": "https://github.com/Immugio/three-math-extensions/issues"
-    },
-    "homepage": "https://github.com/Immugio/three-math-extensions#readme",
-    "sideEffects": false,
-    "source": "src/index.ts",
-    "main": "cjs/index.js",
-    "module": "esm/index.js",
-    "types": "types/index.d.ts",
-    "auto-changelog": {
-        "commitLimit": false,
-        "template": "keepachangelog"
-    },
-    "scripts": {
-        "test": "npx jest",
-        "build:esm": "tsc",
-        "build:cjs": "tsc -p tsconfig-cjs.json",
-        "clean": "rimraf types cjs esm",
-        "build": "npm run clean && npm run build:esm && npm run build:cjs",
-        "preversion": "npm run clean && npm run build && npm run test",
-        "version": "auto-changelog -p && git add CHANGELOG.md",
-        "postversion": "git push && git push --tags"
-    },
-    "devDependencies": {
-        "@eslint/eslintrc": "^3.3.1",
-        "@eslint/js": "^9.39.1",
-        "@stylistic/eslint-plugin": "^5.6.1",
-        "@types/jest": "^29.5.11",
-        "@types/offscreencanvas": "2019.7.3",
-        "@types/three": "0.152.0",
-        "@typescript-eslint/eslint-plugin": "^8.47.0",
-        "@typescript-eslint/parser": "^8.47.0",
-        "auto-changelog": "^2.5.0",
-        "eslint": "^9.39.1",
-        "eslint-plugin-react": "^7.37.5",
-        "globals": "^16.5.0",
-        "jest": "^30.2.0",
-        "rimraf": "^6.1.2",
-        "ts-jest": "^29.4.5",
-        "typedoc": "^0.28.14",
-        "typedoc-plugin-markdown": "^4.9.0",
-        "typescript": "5.3.3"
-    },
-    "peerDependencies": {
-        "three": ">=0.152.0"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/Immugio/three-math-extensions.git"
-    }
-}
+{
+    "name": "@immugio/three-math-extensions",
+    "version": "0.3.7",
+    "description": "Set of utilities for 2d and 3d line math built on top of three.js",
+    "author": "Jan Mikeska <janmikeska@gmail.com>",
+    "license": "ISC",
+    "keywords": [
+        "threejs",
+        "three",
+        "math"
+    ],
+    "bugs": {
+        "url": "https://github.com/Immugio/three-math-extensions/issues"
+    },
+    "homepage": "https://github.com/Immugio/three-math-extensions#readme",
+    "sideEffects": false,
+    "source": "src/index.ts",
+    "main": "cjs/index.js",
+    "module": "esm/index.js",
+    "types": "types/index.d.ts",
+    "auto-changelog": {
+        "commitLimit": false,
+        "template": "keepachangelog"
+    },
+    "scripts": {
+        "test": "npx jest",
+        "build:esm": "tsc",
+        "build:cjs": "tsc -p tsconfig-cjs.json",
+        "clean": "rimraf types cjs esm",
+        "build": "npm run clean && npm run build:esm && npm run build:cjs",
+        "preversion": "npm run clean && npm run build && npm run test",
+        "version": "auto-changelog -p && git add CHANGELOG.md",
+        "postversion": "git push && git push --tags"
+    },
+    "devDependencies": {
+        "@eslint/eslintrc": "^3.3.1",
+        "@eslint/js": "^9.39.1",
+        "@stylistic/eslint-plugin": "^5.6.1",
+        "@types/jest": "^29.5.11",
+        "@types/offscreencanvas": "2019.7.3",
+        "@types/three": "0.152.0",
+        "@typescript-eslint/eslint-plugin": "^8.47.0",
+        "@typescript-eslint/parser": "^8.47.0",
+        "auto-changelog": "^2.5.0",
+        "eslint": "^9.39.1",
+        "eslint-plugin-react": "^7.37.5",
+        "globals": "^16.5.0",
+        "jest": "^30.2.0",
+        "rimraf": "^6.1.2",
+        "ts-jest": "^29.4.5",
+        "typedoc": "^0.28.14",
+        "typedoc-plugin-markdown": "^4.9.0",
+        "typescript": "5.3.3"
+    },
+    "peerDependencies": {
+        "three": ">=0.152.0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Immugio/three-math-extensions.git"
+    }
+}

package/src/BoundingBox.ts

@@ -1,14 +1,14 @@
-import { Vec2 } from "./Vec2";
-
-export class BoundingBox {
-    constructor(public minX: number, public maxX: number, public minY: number, public maxY: number) {
-    }
-
-    public equals(other: BoundingBox): boolean {
-        return this.minX === other.minX && this.maxX === other.maxX && this.minY === other.minY && this.maxY === other.maxY;
-    }
-
-    public get size(): Vec2 {
-        return new Vec2(this.maxX - this.minX, this.maxY - this.minY);
-    }
+import { Vec2 } from "./Vec2";
+
+export class BoundingBox {
+    constructor(public minX: number, public maxX: number, public minY: number, public maxY: number) {
+    }
+
+    public equals(other: BoundingBox): boolean {
+        return this.minX === other.minX && this.maxX === other.maxX && this.minY === other.minY && this.maxY === other.maxY;
+    }
+
+    public get size(): Vec2 {
+        return new Vec2(this.maxX - this.minX, this.maxY - this.minY);
+    }
 }