@immugio/three-math-extensions 0.2.5 → 0.2.7

package/CHANGELOG.md

@@ -7,20 +7,37 @@ 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.5](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.5)
+## [0.2.7](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.7)
 
 ### Commits
 
 - Add Rectangle, update Polygon [`58ee875`](https://github.com/Immugio/three-math-extensions/commit/58ee87539af8f9ade186e5250cba9e01926da514)
+- Improve Line2D.closestPointToPoint, add Vec2.signedAngle [`151f214`](https://github.com/Immugio/three-math-extensions/commit/151f21462e0358057ad8e9d75d5782563a1061f6)
+- Improve documentation [`d0fcb51`](https://github.com/Immugio/three-math-extensions/commit/d0fcb5132f127b4382ac5f7291575a061b8ec121)
 - Vec3, Line3D - update documentation [`67d9c32`](https://github.com/Immugio/three-math-extensions/commit/67d9c328e08cc0a5599932d2f0529e97f31c9213)
 - Add Polygon [`629cff8`](https://github.com/Immugio/three-math-extensions/commit/629cff8ecbb963477e8ea76d7f8b16d95435cbad)
 - Add Vec2.signedAngle [`863c8f2`](https://github.com/Immugio/three-math-extensions/commit/863c8f27f11288cbda535e21bb688206259269ed)
+- Add Vec2.fromPoints to accept multiple points [`a261402`](https://github.com/Immugio/three-math-extensions/commit/a2614027cf5fb8263189b48f7e0bb9a23a552c15)
+- Add Vec2.parallelTo [`989874d`](https://github.com/Immugio/three-math-extensions/commit/989874dcfe122d3ee84d8d56d79cb88e4e441736)
 - Polygon from bounding size [`eae6701`](https://github.com/Immugio/three-math-extensions/commit/eae67012f57f426f8b5259b765000447ce06d608)
 - Line2D and Line3D to return this instead of specific type [`761ef6a`](https://github.com/Immugio/three-math-extensions/commit/761ef6a9d8cc4e35120b666576794e521aa3b991)
+- Line2D.hasIntersectionWithAngle to support optional tolerance [`b313bbe`](https://github.com/Immugio/three-math-extensions/commit/b313bbe118d435d53750deefd9a9e29ba6ec5c71)
+- Line2D.hasIntersectionWithAngle - modulo all angles [`5409aa0`](https://github.com/Immugio/three-math-extensions/commit/5409aa0bc41510efa86d548e91837e44e5b6c343)
 - Add Polygon to exports [`ed66775`](https://github.com/Immugio/three-math-extensions/commit/ed66775c33e961835b23843222b822cfd9c16b1d)
 - Vec2.fromPoint and Vec3.fromPoint should accept null [`4b871af`](https://github.com/Immugio/three-math-extensions/commit/4b871af297bdcbe8584f1e2b99d602247b77687c)
+- 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.4...16.15.10) - 2023-01-02
+## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.6...16.15.10) - 2023-01-02
+
+## [0.2.6](https://github.com/Immugio/three-math-extensions/compare/0.2.5...0.2.6) - 2023-04-14
+
+### Commits
+
+- Improve Line2D.closestPointToPoint, add Vec2.signedAngle [`151f214`](https://github.com/Immugio/three-math-extensions/commit/151f21462e0358057ad8e9d75d5782563a1061f6)
+- Improve documentation [`d0fcb51`](https://github.com/Immugio/three-math-extensions/commit/d0fcb5132f127b4382ac5f7291575a061b8ec121)
+- Excluded files from build [`ec70614`](https://github.com/Immugio/three-math-extensions/commit/ec70614bc7df7a98f854c7a6693365118e04faf7)
+
+## [0.2.5](https://github.com/Immugio/three-math-extensions/compare/0.2.4...0.2.5) - 2023-04-11
 
 ## [0.2.4](https://github.com/Immugio/three-math-extensions/compare/0.2.3...0.2.4) - 2023-04-11
 
@@ -132,19 +149,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 - Release 0.0.4 - tag pattern 4 [`ab9ad4e`](https://github.com/Immugio/three-math-extensions/commit/ab9ad4e49477a991482ed6d4d3a3ca4687a70b44)
 
-## [0.0.7](https://github.com/Immugio/three-math-extensions/compare/0.0.6...0.0.7) - 2022-11-21
-
-## [0.0.6](https://github.com/Immugio/three-math-extensions/compare/0.0.4...0.0.6) - 2022-11-24
-
-### Commits
-
-- Improve API, minor bug fix, improve test coverage [`881a5f0`](https://github.com/Immugio/three-math-extensions/commit/881a5f096823f0d5fd90faa76cd602f076291bc5)
-- Add .npmignore [`f58329a`](https://github.com/Immugio/three-math-extensions/commit/f58329a86b96589bb574d6ebed37d4cc4474663a)
-- Correct change log version [`c6244bf`](https://github.com/Immugio/three-math-extensions/commit/c6244bf1488ad21bcc5589d1dff62c41d8182d48)
-- Release 0.0.4 - tag pattern 6 [`c1c5454`](https://github.com/Immugio/three-math-extensions/commit/c1c54541ed400e1ad49bf42fe8926cd5293efefd)
-- Release 0.0.4 - tag pattern 5 [`5245eed`](https://github.com/Immugio/three-math-extensions/commit/5245eed60195103e989c0fadf9bd642f39ef4589)
-
-## 0.0.4 - 2022-11-21
+## 0.0.7 - 2022-11-21
 
 ### Commits
 
@@ -161,7 +166,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Edit publish script condition [`dc77d89`](https://github.com/Immugio/three-math-extensions/commit/dc77d8978d87daab8732d6429ad1b01ba0ca6f97)
 - CI to use node version 16 [`dc42650`](https://github.com/Immugio/three-math-extensions/commit/dc426508939de922cc0316b7652bbd09aeed4610)
 - Action rename [`26a1f01`](https://github.com/Immugio/three-math-extensions/commit/26a1f014827faab2c02d30ca8ed18dac8f9ff8af)
-- Release 0.0.4 - tag pattern 4 [`ab9ad4e`](https://github.com/Immugio/three-math-extensions/commit/ab9ad4e49477a991482ed6d4d3a3ca4687a70b44)
 - Release 0.0.4 - tag pattern 3 [`d7d4c8f`](https://github.com/Immugio/three-math-extensions/commit/d7d4c8f546e6550868ddd06a5213fdec6c68bcd2)
 - Release 0.0.4 - tag pattern 2 [`0dcf801`](https://github.com/Immugio/three-math-extensions/commit/0dcf80190bd67a3ca93d45131a403201ab39e00f)
 - Release 0.0.4 - tag pattern [`e7f2f76`](https://github.com/Immugio/three-math-extensions/commit/e7f2f76aa247e1c51f0522c300a7aaf07253039c)

package/README.md

@@ -1,8 +1,88 @@
-# Set of utilities for 2d and 3d line math built on top of three.js
+# Set of utilities for 2d and 3d math built on top of three.js
 
 [![Build](https://github.com/Immugio/three-math-extensions/actions/workflows/build.yml/badge.svg)](https://github.com/Immugio/three-math-extensions/actions/workflows/build.yml)
 
+[@immugio/three-math-extensions](README.md) / Exports
+
+# @immugio/three-math-extensions
+
+## 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)
+- [Vec3](docs/classes/Vec3.md)
+
+### Interfaces
+
+- [Point2](docs/interfaces/Point2.md)
+- [Point3](docs/interfaces/Point3.md)
+
+### Variables
+
+- [TwoPI](docs/modules.md#twopi)
+
+### Functions
+
+- [normalizeAngleDegrees](docs/modules.md#normalizeangledegrees)
+- [normalizeAngleRadians](docs/modules.md#normalizeangleradians)
+
+## Variables
+
+### TwoPI
+
+• `Const` **TwoPI**: `number`
+
+#### Defined in
+
+[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/151f214/src/MathConstants.ts#L1)
+
+## Functions
+
+### 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/151f214/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/151f214/src/normalizeAngleRadians.ts#L7)

package/cjs/Line2D.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Line2D = void 0;
 const three_1 = require("three");
 const Vec2_1 = require("./Vec2");
+const three_2 = require("three");
+const MathConstants_1 = require("./MathConstants");
+const _startP = /*@__PURE__*/ new Vec2_1.Vec2();
+const _startEnd = /*@__PURE__*/ new Vec2_1.Vec2();
 class Line2D {
     start;
     end;
@@ -329,34 +333,28 @@ class Line2D {
         return result;
     }
     /**
-     * Returns the closest point parameter on the **infinite** line to the given point.
+     * Returns the closest point on the line to the given point.
      * @param point
+     * @param clampToLine boolean (optional)
+     * @param target Vec2 (optional)
      */
-    closestPointToPointParameterOnInfiniteLine(point) {
-        const startP = new Vec2_1.Vec2().subVectors(point, this.start);
-        const startEnd = new Vec2_1.Vec2().subVectors(this.end, this.start);
-        const startEnd2 = startEnd.dot(startEnd);
-        const startEnd_startP = startEnd.dot(startP);
-        return startEnd_startP / startEnd2;
+    closestPointToPoint(point, clampToLine, target) {
+        const t = this.closestPointToPointParameter(point, clampToLine);
+        return this.delta(target || new Vec2_1.Vec2()).multiplyScalar(t).add(this.start);
     }
-    /**
-     * Returns the closest point on the **infinite** line to the given point.
-     * @param point
-     */
-    closestPointOnInfiniteLine(point) {
-        const t = this.closestPointToPointParameterOnInfiniteLine(point);
-        return new Vec2_1.Vec2().subVectors(this.end, this.start).multiplyScalar(t).add(this.start);
+    delta(target) {
+        return target.subVectors(this.end, this.start);
     }
-    /**
-     * Returns the closest point on the line **section** to the given point.
-     * @param point
-     */
-    closestPointOnLine(point) {
-        const closestPoint = this.closestPointOnInfiniteLine(point);
-        if (this.isPointOnLineSection(closestPoint)) {
-            return closestPoint;
+    closestPointToPointParameter(point, clampToLine) {
+        _startP.subVectors(point, this.start);
+        _startEnd.subVectors(this.end, this.start);
+        const startEnd2 = _startEnd.dot(_startEnd);
+        const startEnd_startP = _startEnd.dot(_startP);
+        let t = startEnd_startP / startEnd2;
+        if (clampToLine) {
+            t = three_2.MathUtils.clamp(t, 0, 1);
         }
-        return closestPoint.distanceTo(this.start) < closestPoint.distanceTo(this.end) ? this.start : this.end;
+        return t;
     }
     /**
      * Returns the distance between the **infinite** line and the point.
@@ -466,11 +464,11 @@ class Line2D {
             return;
         }
         if (!this.isPointOnLineSection(lineToTrim.start)) {
-            const closest = this.closestPointOnLine(lineToTrim.start);
+            const closest = this.closestPointToPoint(lineToTrim.start, true);
             lineToTrim.start.copy(closest);
         }
         if (!this.isPointOnLineSection(lineToTrim.end)) {
-            const closest = this.closestPointOnLine(lineToTrim.end);
+            const closest = this.closestPointToPoint(lineToTrim.end, true);
             lineToTrim.end.copy(closest);
         }
     }
@@ -534,17 +532,21 @@ class Line2D {
         return new Vec2_1.Vec2(x, y);
     }
     /**
-     * Check that the infinite lines intersect and that they are in the specified angle to each other
+     * Check that the line section intersect and that they are in the specified angle to each other
      * @param other Line
      * @param expectedAngleInRads number
+     * @param angleTolerance number
+     * @param distanceTolerance number
      */
-    hasIntersectionWithAngle(other, expectedAngleInRads) {
-        const angle = this.direction.angle();
-        const otherAngle = other.direction.angle();
+    hasIntersectionWithAngle(other, expectedAngleInRads, angleTolerance = Number.EPSILON, distanceTolerance = Number.EPSILON) {
+        const angle = this.direction.angle() % MathConstants_1.TwoPI;
+        const otherAngle = other.direction.angle() % MathConstants_1.TwoPI;
         const actualAngle = Math.abs(angle - otherAngle);
-        if (Math.abs(actualAngle - expectedAngleInRads) < Number.EPSILON) {
+        if (Math.abs(actualAngle - expectedAngleInRads) <= angleTolerance) {
             const intersection = this.intersect(other);
-            if (intersection && this.isPointOnLineSection(intersection) && other.isPointOnLineSection(intersection)) {
+            if (intersection &&
+                this.closestPointToPoint(intersection, true).distanceTo(intersection) <= distanceTolerance &&
+                other.closestPointToPoint(intersection, true).distanceTo(intersection) <= distanceTolerance) {
                 return intersection;
             }
         }

package/cjs/MathConstants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TwoPI = void 0;
+exports.TwoPI = 2 * Math.PI;

package/cjs/Vec2.js

@@ -16,6 +16,13 @@ class Vec2 extends three_1.Vector2 {
     static fromPoint(point) {
         return new Vec2(point?.x, point?.y);
     }
+    /**
+     * Creates a new Vec2[] array from arguments of {x, y} objects.
+      * @param points - The ...{x, y} instances.
+     */
+    static fromPoints(...points) {
+        return points?.map(p => Vec2.fromPoint(p)) ?? [];
+    }
     /**
      * Moves this Vec2 instance towards the target Vec2 by the given amount.
      * @param target - The target Vec2.
@@ -66,5 +73,19 @@ class Vec2 extends three_1.Vector2 {
         const signed_angle = Math.atan2(this.y, this.x) - Math.atan2(0, 1);
         return (0, normalizeAngleRadians_1.normalizeAngleRadians)(signed_angle);
     }
+    /**
+     * check if the angle between the two vectors is close enough to 0 or 180 degrees (same or opposite direction) within the given tolerance
+     * @param other Vector2
+     * @param toleranceRadians number angle tolerance in radians
+     */
+    parallelTo(other, toleranceRadians = 0) {
+        const v1 = this.clone().normalize(); // Normalize both vectors to remove magnitude influence
+        const v2 = other.clone().normalize();
+        const dotProduct = v1.dot(v2); // Calculate the dot product to find the cosine of the angle between the vectors
+        // Calculate the angle in radians
+        const angle = Math.acos(dotProduct);
+        // Check if the angle is within the tolerance of 0 or 180 degrees (Math.PI)
+        return Math.abs(angle) <= toleranceRadians || Math.abs(angle - Math.PI) <= toleranceRadians;
+    }
 }
 exports.Vec2 = Vec2;

package/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeAngleRadians = exports.normalizeAngleDegrees = exports.Rectangle = exports.BoundingBox = exports.Polygon = exports.Size2 = exports.Line3D = exports.Line2D = exports.Vec3 = exports.Vec2 = void 0;
+exports.TwoPI = exports.normalizeAngleRadians = exports.normalizeAngleDegrees = exports.Rectangle = exports.BoundingBox = exports.Polygon = exports.Size2 = exports.Line3D = exports.Line2D = exports.Vec3 = exports.Vec2 = void 0;
 var Vec2_1 = require("./Vec2");
 Object.defineProperty(exports, "Vec2", { enumerable: true, get: function () { return Vec2_1.Vec2; } });
 var Vec3_1 = require("./Vec3");
@@ -21,3 +21,5 @@ var normalizeAngleDegrees_1 = require("./normalizeAngleDegrees");
 Object.defineProperty(exports, "normalizeAngleDegrees", { enumerable: true, get: function () { return normalizeAngleDegrees_1.normalizeAngleDegrees; } });
 var normalizeAngleRadians_1 = require("./normalizeAngleRadians");
 Object.defineProperty(exports, "normalizeAngleRadians", { enumerable: true, get: function () { return normalizeAngleRadians_1.normalizeAngleRadians; } });
+var MathConstants_1 = require("./MathConstants");
+Object.defineProperty(exports, "TwoPI", { enumerable: true, get: function () { return MathConstants_1.TwoPI; } });

package/cjs/normalizeAngleDegrees.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeAngleDegrees = void 0;
+/**
+ * Normalizes an angle in degrees to the range [0, 360].
+ * @param angle in degrees
+ */
 function normalizeAngleDegrees(angle) {
     return ((angle % 360) + 360) % 360;
 }

package/cjs/normalizeAngleRadians.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeAngleRadians = void 0;
+const MathConstants_1 = require("./MathConstants");
+/**
+ * Normalize an angle in radians to the range of 0 to 2π.
+ * @param angle in radians
+ */
 function normalizeAngleRadians(angle) {
-    const twoPi = 2 * Math.PI;
-    angle = angle % twoPi; // Use modulus to get the angle within the range of 0 to 2π
+    angle = angle % MathConstants_1.TwoPI; // Use modulus to get the angle within the range of 0 to 2π
     if (angle < 0) { // Add 2π if the angle is negative
-        angle = angle + twoPi;
+        angle = angle + MathConstants_1.TwoPI;
     }
     return angle;
 }

package/docs/classes/BoundingBox.md

@@ -40,7 +40,7 @@
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/151f214/src/BoundingBox.ts#L4)
 
 ## Properties
 
@@ -50,7 +50,7 @@
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/151f214/src/BoundingBox.ts#L4)
 
 ___
 
@@ -60,7 +60,7 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/151f214/src/BoundingBox.ts#L4)
 
 ___
 
@@ -70,7 +70,7 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/151f214/src/BoundingBox.ts#L4)
 
 ___
 
@@ -80,7 +80,7 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/151f214/src/BoundingBox.ts#L4)
 
 ## Accessors
 
@@ -94,7 +94,7 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:11](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L11)
+[src/BoundingBox.ts:11](https://github.com/Immugio/three-math-extensions/blob/151f214/src/BoundingBox.ts#L11)
 
 ## Methods
 
@@ -114,4 +114,4 @@ ___
 
 #### Defined in
 
-[src/BoundingBox.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L7)
+[src/BoundingBox.ts:7](https://github.com/Immugio/three-math-extensions/blob/151f214/src/BoundingBox.ts#L7)