@immugio/three-math-extensions 0.2.1 → 0.2.4

package/CHANGELOG.md

@@ -7,18 +7,32 @@ 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.1](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.1)
+## [0.2.3](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.3)
 
 ### Commits
 
 - Add Rectangle, update Polygon [`58ee875`](https://github.com/Immugio/three-math-extensions/commit/58ee87539af8f9ade186e5250cba9e01926da514)
 - 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)
 - 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)
 - 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)
 
-## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.0...16.15.10) - 2023-01-02
+## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.2...16.15.10) - 2023-01-02
+
+## [0.2.2](https://github.com/Immugio/three-math-extensions/compare/0.2.1...0.2.2) - 2023-04-11
+
+### Commits
+
+- Line2D and Line3D to return this instead of specific type [`761ef6a`](https://github.com/Immugio/three-math-extensions/commit/761ef6a9d8cc4e35120b666576794e521aa3b991)
+
+## [0.2.1](https://github.com/Immugio/three-math-extensions/compare/0.2.0...0.2.1) - 2023-03-28
+
+### Commits
+
+- Polygon from bounding size [`eae6701`](https://github.com/Immugio/three-math-extensions/commit/eae67012f57f426f8b5259b765000447ce06d608)
 
 ## [0.2.0](https://github.com/Immugio/three-math-extensions/compare/0.1.1...0.2.0) - 2023-02-28
 

package/cjs/Vec2.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Vec2 = void 0;
 const three_1 = require("three");
 const Vec3_1 = require("./Vec3");
+const normalizeAngleRadians_1 = require("./normalizeAngleRadians");
 /**
  * Vec2 represents a 2D vector. It extends `Vector2` from the `threejs` library.
  */
@@ -58,5 +59,12 @@ class Vec2 extends three_1.Vector2 {
         }
         return this.distanceTo(v) <= maxDistance;
     }
+    /**
+     * Returns the angle between this vector and positive x-axis, the return value is between 0 and 2PI
+     */
+    signedAngle() {
+        const signed_angle = Math.atan2(this.y, this.x) - Math.atan2(0, 1);
+        return (0, normalizeAngleRadians_1.normalizeAngleRadians)(signed_angle);
+    }
 }
 exports.Vec2 = Vec2;

package/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Rectangle = exports.BoundingBox = exports.Polygon = exports.Size2 = exports.Line3D = exports.Line2D = exports.Vec3 = exports.Vec2 = void 0;
+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");
@@ -17,3 +17,7 @@ var BoundingBox_1 = require("./BoundingBox");
 Object.defineProperty(exports, "BoundingBox", { enumerable: true, get: function () { return BoundingBox_1.BoundingBox; } });
 var Rectangle_1 = require("./Rectangle");
 Object.defineProperty(exports, "Rectangle", { enumerable: true, get: function () { return Rectangle_1.Rectangle; } });
+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; } });

package/cjs/normalizeAngleDegrees.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeAngleDegrees = void 0;
+function normalizeAngleDegrees(angle) {
+    return ((angle % 360) + 360) % 360;
+}
+exports.normalizeAngleDegrees = normalizeAngleDegrees;

package/cjs/normalizeAngleRadians.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeAngleRadians = void 0;
+function normalizeAngleRadians(angle) {
+    const twoPi = 2 * Math.PI;
+    angle = angle % 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;
+    }
+    return angle;
+}
+exports.normalizeAngleRadians = normalizeAngleRadians;

package/esm/Vec2.js

@@ -1,5 +1,6 @@
 import { Vector2 } from "three";
 import { Vec3 } from "./Vec3";
+import { normalizeAngleRadians } from "./normalizeAngleRadians";
 /**
  * Vec2 represents a 2D vector. It extends `Vector2` from the `threejs` library.
  */
@@ -55,4 +56,11 @@ export class Vec2 extends Vector2 {
         }
         return this.distanceTo(v) <= maxDistance;
     }
+    /**
+     * Returns the angle between this vector and positive x-axis, the return value is between 0 and 2PI
+     */
+    signedAngle() {
+        const signed_angle = Math.atan2(this.y, this.x) - Math.atan2(0, 1);
+        return normalizeAngleRadians(signed_angle);
+    }
 }

package/esm/index.js

@@ -6,3 +6,5 @@ export { Size2 } from "./Size2";
 export { Polygon } from "./Polygon";
 export { BoundingBox } from "./BoundingBox";
 export { Rectangle } from "./Rectangle";
+export { normalizeAngleDegrees } from "./normalizeAngleDegrees";
+export { normalizeAngleRadians } from "./normalizeAngleRadians";

package/esm/normalizeAngleDegrees.js

@@ -0,0 +1,3 @@
+export function normalizeAngleDegrees(angle) {
+    return ((angle % 360) + 360) % 360;
+}

package/esm/normalizeAngleRadians.js

