@immugio/three-math-extensions 0.2.7 → 0.2.9

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.7](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.7)
+## [0.2.9](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.9)
 
 ### Commits
 
@@ -19,15 +19,34 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - 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)
 - 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)
+- 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)
 - 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.6...16.15.10) - 2023-01-02
+## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.8...16.15.10) - 2023-01-02
+
+## [0.2.8](https://github.com/Immugio/three-math-extensions/compare/0.2.7...0.2.8) - 2023-05-19
+
+### Commits
+
+- Line2D.in3DSpace added [`a6ce0ec`](https://github.com/Immugio/three-math-extensions/commit/a6ce0ecb67f5c7b2a75fcc283c28af626153a4af)
+- Update release instructions [`5b41a2e`](https://github.com/Immugio/three-math-extensions/commit/5b41a2ed7e15450dbb6088a7f7ed0031a013badc)
+
+## [0.2.7](https://github.com/Immugio/three-math-extensions/compare/0.2.6...0.2.7) - 2023-04-26
+
+### Commits
+
+- 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.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)
 
 ## [0.2.6](https://github.com/Immugio/three-math-extensions/compare/0.2.5...0.2.6) - 2023-04-14
 

package/cjs/Line2D.js

@@ -5,6 +5,7 @@ const three_1 = require("three");
 const Vec2_1 = require("./Vec2");
 const three_2 = require("three");
 const MathConstants_1 = require("./MathConstants");
+const Line3D_1 = require("./Line3D");
 const _startP = /*@__PURE__*/ new Vec2_1.Vec2();
 const _startEnd = /*@__PURE__*/ new Vec2_1.Vec2();
 class Line2D {
@@ -513,9 +514,11 @@ class Line2D {
         return this;
     }
     /**
-     * Returns the intersection point of two lines. The lines are assumed to be infinite.
+     * Returns the intersection point of two lines.
+     * @param other
+     * @param lineSegmentOnly If true, only return the intersection if it is within the line segments. Otherwise, return the intersection if the lines intersect anywhere.
      */
-    intersect(other) {
+    intersect(other, lineSegmentOnly) {
         // Check if none of the lines are of length 0
         if ((this.start.x === this.end.x && this.start.y === this.end.y) || (other.start.x === other.end.x && other.start.y === other.end.y)) {
             return null;
@@ -526,6 +529,13 @@ class Line2D {
             return null;
         }
         const ua = ((other.end.x - other.start.x) * (this.start.y - other.start.y) - (other.end.y - other.start.y) * (this.start.x - other.start.x)) / denominator;
+        // Check if the intersection point is within the bounds of the line segments if required
+        if (lineSegmentOnly) {
+            const ub = ((this.end.x - this.start.x) * (this.start.y - other.start.y) - (this.end.y - this.start.y) * (this.start.x - other.start.x)) / denominator;
+            if (ua < 0 || ua > 1 || ub < 0 || ub > 1) {
+                return null;
+            }
+        }
         // Return an object with the x and y coordinates of the intersection
         const x = this.start.x + ua * (this.end.x - this.start.x);
         const y = this.start.y + ua * (this.end.y - this.start.y);
@@ -552,6 +562,14 @@ class Line2D {
         }
         return null;
     }
+    /**
+     * 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.
+     * @returns A new Line3D instance.
+     */
+    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);
     }

package/esm/Line2D.js

@@ -2,6 +2,7 @@ import { Vector2 } from "three";
 import { Vec2 } from "./Vec2";
 import { MathUtils } from "three";
 import { TwoPI } from "./MathConstants";
+import { Line3D } from "./Line3D";
 const _startP = /*@__PURE__*/ new Vec2();
 const _startEnd = /*@__PURE__*/ new Vec2();
 export class Line2D {
@@ -510,9 +511,11 @@ export class Line2D {
         return this;
     }
     /**
-     * Returns the intersection point of two lines. The lines are assumed to be infinite.
+     * Returns the intersection point of two lines.
+     * @param other
+     * @param lineSegmentOnly If true, only return the intersection if it is within the line segments. Otherwise, return the intersection if the lines intersect anywhere.
      */
-    intersect(other) {
+    intersect(other, lineSegmentOnly) {
         // Check if none of the lines are of length 0
         if ((this.start.x === this.end.x && this.start.y === this.end.y) || (other.start.x === other.end.x && other.start.y === other.end.y)) {
             return null;
@@ -523,6 +526,13 @@ export class Line2D {
             return null;
         }
         const ua = ((other.end.x - other.start.x) * (this.start.y - other.start.y) - (other.end.y - other.start.y) * (this.start.x - other.start.x)) / denominator;
+        // Check if the intersection point is within the bounds of the line segments if required
+        if (lineSegmentOnly) {
+            const ub = ((this.end.x - this.start.x) * (this.start.y - other.start.y) - (this.end.y - this.start.y) * (this.start.x - other.start.x)) / denominator;
+            if (ua < 0 || ua > 1 || ub < 0 || ub > 1) {
+                return null;
+            }
+        }
         // Return an object with the x and y coordinates of the intersection
         const x = this.start.x + ua * (this.end.x - this.start.x);
         const y = this.start.y + ua * (this.end.y - this.start.y);
@@ -549,6 +559,14 @@ export class Line2D {
         }
         return null;
     }
+    /**
+     * 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.
+     * @returns A new Line3D instance.
+     */
+    in3DSpace(y = 0) {
+        return new Line3D(this.start.in3DSpace(y), this.end.in3DSpace(y));
+    }
     equals(other) {
         return !!other && this.start.equals(other.start) && this.end.equals(other.end);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immugio/three-math-extensions",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "description": "Set of utilities for 2d and 3d line math built on top of three.js",
   "author": "Jan Mikeska <janmikeska@gmail.com>",
   "license": "ISC",

package/src/Line2D.ts

@@ -3,6 +3,7 @@ import { Vector2 } from "three";
 import { Vec2 } from "./Vec2";
 import { MathUtils } from "three";
 import { TwoPI } from "./MathConstants";
+import { Line3D } from "./Line3D";
 
 const _startP = /*@__PURE__*/ new Vec2();
 const _startEnd = /*@__PURE__*/ new Vec2();
@@ -599,9 +600,11 @@ export class Line2D {
     }
 
     /**
-     * Returns the intersection point of two lines. The lines are assumed to be infinite.
+     * Returns the intersection point of two lines.
+     * @param other
+     * @param lineSegmentOnly If true, only return the intersection if it is within the line segments. Otherwise, return the intersection if the lines intersect anywhere.
      */
-    public intersect(other: Line2D): Vec2 {
+    public intersect(other: Line2D, lineSegmentOnly?: boolean): Vec2 {
         // Check if none of the lines are of length 0
         if ((this.start.x === this.end.x && this.start.y === this.end.y) || (other.start.x === other.end.x && other.start.y === other.end.y)) {
             return null;
@@ -616,6 +619,14 @@ export class Line2D {
 
         const ua = ((other.end.x - other.start.x) * (this.start.y - other.start.y) - (other.end.y - other.start.y) * (this.start.x - other.start.x)) / denominator;
 
+        // Check if the intersection point is within the bounds of the line segments if required
+        if (lineSegmentOnly) {
+            const ub = ((this.end.x - this.start.x) * (this.start.y - other.start.y) - (this.end.y - this.start.y) * (this.start.x - other.start.x)) / denominator;
+            if (ua < 0 || ua > 1 || ub < 0 || ub > 1) {
+                return null;
+            }
+        }
+
         // Return an object with the x and y coordinates of the intersection
         const x = this.start.x + ua * (this.end.x - this.start.x);
         const y = this.start.y + ua * (this.end.y - this.start.y);
@@ -649,6 +660,15 @@ export class Line2D {
         return null;
     }
 
+    /**
+     * 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.
+     * @returns A new Line3D instance.
+     */
+    public in3DSpace(y: number = 0): Line3D {
+        return new Line3D(this.start.in3DSpace(y), this.end.in3DSpace(y));
+    }
+
     public equals(other: Line2D): boolean {
         return !!other && this.start.equals(other.start) && this.end.equals(other.end);
     }

package/types/Line2D.d.ts

@@ -1,6 +1,7 @@
 import { Point2 } from "./Point2";
 import { Vector2 } from "three";
 import { Vec2 } from "./Vec2";
+import { Line3D } from "./Line3D";
 export declare class Line2D {
     start: Vec2;
     end: Vec2;
@@ -198,9 +199,11 @@ export declare class Line2D {
      */
     extendToOrTrimAtIntersection(other: Line2D, maxDistanceToIntersection?: number): this;
     /**
-     * Returns the intersection point of two lines. The lines are assumed to be infinite.
+     * Returns the intersection point of two lines.
+     * @param other
+     * @param lineSegmentOnly If true, only return the intersection if it is within the line segments. Otherwise, return the intersection if the lines intersect anywhere.
      */
-    intersect(other: Line2D): Vec2;
+    intersect(other: Line2D, lineSegmentOnly?: boolean): Vec2;
     /**
      * Check that the line section intersect and that they are in the specified angle to each other
      * @param other Line
@@ -209,6 +212,12 @@ export declare class Line2D {
      * @param distanceTolerance number
      */
     hasIntersectionWithAngle(other: Line2D, expectedAngleInRads: number, angleTolerance?: number, distanceTolerance?: number): Vec2;
+    /**
+     * 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.
+     * @returns A new Line3D instance.
+     */
+    in3DSpace(y?: number): Line3D;
     equals(other: Line2D): boolean;
     /**
      * Deep clone of this line