@immugio/three-math-extensions 0.3.4 → 0.3.7

package/CHANGELOG.md

@@ -7,7 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-## [0.3.4](https://github.com/Immugio/three-math-extensions/compare/0.3.3...0.3.4)
+## [0.3.7](https://github.com/Immugio/three-math-extensions/compare/0.3.6...0.3.7)
+
+### Commits
+
+- Polygon - Account for empty contour when calculating bounding box [`56bb6a9`](https://github.com/Immugio/three-math-extensions/commit/56bb6a9577eea00b756779aa2a78688b3bb1f2b8)
+
+## [0.3.6](https://github.com/Immugio/three-math-extensions/compare/0.3.5...0.3.6) - 2026-01-13
+
+### Commits
+
+- Update the publish script to work with trusted providers. [`b6ccb15`](https://github.com/Immugio/three-math-extensions/commit/b6ccb1545c6190495fbcf14f97c06895a3de3670)
+
+## [0.3.5](https://github.com/Immugio/three-math-extensions/compare/0.3.4...0.3.5) - 2026-01-13
+
+### Merged
+
+- Line2D - Joining lines should support tolerance [`#6`](https://github.com/Immugio/three-math-extensions/pull/6)
+
+### Commits
+
+- Line2D - Improve unit test descriptions [`be66f7f`](https://github.com/Immugio/three-math-extensions/commit/be66f7f6113c5c3c7f7bf0e6c99afbc7b2bcfc05)
+
+## [0.3.4](https://github.com/Immugio/three-math-extensions/compare/0.3.3...0.3.4) - 2025-11-20
 
 ### Commits
 

package/cjs/Line2D.js

@@ -264,14 +264,63 @@ 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_1.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.
@@ -329,27 +378,55 @@ 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_1.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());
         }
@@ -362,7 +439,7 @@ 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/cjs/Polygon.js

@@ -80,6 +80,9 @@ class Polygon {
         return (0, getPolygonArea_1.getPolygonArea)(this.contour);
     }
     boundingBox() {
+        if (!this.contour.length) {
+            return new BoundingBox_1.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/docs/classes/BoundingBox.md

@@ -1,121 +1,121 @@
-[@immugio/three-math-extensions](../../README.md) / [Exports](../modules.md) / BoundingBox
-
-# Class: BoundingBox
-
-## Table of contents
-
-### Constructors
-
-- [constructor](BoundingBox.md#constructor)
-
-### Properties
-
-- [maxX](BoundingBox.md#maxx)
-- [maxY](BoundingBox.md#maxy)
-- [minX](BoundingBox.md#minx)
-- [minY](BoundingBox.md#miny)
-
-### Accessors
-
-- [size](BoundingBox.md#size)
-
-### Methods
-
-- [equals](BoundingBox.md#equals)
-
-## Constructors
-
-### constructor
-
-• **new BoundingBox**(`minX`, `maxX`, `minY`, `maxY`): [`BoundingBox`](BoundingBox.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `minX` | `number` |
-| `maxX` | `number` |
-| `minY` | `number` |
-| `maxY` | `number` |
-
-#### Returns
-
-[`BoundingBox`](BoundingBox.md)
-
-#### Defined in
-
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
-
-## Properties
-
-### maxX
-
-• **maxX**: `number`
-
-#### Defined in
-
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
-
-___
-
-### maxY
-
-• **maxY**: `number`
-
-#### Defined in
-
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
-
-___
-
-### minX
-
-• **minX**: `number`
-
-#### Defined in
-
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
-
-___
-
-### minY
-
-• **minY**: `number`
-
-#### Defined in
-
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
-
-## Accessors
-
-### size
-
-• `get` **size**(): [`Vec2`](Vec2.md)
-
-#### Returns
-
-[`Vec2`](Vec2.md)
-
-#### Defined in
-
-[src/BoundingBox.ts:11](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L11)
-
-## Methods
-
-### equals
-
-▸ **equals**(`other`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `other` | [`BoundingBox`](BoundingBox.md) |
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[src/BoundingBox.ts:7](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L7)
+[@immugio/three-math-extensions](../../README.md) / [Exports](../modules.md) / BoundingBox
+
+# Class: BoundingBox
+
+## Table of contents
+
+### Constructors
+
+- [constructor](BoundingBox.md#constructor)
+
+### Properties
+
+- [maxX](BoundingBox.md#maxx)
+- [maxY](BoundingBox.md#maxy)
+- [minX](BoundingBox.md#minx)
+- [minY](BoundingBox.md#miny)
+
+### Accessors
+
+- [size](BoundingBox.md#size)
+
+### Methods
+
+- [equals](BoundingBox.md#equals)
+
+## Constructors
+
+### constructor
+
+• **new BoundingBox**(`minX`, `maxX`, `minY`, `maxY`): [`BoundingBox`](BoundingBox.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `minX` | `number` |
+| `maxX` | `number` |
+| `minY` | `number` |
+| `maxY` | `number` |
+
+#### Returns
+
+[`BoundingBox`](BoundingBox.md)
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
+
+## Properties
+
+### maxX
+
+• **maxX**: `number`
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
+
+___
+
+### maxY
+
+• **maxY**: `number`
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
+
+___
+
+### minX
+
+• **minX**: `number`
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
+
+___
+
+### minY
+
+• **minY**: `number`
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L4)
+
+## Accessors
+
+### size
+
+• `get` **size**(): [`Vec2`](Vec2.md)
+
+#### Returns
+
+[`Vec2`](Vec2.md)
+
+#### Defined in
+
+[src/BoundingBox.ts:11](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L11)
+
+## Methods
+
+### equals
+
+▸ **equals**(`other`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `other` | [`BoundingBox`](BoundingBox.md) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/BoundingBox.ts:7](https://github.com/Immugio/three-math-extensions/blob/e397290/src/BoundingBox.ts#L7)