@immugio/three-math-extensions 0.2.9 → 0.2.11

package/docs/classes/Vec3.md

@@ -72,7 +72,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/151f214/src/Vec3.ts#L65)
+[src/Vec3.ts:65](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L65)
 
 ___
 
@@ -94,7 +94,7 @@ Adds y amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec3.ts:56](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Vec3.ts#L56)
+[src/Vec3.ts:56](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L56)
 
 ___
 
@@ -112,7 +112,7 @@ Vector3.clone
 
 #### Defined in
 
-[src/Vec3.ts:114](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Vec3.ts#L114)
+[src/Vec3.ts:114](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L114)
 
 ___
 
@@ -134,7 +134,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/151f214/src/Vec3.ts#L74)
+[src/Vec3.ts:74](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L74)
 
 ___
 
@@ -156,7 +156,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/151f214/src/Vec3.ts#L98)
+[src/Vec3.ts:98](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L98)
 
 ___
 
@@ -180,7 +180,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/151f214/src/Vec3.ts#L106)
+[src/Vec3.ts:106](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L106)
 
 ___
 
@@ -204,7 +204,7 @@ This Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:43](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Vec3.ts#L43)
+[src/Vec3.ts:43](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L43)
 
 ___
 
@@ -229,7 +229,7 @@ This Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:27](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Vec3.ts#L27)
+[src/Vec3.ts:27](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L27)
 
 ___
 
@@ -245,7 +245,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/151f214/src/Vec3.ts#L90)
+[src/Vec3.ts:90](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L90)
 
 ___
 
@@ -261,7 +261,7 @@ 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/151f214/src/Vec3.ts#L83)
+[src/Vec3.ts:83](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L83)
 
 ___
 
@@ -285,4 +285,4 @@ A new Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:17](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Vec3.ts#L17)
+[src/Vec3.ts:17](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Vec3.ts#L17)

package/docs/interfaces/Point2.md

@@ -17,7 +17,7 @@
 
 #### Defined in
 
-[src/Point2.ts:2](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Point2.ts#L2)
+[src/Point2.ts:2](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point2.ts#L2)
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 #### Defined in
 
-[src/Point2.ts:3](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Point2.ts#L3)
+[src/Point2.ts:3](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point2.ts#L3)

package/docs/interfaces/Point3.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[src/Point3.ts:2](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Point3.ts#L2)
+[src/Point3.ts:2](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point3.ts#L2)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[src/Point3.ts:3](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Point3.ts#L3)
+[src/Point3.ts:3](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point3.ts#L3)
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-[src/Point3.ts:4](https://github.com/Immugio/three-math-extensions/blob/151f214/src/Point3.ts#L4)
+[src/Point3.ts:4](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/Point3.ts#L4)

package/docs/modules.md

@@ -26,6 +26,7 @@
 
 ### Functions
 
+- [isPointInPolygon](modules.md#ispointinpolygon)
 - [normalizeAngleDegrees](modules.md#normalizeangledegrees)
 - [normalizeAngleRadians](modules.md#normalizeangleradians)
 
@@ -37,10 +38,31 @@
 
 #### Defined in
 
-[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/151f214/src/MathConstants.ts#L1)
+[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/MathConstants.ts#L1)
 
 ## Functions
 
+### isPointInPolygon
+
+▸ **isPointInPolygon**(`p`, `point`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `p` | [`Point2`](interfaces/Point2.md)[] |
+| `point` | [`Point2`](interfaces/Point2.md) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/isPointInPolygon.ts:3](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/isPointInPolygon.ts#L3)
+
+___
+
 ### normalizeAngleDegrees
 
 ▸ **normalizeAngleDegrees**(`angle`): `number`
@@ -59,7 +81,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/151f214/src/normalizeAngleDegrees.ts#L5)
+[src/normalizeAngleDegrees.ts:5](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/normalizeAngleDegrees.ts#L5)
 
 ___
 
@@ -81,4 +103,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/151f214/src/normalizeAngleRadians.ts#L7)
+[src/normalizeAngleRadians.ts:7](https://github.com/Immugio/three-math-extensions/blob/66cba15/src/normalizeAngleRadians.ts#L7)

package/esm/Line2D.js

@@ -3,6 +3,7 @@ import { Vec2 } from "./Vec2";
 import { MathUtils } from "three";
 import { TwoPI } from "./MathConstants";
 import { Line3D } from "./Line3D";
+import { directions2d } from "./directions2d";
 const _startP = /*@__PURE__*/ new Vec2();
 const _startEnd = /*@__PURE__*/ new Vec2();
 export class Line2D {
@@ -313,6 +314,16 @@ export 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());
+        const p2 = other.closestPointToPoint(this.end, clampToLine, new 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.
@@ -559,6 +570,13 @@ export class Line2D {
         }
         return null;
     }
+    get isCloserToHorizontal() {
+        const direction = this.direction;
+        return direction.angleTo(directions2d.Right) < Math.PI / 4 || direction.angleTo(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/esm/Vec2.js

@@ -70,6 +70,17 @@ export class Vec2 extends Vector2 {
         const signed_angle = Math.atan2(this.y, this.x) - Math.atan2(0, 1);
         return 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/esm/directions.js

@@ -0,0 +1,9 @@
+import { Vec3 } from "./Vec3";
+export const directions = {
+    North: new Vec3(0, 0, -1),
+    South: new Vec3(0, 0, 1),
+    East: new Vec3(1, 0, 0),
+    West: new Vec3(-1, 0, 0),
+    Up: new Vec3(0, 1, 0),
+    Down: new Vec3(0, -1, 0)
+};

package/esm/directions2d.js

@@ -0,0 +1,7 @@
+import { Vec2 } from "./Vec2";
+export const directions2d = {
+    Up: new Vec2(0, -1),
+    Down: new Vec2(0, 1),
+    Left: new Vec2(-1, 0),
+    Right: new Vec2(1, 0)
+};

package/esm/index.js

@@ -9,3 +9,6 @@ export { Rectangle } from "./Rectangle";
 export { normalizeAngleDegrees } from "./normalizeAngleDegrees";
 export { normalizeAngleRadians } from "./normalizeAngleRadians";
 export { TwoPI } from "./MathConstants";
+export { isPointInPolygon } from "./isPointInPolygon";
+export { directions } from "./directions";
+export { directions2d } from "./directions2d";

package/esm/isPointInPolygon.js

@@ -0,0 +1,12 @@
+export 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;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immugio/three-math-extensions",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "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

@@ -4,6 +4,7 @@ import { Vec2 } from "./Vec2";
 import { MathUtils } from "three";
 import { TwoPI } from "./MathConstants";
 import { Line3D } from "./Line3D";
+import {directions2d} from "./directions2d";
 
 const _startP = /*@__PURE__*/ new Vec2();
 const _startEnd = /*@__PURE__*/ new Vec2();
@@ -368,6 +369,18 @@ export 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
+     */
+    public projectOn(other: Line2D, clampToLine: boolean): Line2D {
+        const p1 = other.closestPointToPoint(this.start, clampToLine, new Vec2());
+        const p2 = other.closestPointToPoint(this.end, clampToLine, new 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.
@@ -660,6 +673,15 @@ export class Line2D {
         return null;
     }
 
+    public get isCloserToHorizontal(): boolean {
+        const direction = this.direction;
+        return direction.angleTo(directions2d.Right) < Math.PI / 4 || direction.angleTo(directions2d.Left) < Math.PI / 4;
+    }
+
+    public  get isCloserToVertical(): boolean {
+        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/src/Vec2.ts

@@ -1,7 +1,7 @@
-import { Vector2 } from "three";
-import { Vec3 } from "./Vec3";
-import { Point2 } from "./Point2";
-import { normalizeAngleRadians } from "./normalizeAngleRadians";
+import {Vector2} from "three";
+import {Vec3} from "./Vec3";
+import {Point2} from "./Point2";
+import {normalizeAngleRadians} from "./normalizeAngleRadians";
 
 /**
  * Vec2 represents a 2D vector. It extends `Vector2` from the `threejs` library.
@@ -81,6 +81,19 @@ export class Vec2 extends Vector2 {
         return 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
+     */
+    public angleTo(other: Vector2): number {
+        // 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/src/directions.ts

@@ -0,0 +1,10 @@
+import { Vec3 } from "./Vec3";
+
+export const directions = {
+    North: new Vec3(0, 0, -1),
+    South: new Vec3(0, 0, 1),
+    East: new Vec3(1, 0, 0),
+    West: new Vec3(-1, 0, 0),
+    Up: new Vec3(0, 1, 0),
+    Down: new Vec3(0, -1, 0)
+};

package/src/directions2d.ts

@@ -0,0 +1,8 @@
+import { Vec2 } from "./Vec2";
+
+export const directions2d = {
+    Up: new Vec2(0, -1),
+    Down: new Vec2(0, 1),
+    Left: new Vec2(-1, 0),
+    Right: new Vec2(1, 0)
+};

package/src/index.ts

@@ -10,4 +10,7 @@ export { normalizeAngleDegrees } from "./normalizeAngleDegrees";
 export { normalizeAngleRadians } from "./normalizeAngleRadians";
 export { TwoPI } from "./MathConstants";
 export { Point2 } from "./Point2";
-export { Point3 } from "./Point3";
+export { Point3 } from "./Point3";
+export { isPointInPolygon } from "./isPointInPolygon";
+export { directions } from "./directions";
+export { directions2d } from "./directions2d";

package/src/isPointInPolygon.ts

@@ -0,0 +1,19 @@
+import { Point2 } from "./Point2";
+
+export function isPointInPolygon(p: Point2[], point: Point2): boolean {
+
+    const x = point.x, y = point.y;
+
+    let i: number, j: number, 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;
+}

package/types/Line2D.d.ts

@@ -138,6 +138,12 @@ export declare class Line2D {
      * @param lines
      */
     static joinLines(lines: Line2D[]): Line2D[];
+    /**
+     * 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: Line2D, clampToLine: boolean): Line2D;
     /**
      * Divides the Line3D into a number of segments of the given length.
      * Clone the line, does not modify.
@@ -212,6 +218,8 @@ export declare class Line2D {
      * @param distanceTolerance number
      */
     hasIntersectionWithAngle(other: Line2D, expectedAngleInRads: number, angleTolerance?: number, distanceTolerance?: number): Vec2;
+    get isCloserToHorizontal(): boolean;
+    get isCloserToVertical(): boolean;
     /**
      * 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/types/Vec2.d.ts

@@ -44,6 +44,12 @@ export declare class Vec2 extends Vector2 {
      * Returns the angle between this vector and positive x-axis, the return value is between 0 and 2PI
      */
     signedAngle(): number;
+    /**
+     * 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: Vector2): number;
     /**
      * 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/types/directions.d.ts

@@ -0,0 +1,9 @@
+import { Vec3 } from "./Vec3";
+export declare const directions: {
+    North: Vec3;
+    South: Vec3;
+    East: Vec3;
+    West: Vec3;
+    Up: Vec3;
+    Down: Vec3;
+};

package/types/directions2d.d.ts

@@ -0,0 +1,7 @@
+import { Vec2 } from "./Vec2";
+export declare const directions2d: {
+    Up: Vec2;
+    Down: Vec2;
+    Left: Vec2;
+    Right: Vec2;
+};

package/types/index.d.ts

@@ -11,3 +11,6 @@ export { normalizeAngleRadians } from "./normalizeAngleRadians";
 export { TwoPI } from "./MathConstants";
 export { Point2 } from "./Point2";
 export { Point3 } from "./Point3";
+export { isPointInPolygon } from "./isPointInPolygon";
+export { directions } from "./directions";
+export { directions2d } from "./directions2d";

package/types/isPointInPolygon.d.ts

@@ -0,0 +1,2 @@
+import { Point2 } from "./Point2";
+export declare function isPointInPolygon(p: Point2[], point: Point2): boolean;