@immugio/three-math-extensions 0.2.21 → 0.2.23

package/docs/classes/Vec3.md

@@ -1,4 +1,4 @@
-[@immugio/three-math-extensions](../README.md) / [Exports](../modules.md) / Vec3
+[@immugio/three-math-extensions](../../README.md) / [Exports](../modules.md) / Vec3
 
 # Class: Vec3
 
@@ -20,6 +20,7 @@ Vec3 represents a 3D vector. It extends `Vector3` from the `threejs` library.
 
 - [addX](Vec3.md#addx)
 - [addY](Vec3.md#addy)
+- [addZ](Vec3.md#addz)
 - [clone](Vec3.md#clone)
 - [closest](Vec3.md#closest)
 - [horizontalDistanceTo](Vec3.md#horizontaldistanceto)
@@ -29,12 +30,13 @@ Vec3 represents a 3D vector. It extends `Vector3` from the `threejs` library.
 - [onPlan](Vec3.md#onplan)
 - [toPointWithFlippedYZ](Vec3.md#topointwithflippedyz)
 - [fromPoint](Vec3.md#frompoint)
+- [fromPoints](Vec3.md#frompoints)
 
 ## Constructors
 
 ### constructor
 
-• **new Vec3**(`x?`, `y?`, `z?`)
+• **new Vec3**(`x?`, `y?`, `z?`): [`Vec3`](Vec3.md)
 
 #### Parameters
 
@@ -44,13 +46,17 @@ Vec3 represents a 3D vector. It extends `Vector3` from the `threejs` library.
 | `y?` | `number` |
 | `z?` | `number` |
 
+#### Returns
+
+[`Vec3`](Vec3.md)
+
 #### Inherited from
 
 Vector3.constructor
 
 #### Defined in
 
-node_modules/@types/three/src/math/Vector3.d.ts:26
+node_modules/@types/three/src/math/Vector3.d.ts:27
 
 ## Methods
 
@@ -72,7 +78,7 @@ Adds x amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec3.ts:65](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L65)
+[src/Vec3.ts:73](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L73)
 
 ___
 
@@ -94,7 +100,29 @@ Adds y amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec3.ts:56](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L56)
+[src/Vec3.ts:64](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L64)
+
+___
+
+### addZ
+
+▸ **addZ**(`z`): [`Vec3`](Vec3.md)
+
+Adds z amount to this Vec3 instance and return this
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `z` | `number` |
+
+#### Returns
+
+[`Vec3`](Vec3.md)
+
+#### Defined in
+
+[src/Vec3.ts:82](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L82)
 
 ___
 
@@ -112,7 +140,7 @@ Vector3.clone
 
 #### Defined in
 
-[src/Vec3.ts:114](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L114)
+[src/Vec3.ts:131](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L131)
 
 ___
 
@@ -134,7 +162,7 @@ Returns a clone of the point closest to this from the given points.
 
 #### Defined in
 
-[src/Vec3.ts:74](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L74)
+[src/Vec3.ts:91](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L91)
 
 ___
 
@@ -156,7 +184,7 @@ Get distance to another vector while ignoring the y-axis.
 
 #### Defined in
 
-[src/Vec3.ts:98](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L98)
+[src/Vec3.ts:115](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L115)
 
 ___
 
@@ -180,7 +208,7 @@ maxDistance is the maximum distance between the two vectors within which they ar
 
 #### Defined in
 
-[src/Vec3.ts:106](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L106)
+[src/Vec3.ts:123](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L123)
 
 ___
 
@@ -204,7 +232,7 @@ This Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:43](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L43)
+[src/Vec3.ts:51](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L51)
 
 ___
 
@@ -229,7 +257,7 @@ This Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:27](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L27)
+[src/Vec3.ts:35](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L35)
 
 ___
 
@@ -245,7 +273,7 @@ Projects this Vec3 instance onto 2d plan. Vec3.z becomes Vec2.y and Vec3.y is ig
 
 #### Defined in
 
-[src/Vec3.ts:90](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L90)
+[src/Vec3.ts:107](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L107)
 
 ___
 
@@ -261,13 +289,13 @@ Returns a clone of this Vec3 instance with y and z swapped.
 
 #### Defined in
 
-[src/Vec3.ts:83](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L83)
+[src/Vec3.ts:100](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L100)
 
 ___
 
 ### fromPoint
 
-▸ `Static` **fromPoint**(`point`): [`Vec3`](Vec3.md)
+▸ **fromPoint**(`point`): [`Vec3`](Vec3.md)
 
 Creates a new Vec3 instance from an {x, y, z} object.
 
@@ -285,4 +313,26 @@ A new Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:17](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L17)
+[src/Vec3.ts:17](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L17)
+
+___
+
+### fromPoints
+
+▸ **fromPoints**(`...points`): [`Vec3`](Vec3.md)[]
+
+Creates a new Vec3[] array from arguments of {x, y, z} objects.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `...points` | [`Point3`](../interfaces/Point3.md)[] | The ...{x, y, z} instances. |
+
+#### Returns
+
+[`Vec3`](Vec3.md)[]
+
+#### Defined in
+
+[src/Vec3.ts:25](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L25)

package/docs/interfaces/Point2.md

@@ -1,4 +1,4 @@
-[@immugio/three-math-extensions](../README.md) / [Exports](../modules.md) / Point2
+[@immugio/three-math-extensions](../../README.md) / [Exports](../modules.md) / Point2
 
 # Interface: Point2
 
@@ -17,7 +17,7 @@
 
 #### Defined in
 
-[src/Point2.ts:2](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point2.ts#L2)
+[src/Point2.ts:2](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point2.ts#L2)
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 #### Defined in
 
-[src/Point2.ts:3](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point2.ts#L3)
+[src/Point2.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point2.ts#L3)

package/docs/interfaces/Point3.md

@@ -1,4 +1,4 @@
-[@immugio/three-math-extensions](../README.md) / [Exports](../modules.md) / Point3
+[@immugio/three-math-extensions](../../README.md) / [Exports](../modules.md) / Point3
 
 # Interface: Point3
 
@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[src/Point3.ts:2](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point3.ts#L2)
+[src/Point3.ts:2](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point3.ts#L2)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[src/Point3.ts:3](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point3.ts#L3)
+[src/Point3.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point3.ts#L3)
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-[src/Point3.ts:4](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point3.ts#L4)
+[src/Point3.ts:4](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point3.ts#L4)

package/docs/modules.md

@@ -1,4 +1,4 @@
-[@immugio/three-math-extensions](README.md) / Exports
+[@immugio/three-math-extensions](../README.md) / Exports
 
 # @immugio/three-math-extensions
 
@@ -22,26 +22,107 @@
 
 ### Variables
 
+- [HalfPI](modules.md#halfpi)
 - [TwoPI](modules.md#twopi)
+- [directions](modules.md#directions)
+- [directions2d](modules.md#directions2d)
 
 ### Functions
 
+- [isContinuousClosedShape](modules.md#iscontinuousclosedshape)
 - [isPointInPolygon](modules.md#ispointinpolygon)
 - [normalizeAngleDegrees](modules.md#normalizeangledegrees)
 - [normalizeAngleRadians](modules.md#normalizeangleradians)
 
 ## Variables
 
+### HalfPI
+
+• `Const` **HalfPI**: `number`
+
+#### Defined in
+
+[src/MathConstants.ts:2](https://github.com/Immugio/three-math-extensions/blob/336678b/src/MathConstants.ts#L2)
+
+___
+
 ### TwoPI
 
 • `Const` **TwoPI**: `number`
 
 #### Defined in
 
-[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/MathConstants.ts#L1)
+[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/336678b/src/MathConstants.ts#L1)
+
+___
+
+### directions
+
+• `Const` **directions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Down` | [`Vec3`](classes/Vec3.md) |
+| `East` | [`Vec3`](classes/Vec3.md) |
+| `North` | [`Vec3`](classes/Vec3.md) |
+| `South` | [`Vec3`](classes/Vec3.md) |
+| `Up` | [`Vec3`](classes/Vec3.md) |
+| `West` | [`Vec3`](classes/Vec3.md) |
+
+#### Defined in
+
+[src/directions.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/directions.ts#L3)
+
+___
+
+### directions2d
+
+• `Const` **directions2d**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `Down` | [`Vec2`](classes/Vec2.md) |
+| `Left` | [`Vec2`](classes/Vec2.md) |
+| `Right` | [`Vec2`](classes/Vec2.md) |
+| `Up` | [`Vec2`](classes/Vec2.md) |
+
+#### Defined in
+
+[src/directions2d.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/directions2d.ts#L3)
 
 ## Functions
 
+### isContinuousClosedShape
+
+▸ **isContinuousClosedShape**\<`T`\>(`lines`, `tolerance?`): `boolean`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`Line3D`](classes/Line3D.md) \| [`Line2D`](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/336678b/src/isContinuousClosedShape.ts#L4)
+
+___
+
 ### isPointInPolygon
 
 ▸ **isPointInPolygon**(`p`, `point`): `boolean`
@@ -59,7 +140,7 @@
 
 #### Defined in
 
-[src/isPointInPolygon.ts:3](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/isPointInPolygon.ts#L3)
+[src/isPointInPolygon.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/isPointInPolygon.ts#L3)
 
 ___
 
@@ -81,7 +162,7 @@ Normalizes an angle in degrees to the range [0, 360].
 
 #### Defined in
 
-[src/normalizeAngleDegrees.ts:5](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/normalizeAngleDegrees.ts#L5)
+[src/normalizeAngleDegrees.ts:5](https://github.com/Immugio/three-math-extensions/blob/336678b/src/normalizeAngleDegrees.ts#L5)
 
 ___
 
@@ -103,4 +184,4 @@ Normalize an angle in radians to the range of 0 to 2π.
 
 #### Defined in
 
-[src/normalizeAngleRadians.ts:7](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/normalizeAngleRadians.ts#L7)
+[src/normalizeAngleRadians.ts:7](https://github.com/Immugio/three-math-extensions/blob/336678b/src/normalizeAngleRadians.ts#L7)

package/esm/Line2D.js

@@ -1,6 +1,5 @@
-import { Vector2 } from "three";
+import { MathUtils, Vector2 } from "three";
 import { Vec2 } from "./Vec2";
-import { MathUtils } from "three";
 import { TwoPI } from "./MathConstants";
 import { Line3D } from "./Line3D";
 import { directions2d } from "./directions2d";
@@ -10,6 +9,7 @@ export class Line2D {
     start;
     end;
     index;
+    #target = new Vec2();
     constructor(start, end, index = 0) {
         this.start = start;
         this.end = end;
@@ -138,6 +138,41 @@ export 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 a copy of @other line, the direction of @other is reversed if needed.
+     * Returns null if lines are not parallel.
+     * @param other
+     * @param parallelTolerance
+     */
+    getParallelLineInTheSameDirection(other, parallelTolerance = 0) {
+        const direction = this.direction;
+        if (direction.angleTo(other.direction) <= parallelTolerance) {
+            return other.clone();
+        }
+        const otherLineOppositeDirection = other.clone().flip();
+        if (otherLineOppositeDirection.direction.angleTo(direction) <= parallelTolerance) {
+            return otherLineOppositeDirection;
+        }
+        return null;
+    }
     /**
      * Returns the direction of this line.
      */
@@ -149,9 +184,9 @@ export class Line2D {
      * Modifies this line.
      */
     flip() {
-        const temp = this.start.clone();
+        this.#target.copy(this.start);
         this.start.copy(this.end);
-        this.end.copy(temp);
+        this.end.copy(this.#target);
         return this;
     }
     /**
@@ -245,14 +280,32 @@ export 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.
@@ -324,6 +377,17 @@ export 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
@@ -640,8 +704,11 @@ export class Line2D {
     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);
+    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/esm/Line3D.js

@@ -250,7 +250,7 @@ export class Line3D extends 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/package.json

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