@@ -0,0 +1,8 @@
+export function normalizeAngleRadians(angle) {
+    const twoPi = 2 * Math.PI;
+    angle = angle % 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;
+    }
+    return angle;
+}

package/package.json

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

@@ -65,7 +65,7 @@ export class Line2D {
      * Modifies this line.
      * @param value
      */
-    public setCenter(value: Point2): Line2D {
+    public setCenter(value: Point2): this {
         this.center = value;
         return this;
     }
@@ -74,7 +74,7 @@ export class Line2D {
     * Extends or reduces the line by the given length while keeping the center of the line constant.
     * Modifies this line.
     */
-    public resize(amount: number): Line2D {
+    public resize(amount: number): this {
         this.moveStartPoint(amount / 2);
         this.moveEndPoint(amount / 2);
         return this;
@@ -84,7 +84,7 @@ export class Line2D {
     * Moves start point on the line by the given amount. Plus values move the point further away from the center.
     * Modifies this line.
     */
-    public moveStartPoint(amount: number): Line2D {
+    public moveStartPoint(amount: number): this {
         const p1 = this.movePointOnThisLine(this.start, amount);
         this.start.copy(p1);
 
@@ -95,7 +95,7 @@ export class Line2D {
      * Moves end point on the line by the given amount. Plus values move the point further away from the center.
      * Modifies this line.
      */
-    public moveEndPoint(amount: number): Line2D {
+    public moveEndPoint(amount: number): this {
         const p2 = this.movePointOnThisLine(this.end, amount);
         this.end.copy(p2);
 
@@ -152,7 +152,7 @@ export class Line2D {
      * Inverts the direction of the line.
      * Modifies this line.
      */
-    public flip(): Line2D {
+    public flip(): this {
         const temp = this.start.clone();
         this.start.copy(this.end);
         this.end.copy(temp);
@@ -166,7 +166,7 @@ export class Line2D {
      * @param radians Positive values rotate counter-clockwise.
      * @param center
      */
-    public rotate(radians: number, center: Vec2 = this.center): Line2D {
+    public rotate(radians: number, center: Vec2 = this.center): this {
         this.start.rotateAround(center, radians);
         this.end.rotateAround(center, radians);
 
@@ -177,7 +177,7 @@ export class Line2D {
      * Move the line by the given vector.
      * Modifies this line.
      */
-    public translate(value: Point2): Line2D {
+    public translate(value: Point2): this {
         this.start.x += value.x;
         this.start.y += value.y;
         this.end.x += value.x;
@@ -190,7 +190,7 @@ export class Line2D {
      * Move the line to its left by the given amount.
      * Modifies this line.
      */
-    public translateLeft(amount: number): Line2D {
+    public translateLeft(amount: number): this {
         const translation = this.direction.rotateAround(new Vec2(), -Math.PI / 2).multiplyScalar(amount);
         return this.translate(translation);
     }
@@ -199,7 +199,7 @@ export class Line2D {
      * Move the line to its right by the given amount.
      * Modifies this line.
      */
-    public translateRight(amount: number): Line2D {
+    public translateRight(amount: number): this {
         const translation = this.direction.rotateAround(new Vec2(), Math.PI / 2).multiplyScalar(amount);
         return this.translate(translation);
     }
@@ -578,7 +578,7 @@ export class Line2D {
      * @param other
      * @param maxDistanceToIntersection
      */
-    public extendToOrTrimAtIntersection(other: Line2D, maxDistanceToIntersection: number = Number.MAX_VALUE): Line2D {
+    public extendToOrTrimAtIntersection(other: Line2D, maxDistanceToIntersection: number = Number.MAX_VALUE): this {
         const intersection = this.intersect(other);
 
         if (intersection) {

package/src/Line3D.ts

@@ -365,7 +365,7 @@ export class Line3D extends Line3 {
     /*
     * Moves start on the line by the given amount. Plus values move the point further away from the center.
     */
-    public moveStartPoint(amount: number): Line3D {
+    public moveStartPoint(amount: number): this {
         const start = this.movePointOnThisLine(this.start, amount);
         this.start.x = start.x;
         this.start.y = start.y;
@@ -377,7 +377,7 @@ export class Line3D extends Line3 {
     /*
     * Moves end on the line by the given amount in the current direction. Plus values move the point further away from the center.
     */
-    public moveEndPoint(amount: number): Line3D {
+    public moveEndPoint(amount: number): this {
         const end = this.movePointOnThisLine(this.end, amount);
         this.end.x = end.x;
         this.end.y = end.y;

package/src/Vec2.ts

@@ -1,6 +1,7 @@
 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.
@@ -63,4 +64,12 @@ export class Vec2 extends Vector2 {
 
         return this.distanceTo(v) <= maxDistance;
     }
+
+    /**
+     * Returns the angle between this vector and positive x-axis, the return value is between 0 and 2PI
+     */
+    public signedAngle(): number {
+        const signed_angle = Math.atan2(this.y, this.x) - Math.atan2(0, 1);
+        return normalizeAngleRadians(signed_angle);
+    }
 }

package/src/index.ts

@@ -5,4 +5,6 @@ export { Line3D } from "./Line3D";
 export { Size2 } from "./Size2";
 export { Polygon } from "./Polygon";
 export { BoundingBox } from "./BoundingBox";
-export { Rectangle } from "./Rectangle";
+export { Rectangle } from "./Rectangle";
+export { normalizeAngleDegrees } from "./normalizeAngleDegrees";
+export { normalizeAngleRadians } from "./normalizeAngleRadians";

package/src/normalizeAngleDegrees.ts

@@ -0,0 +1,3 @@
+export function normalizeAngleDegrees(angle: number): number {
+    return ((angle % 360) + 360) % 360;
+}

package/src/normalizeAngleRadians.ts

@@ -0,0 +1,9 @@
+export function normalizeAngleRadians(angle: number): number {
+    const twoPi = 2 * Math.PI;
+    angle = angle % 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;
+    }
+    return angle;
+}
+

package/types/Line2D.d.ts

@@ -27,14 +27,14 @@ export declare class Line2D {
      * Modifies this line.
      * @param value
      */
-    setCenter(value: Point2): Line2D;
-    resize(amount: number): Line2D;
-    moveStartPoint(amount: number): Line2D;
+    setCenter(value: Point2): this;
+    resize(amount: number): this;
+    moveStartPoint(amount: number): this;
     /**
      * Moves end point on the line by the given amount. Plus values move the point further away from the center.
      * Modifies this line.
      */
-    moveEndPoint(amount: number): Line2D;
+    moveEndPoint(amount: number): this;
     private movePointOnThisLine;
     /**
      * Set the length of this line. Center and direction remain unchanged.
@@ -61,29 +61,29 @@ export declare class Line2D {
      * Inverts the direction of the line.
      * Modifies this line.
      */
-    flip(): Line2D;
+    flip(): this;
     /**
      * Rotates the line around the center by the given angle in radians.
      * Modifies this line.
      * @param radians Positive values rotate counter-clockwise.
      * @param center
      */
-    rotate(radians: number, center?: Vec2): Line2D;
+    rotate(radians: number, center?: Vec2): this;
     /**
      * Move the line by the given vector.
      * Modifies this line.
      */
-    translate(value: Point2): Line2D;
+    translate(value: Point2): this;
     /**
      * Move the line to its left by the given amount.
      * Modifies this line.
      */
-    translateLeft(amount: number): Line2D;
+    translateLeft(amount: number): this;
     /**
      * Move the line to its right by the given amount.
      * Modifies this line.
      */
-    translateRight(amount: number): Line2D;
+    translateRight(amount: number): this;
     /**
      * Returns true when the point is actually inside the (finite) line segment.
      * https://jsfiddle.net/c06zdxtL/2/
@@ -202,7 +202,7 @@ export declare class Line2D {
      * @param other
      * @param maxDistanceToIntersection
      */
-    extendToOrTrimAtIntersection(other: Line2D, maxDistanceToIntersection?: number): Line2D;
+    extendToOrTrimAtIntersection(other: Line2D, maxDistanceToIntersection?: number): this;
     /**
      * Returns the intersection point of two lines. The lines are assumed to be infinite.
      */

package/types/Line3D.d.ts

@@ -112,8 +112,8 @@ export declare class Line3D extends Line3 {
      */
     isParallelTo(other: Line3D, tolerance?: number): boolean;
     resize(amount: number): this;
-    moveStartPoint(amount: number): Line3D;
-    moveEndPoint(amount: number): Line3D;
+    moveStartPoint(amount: number): this;
+    moveEndPoint(amount: number): this;
     /**
      * Returns a new line that is the projection of this line onto @other. Uses `closestPointToPoint` to find the projection.
      * @param other

package/types/Vec2.d.ts

@@ -35,4 +35,8 @@ export declare class Vec2 extends Vector2 {
      * maxDistance is the maximum distance between the two vectors within which they are considered `near`.
      */
     isNear(v: Vector2, maxDistance?: number): boolean;
+    /**
+     * Returns the angle between this vector and positive x-axis, the return value is between 0 and 2PI
+     */
+    signedAngle(): number;
 }

package/types/index.d.ts

@@ -6,3 +6,5 @@ export { Size2 } from "./Size2";
 export { Polygon } from "./Polygon";
 export { BoundingBox } from "./BoundingBox";
 export { Rectangle } from "./Rectangle";
+export { normalizeAngleDegrees } from "./normalizeAngleDegrees";
+export { normalizeAngleRadians } from "./normalizeAngleRadians";

package/types/normalizeAngleDegrees.d.ts

@@ -0,0 +1 @@
+export declare function normalizeAngleDegrees(angle: number): number;

package/types/normalizeAngleRadians.d.ts

@@ -0,0 +1 @@
+export declare function normalizeAngleRadians(angle: number): number;