@immugio/three-math-extensions 0.2.21 → 0.2.22

package/CHANGELOG.md

@@ -7,7 +7,7 @@ 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.2.21](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.21)
+## [0.2.22](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.22)
 
 ### Commits
 
@@ -16,9 +16,12 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Add eslint [`98e4912`](https://github.com/Immugio/three-math-extensions/commit/98e4912d637b42ba80e2f3267638b43296113019)
 - Update jest packages [`af23b4f`](https://github.com/Immugio/three-math-extensions/commit/af23b4f08154bba3407f05b773865215e7e1cba8)
 - Add Rectangle, update Polygon [`58ee875`](https://github.com/Immugio/three-math-extensions/commit/58ee87539af8f9ade186e5250cba9e01926da514)
+- Documentation update [`905d178`](https://github.com/Immugio/three-math-extensions/commit/905d1787ed7ffffa370b77454222ee04e76f35b5)
+- Documentation update [`70a5f24`](https://github.com/Immugio/three-math-extensions/commit/70a5f243f8af83da3ad5d30e223788cbd877b5f0)
 - Add isPointInPolygon [`a59eb4b`](https://github.com/Immugio/three-math-extensions/commit/a59eb4be026f17a3106070ae626a0588cd4f4411)
 - Packages update [`c2ef857`](https://github.com/Immugio/three-math-extensions/commit/c2ef857c01792e64c1558424fdd2f401f72720d0)
 - Improve Line2D.closestPointToPoint, add Vec2.signedAngle [`151f214`](https://github.com/Immugio/three-math-extensions/commit/151f21462e0358057ad8e9d75d5782563a1061f6)
+- Add Line2D.containsPoint, Line2D.covers, Improve Line2D.equals, Line2D.overlaps, add unit tests [`7b6daf7`](https://github.com/Immugio/three-math-extensions/commit/7b6daf7028303313b6937c16514838604d89515d)
 - Improve documentation [`d0fcb51`](https://github.com/Immugio/three-math-extensions/commit/d0fcb5132f127b4382ac5f7291575a061b8ec121)
 - Add isContinuousClosedShape, add Line2D.groupConnectedLines [`4ef8c2f`](https://github.com/Immugio/three-math-extensions/commit/4ef8c2fe83fdc71dd87fee4cbc478ddf0a086442)
 - Vec3, Line3D - update documentation [`67d9c32`](https://github.com/Immugio/three-math-extensions/commit/67d9c328e08cc0a5599932d2f0529e97f31c9213)
@@ -53,7 +56,13 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Documentation update [`d5c7a07`](https://github.com/Immugio/three-math-extensions/commit/d5c7a0765f6097f5d3a3be01967d4059f19682fb)
 - Excluded files from build [`ec70614`](https://github.com/Immugio/three-math-extensions/commit/ec70614bc7df7a98f854c7a6693365118e04faf7)
 
-## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.20...16.15.10) - 2023-01-02
+## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.21...16.15.10) - 2023-01-02
+
+## [0.2.21](https://github.com/Immugio/three-math-extensions/compare/0.2.20...0.2.21) - 2024-04-03
+
+### Commits
+
+- Three dependency update [`7cf5cf3`](https://github.com/Immugio/three-math-extensions/commit/7cf5cf3ece28c408b544d5dcc8626a9fe005b9a5)
 
 ## [0.2.20](https://github.com/Immugio/three-math-extensions/compare/0.2.19...0.2.20) - 2024-04-03
 

package/README.md

@@ -6,4 +6,186 @@
 
 # @immugio/three-math-extensions
 
-## [Documentation](docs/modules.md)
+## Table of contents
+
+### Classes
+
+- [BoundingBox](docs/classes/BoundingBox.md)
+- [Line2D](docs/classes/Line2D.md)
+- [Line3D](docs/classes/Line3D.md)
+- [Polygon](docs/classes/Polygon.md)
+- [Rectangle](docs/classes/Rectangle.md)
+- [Size2](docs/classes/Size2.md)
+- [Vec2](docs/classes/Vec2.md)
+- [Vec3](docs/classes/Vec3.md)
+
+### Interfaces
+
+- [Point2](docs/interfaces/Point2.md)
+- [Point3](docs/interfaces/Point3.md)
+
+### Variables
+
+- [HalfPI](docs/modules.md#halfpi)
+- [TwoPI](docs/modules.md#twopi)
+- [directions](docs/modules.md#directions)
+- [directions2d](docs/modules.md#directions2d)
+
+### Functions
+
+- [isContinuousClosedShape](docs/modules.md#iscontinuousclosedshape)
+- [isPointInPolygon](docs/modules.md#ispointinpolygon)
+- [normalizeAngleDegrees](docs/modules.md#normalizeangledegrees)
+- [normalizeAngleRadians](docs/modules.md#normalizeangleradians)
+
+## Variables
+
+### HalfPI
+
+• `Const` **HalfPI**: `number`
+
+#### Defined in
+
+[src/MathConstants.ts:2](https://github.com/Immugio/three-math-extensions/blob/7b6daf7/src/MathConstants.ts#L2)
+
+___
+
+### TwoPI
+
+• `Const` **TwoPI**: `number`
+
+#### Defined in
+
+[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/7b6daf7/src/MathConstants.ts#L1)
+
+___
+
+### directions
+
+• `Const` **directions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Down` | [`Vec3`](docs/classes/Vec3.md) |
+| `East` | [`Vec3`](docs/classes/Vec3.md) |
+| `North` | [`Vec3`](docs/classes/Vec3.md) |
+| `South` | [`Vec3`](docs/classes/Vec3.md) |
+| `Up` | [`Vec3`](docs/classes/Vec3.md) |
+| `West` | [`Vec3`](docs/classes/Vec3.md) |
+
+#### Defined in
+
+[src/directions.ts:3](https://github.com/Immugio/three-math-extensions/blob/7b6daf7/src/directions.ts#L3)
+
+___
+
+### directions2d
+
+• `Const` **directions2d**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Down` | [`Vec2`](docs/classes/Vec2.md) |
+| `Left` | [`Vec2`](docs/classes/Vec2.md) |
+| `Right` | [`Vec2`](docs/classes/Vec2.md) |
+| `Up` | [`Vec2`](docs/classes/Vec2.md) |
+
+#### Defined in
+
+[src/directions2d.ts:3](https://github.com/Immugio/three-math-extensions/blob/7b6daf7/src/directions2d.ts#L3)
+
+## Functions
+
+### isContinuousClosedShape
+
+▸ **isContinuousClosedShape**\<`T`\>(`lines`, `tolerance?`): `boolean`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`Line3D`](docs/classes/Line3D.md) \| [`Line2D`](docs/classes/Line2D.md) |
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `lines` | `T`[] | `undefined` |
+| `tolerance` | `number` | `0` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/isContinuousClosedShape.ts:4](https://github.com/Immugio/three-math-extensions/blob/7b6daf7/src/isContinuousClosedShape.ts#L4)
+
+___
+
+### isPointInPolygon
+
+▸ **isPointInPolygon**(`p`, `point`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `p` | [`Point2`](docs/interfaces/Point2.md)[] |
+| `point` | [`Point2`](docs/interfaces/Point2.md) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/isPointInPolygon.ts:3](https://github.com/Immugio/three-math-extensions/blob/7b6daf7/src/isPointInPolygon.ts#L3)
+
+___
+
+### normalizeAngleDegrees
+
+▸ **normalizeAngleDegrees**(`angle`): `number`
+
+Normalizes an angle in degrees to the range [0, 360].
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `angle` | `number` | in degrees |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[src/normalizeAngleDegrees.ts:5](https://github.com/Immugio/three-math-extensions/blob/7b6daf7/src/normalizeAngleDegrees.ts#L5)
+
+___
+
+### normalizeAngleRadians
+
+▸ **normalizeAngleRadians**(`angle`): `number`
+
+Normalize an angle in radians to the range of 0 to 2π.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `angle` | `number` | in radians |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[src/normalizeAngleRadians.ts:7](https://github.com/Immugio/three-math-extensions/blob/7b6daf7/src/normalizeAngleRadians.ts#L7)

package/cjs/Line2D.js

@@ -13,6 +13,7 @@ class Line2D {
     start;
     end;
     index;
+    #target = new Vec2_1.Vec2();
     constructor(start, end, index = 0) {
         this.start = start;
         this.end = end;
@@ -141,6 +142,24 @@ class Line2D {
     get endpoints() {
         return [this.start, this.end];
     }
+    /**
+     * Check that this line segment contains provided point.
+     * @param p
+     * @param tolerance
+     */
+    containsPoint(p, tolerance = 0) {
+        const closestPointToPoint = this.closestPointToPoint(p, true, this.#target);
+        return closestPointToPoint.distanceTo(p) <= tolerance;
+    }
+    /**
+     * Distance from this line to the provided point.
+     * @param param
+     * @param clampToLine
+     */
+    distanceToPoint(p, clampToLine = true) {
+        const closestPointToPoint = this.closestPointToPoint(p, clampToLine, this.#target);
+        return closestPointToPoint.distanceTo(p);
+    }
     /**
      * Returns the direction of this line.
      */
@@ -248,14 +267,32 @@ class Line2D {
     /**
      * Returns true if there is any overlap between this line and the @other line section.
      */
-    overlaps(other) {
-        if (!this.isCollinearWithTouchOrOverlap(other)) {
-            return false;
-        }
-        if (this.start.equals(other.start) && this.end.equals(other.end)) {
+    overlaps(other, distanceTolerance = 0, parallelTolerance = 0) {
+        // Special case
+        if (this.equals(other, distanceTolerance)) {
             return true;
         }
-        return !this.start.equals(other.end) && !this.end.equals(other.start);
+        // Always have to be parallel
+        if (this.isParallelTo(other, parallelTolerance)) {
+            // To pass as overlapping, at least one point has to be within the other line, but they mush not be equal - "touching" is not considered overlapping
+            const otherStartEqualsToAnyOfThisPoint = other.start.distanceTo(this.start) <= distanceTolerance || other.start.distanceTo(this.end) <= distanceTolerance;
+            if (this.containsPoint(other.start, distanceTolerance) && !otherStartEqualsToAnyOfThisPoint) {
+                return true;
+            }
+            const otherEndEqualsToAnyOfThisPoint = other.end.distanceTo(this.start) <= distanceTolerance || other.end.distanceTo(this.end) <= distanceTolerance;
+            if (this.containsPoint(other.end, distanceTolerance) && !otherEndEqualsToAnyOfThisPoint) {
+                return true;
+            }
+            const thisStartEqualsToAnyOfOtherPoint = this.start.distanceTo(other.start) <= distanceTolerance || this.start.distanceTo(other.end) <= distanceTolerance;
+            if (other.containsPoint(this.start, distanceTolerance) && !thisStartEqualsToAnyOfOtherPoint) {
+                return true;
+            }
+            const thisEndEqualsToAnyOfOtherPoint = this.end.distanceTo(other.start) <= distanceTolerance || this.end.distanceTo(other.end) <= distanceTolerance;
+            if (other.containsPoint(this.end, distanceTolerance) && !thisEndEqualsToAnyOfOtherPoint) {
+                return true;
+            }
+        }
+        return false;
     }
     /**
      * Logical AND of this and the other line section.
@@ -327,6 +364,17 @@ class Line2D {
         }
         return result;
     }
+    /**
+     * Checks if the current line covers another line.
+     * A line is considered to cover another line if they are parallel and both the start and end points of the other line are contained within the current line.
+     * Both distance and angle tolerance can be provided.
+     */
+    covers(other, tolerance = 0, parallelTolerance = 0) {
+        if (!this.isParallelTo(other, parallelTolerance)) {
+            return false;
+        }
+        return this.containsPoint(other.start, tolerance) && this.containsPoint(other.end, tolerance);
+    }
     /**
      * Returns a new line that is the projection of this line onto @other. Uses `closestPointToPoint` to find the projection.
      * @param other
@@ -643,8 +691,11 @@ class Line2D {
     in3DSpace(y = 0) {
         return new Line3D_1.Line3D(this.start.in3DSpace(y), this.end.in3DSpace(y));
     }
-    equals(other) {
-        return !!other && this.start.equals(other.start) && this.end.equals(other.end);
+    equals(other, tolerance = 0) {
+        if (!tolerance) {
+            return !!other && this.start.equals(other.start) && this.end.equals(other.end);
+        }
+        return !!other && this.start.distanceTo(other.start) <= tolerance && this.end.distanceTo(other.end) <= tolerance;
     }
     /**
      * Deep clone of this line

package/cjs/Line3D.js

@@ -253,7 +253,7 @@ class Line3D extends three_1.Line3 {
         return closestPointToPoint.distanceTo(p) <= tolerance;
     }
     /**
-     * Distance from this line to provided point.
+     * Distance from this line to the provided point.
      * @param p
      * @param clampToLine
      */

package/docs/classes/BoundingBox.md

@@ -1,4 +1,4 @@
-[@immugio/three-math-extensions](../README.md) / [Exports](../modules.md) / BoundingBox
+[@immugio/three-math-extensions](../../README.md) / [Exports](../modules.md) / BoundingBox
 
 # Class: BoundingBox
 
@@ -27,7 +27,7 @@
 
 ### constructor
 
-• **new BoundingBox**(`minX`, `maxX`, `minY`, `maxY`)
+• **new BoundingBox**(`minX`, `maxX`, `minY`, `maxY`): [`BoundingBox`](BoundingBox.md)
 
 #### Parameters
 
@@ -38,9 +38,13 @@
 | `minY` | `number` |
 | `maxY` | `number` |
 
+#### Returns
+
+[`BoundingBox`](BoundingBox.md)
+
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/905d178/src/BoundingBox.ts#L4)
 
 ## Properties
 
@@ -50,7 +54,7 @@
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/905d178/src/BoundingBox.ts#L4)
 
 ___
 
@@ -60,7 +64,7 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/905d178/src/BoundingBox.ts#L4)
 
 ___
 
@@ -70,7 +74,7 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/905d178/src/BoundingBox.ts#L4)
 
 ___
 
@@ -80,7 +84,7 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/905d178/src/BoundingBox.ts#L4)
 
 ## Accessors
 
@@ -94,7 +98,7 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:11](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/BoundingBox.ts#L11)
+[src/BoundingBox.ts:11](https://github.com/Immugio/three-math-extensions/blob/905d178/src/BoundingBox.ts#L11)
 
 ## Methods
 
@@ -114,4 +118,4 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:7](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/BoundingBox.ts#L7)
+[src/BoundingBox.ts:7](https://github.com/Immugio/three-math-extensions/blob/905d178/src/BoundingBox.ts#L7)