@immugio/three-math-extensions 0.2.9 → 0.2.11

package/CHANGELOG.md

@@ -7,30 +7,48 @@ 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.9](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.9)
+## [0.2.11](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.11)
 
 ### Commits
 
 - Add Rectangle, update Polygon [`58ee875`](https://github.com/Immugio/three-math-extensions/commit/58ee87539af8f9ade186e5250cba9e01926da514)
+- Add isPointInPolygon [`a59eb4b`](https://github.com/Immugio/three-math-extensions/commit/a59eb4be026f17a3106070ae626a0588cd4f4411)
 - 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)
+- Line2D.isCloserToHorizontal [`b6f1429`](https://github.com/Immugio/three-math-extensions/commit/b6f14292d1d2765f7314c45e4c74be91280ac764)
+- Add Vec2.angleTo and tests [`dcf1e53`](https://github.com/Immugio/three-math-extensions/commit/dcf1e531aecf8c115f323e14e5e44059e5c5d15c)
 - 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)
 - Line2D.intersect - enable line segments intersection only [`1f1470e`](https://github.com/Immugio/three-math-extensions/commit/1f1470e1cf00118e643f5c44a135e0baf6b76d41)
+- Add Line2D.projectOn [`4c52c5c`](https://github.com/Immugio/three-math-extensions/commit/4c52c5c2e649fbddb72ce3fca60cfd3f1319f72f)
 - 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.in3DSpace added [`a6ce0ec`](https://github.com/Immugio/three-math-extensions/commit/a6ce0ecb67f5c7b2a75fcc283c28af626153a4af)
 - 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)
+- Use Vec2 instead of Vector2 [`7e6a6ea`](https://github.com/Immugio/three-math-extensions/commit/7e6a6ea272f4441ef4bc78b3fdec23fc783fa1db)
 - Update release instructions [`5b41a2e`](https://github.com/Immugio/three-math-extensions/commit/5b41a2ed7e15450dbb6088a7f7ed0031a013badc)
 - 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)
+- 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.8...16.15.10) - 2023-01-02
+## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.10...16.15.10) - 2023-01-02
+
+## [0.2.10](https://github.com/Immugio/three-math-extensions/compare/0.2.9...0.2.10) - 2023-05-30
+
+### Commits
+
+- Add isPointInPolygon [`a59eb4b`](https://github.com/Immugio/three-math-extensions/commit/a59eb4be026f17a3106070ae626a0588cd4f4411)
+
+## [0.2.9](https://github.com/Immugio/three-math-extensions/compare/0.2.8...0.2.9) - 2023-05-22
+
+### Commits
+
+- Line2D.intersect - enable line segments intersection only [`1f1470e`](https://github.com/Immugio/three-math-extensions/commit/1f1470e1cf00118e643f5c44a135e0baf6b76d41)
 
 ## [0.2.8](https://github.com/Immugio/three-math-extensions/compare/0.2.7...0.2.8) - 2023-05-19
 
@@ -168,7 +186,19 @@ 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 - 2022-11-21
+## [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
 
 ### Commits
 
@@ -185,6 +215,7 @@ 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

@@ -6,83 +6,4 @@
 
 # @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)
-
-### 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)
+## [Documentation](docs/modules.md)

package/cjs/Line2D.js

@@ -6,6 +6,7 @@ const Vec2_1 = require("./Vec2");
 const three_2 = require("three");
 const MathConstants_1 = require("./MathConstants");
 const Line3D_1 = require("./Line3D");
+const directions2d_1 = require("./directions2d");
 const _startP = /*@__PURE__*/ new Vec2_1.Vec2();
 const _startEnd = /*@__PURE__*/ new Vec2_1.Vec2();
 class Line2D {
@@ -316,6 +317,16 @@ class Line2D {
         }
         return result;
     }
+    /**
+     * Returns a new line that is the projection of this line onto @other. Uses `closestPointToPoint` to find the projection.
+     * @param other
+     * @param clampToLine
+     */
+    projectOn(other, clampToLine) {
+        const p1 = other.closestPointToPoint(this.start, clampToLine, new Vec2_1.Vec2());
+        const p2 = other.closestPointToPoint(this.end, clampToLine, new Vec2_1.Vec2());
+        return p1.distanceTo(this.start) < p2.distanceTo(this.start) ? new Line2D(p1, p2) : new Line2D(p2, p1);
+    }
     /**
      * Divides the Line3D into a number of segments of the given length.
      * Clone the line, does not modify.
@@ -562,6 +573,13 @@ class Line2D {
         }
         return null;
     }
+    get isCloserToHorizontal() {
+        const direction = this.direction;
+        return direction.angleTo(directions2d_1.directions2d.Right) < Math.PI / 4 || direction.angleTo(directions2d_1.directions2d.Left) < Math.PI / 4;
+    }
+    get isCloserToVertical() {
+        return !this.isCloserToHorizontal;
+    }
     /**
      * Project the line to 2D space. For start and end points Vec2.y becomes Vec3.z. and Vec3.y is provided as an argument.
      * @param y - The y value of the new Vec3 instance.

package/cjs/Vec2.js

@@ -73,6 +73,17 @@ 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);
     }
+    /**
+     * Returns the angle between this vector and the given vector, the return value is between 0 and PI
+     * Both vectors are expected to be normalized
+     * @param other Vector2 normalized vector
+     */
+    angleTo(other) {
+        // Calculate the dot product of the vectors
+        const dot = this.dot(other);
+        // Calculate the angle in radians between the two vectors
+        return Math.acos(Math.min(Math.max(dot, -1.0), 1.0));
+    }
     /**
      * 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

package/cjs/directions.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.directions = void 0;
+const Vec3_1 = require("./Vec3");
+exports.directions = {
+    North: new Vec3_1.Vec3(0, 0, -1),
+    South: new Vec3_1.Vec3(0, 0, 1),
+    East: new Vec3_1.Vec3(1, 0, 0),
+    West: new Vec3_1.Vec3(-1, 0, 0),
+    Up: new Vec3_1.Vec3(0, 1, 0),
+    Down: new Vec3_1.Vec3(0, -1, 0)
+};

package/cjs/directions2d.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.directions2d = void 0;
+const Vec2_1 = require("./Vec2");
+exports.directions2d = {
+    Up: new Vec2_1.Vec2(0, -1),
+    Down: new Vec2_1.Vec2(0, 1),
+    Left: new Vec2_1.Vec2(-1, 0),
+    Right: new Vec2_1.Vec2(1, 0)
+};

package/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TwoPI = exports.normalizeAngleRadians = exports.normalizeAngleDegrees = exports.Rectangle = exports.BoundingBox = exports.Polygon = exports.Size2 = exports.Line3D = exports.Line2D = exports.Vec3 = exports.Vec2 = void 0;
+exports.directions2d = exports.directions = exports.isPointInPolygon = 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");
@@ -23,3 +23,9 @@ 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; } });
+var isPointInPolygon_1 = require("./isPointInPolygon");
+Object.defineProperty(exports, "isPointInPolygon", { enumerable: true, get: function () { return isPointInPolygon_1.isPointInPolygon; } });
+var directions_1 = require("./directions");
+Object.defineProperty(exports, "directions", { enumerable: true, get: function () { return directions_1.directions; } });
+var directions2d_1 = require("./directions2d");
+Object.defineProperty(exports, "directions2d", { enumerable: true, get: function () { return directions2d_1.directions2d; } });

package/cjs/isPointInPolygon.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPointInPolygon = void 0;
+function isPointInPolygon(p, point) {
+    const x = point.x, y = point.y;
+    let i, j, c = false;
+    for (i = 0, j = p.length - 1; i < p.length; j = i++) {
+        if ((((p[i].y <= y) && (y < p[j].y)) ||
+            ((p[j].y <= y) && (y < p[i].y))) &&
+            (x < (p[j].x - p[i].x) * (y - p[i].y) / (p[j].y - p[i].y) + p[i].x)) {
+            c = !c;
+        }
+    }
+    return c;
+}
+exports.isPointInPolygon = isPointInPolygon;

package/docs/README.md

@@ -1,5 +1,90 @@
 @immugio/three-math-extensions / [Exports](modules.md)
 
-# 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)
+
+### 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/docs/classes/BoundingBox.md

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