@immugio/three-math-extensions 0.2.2 → 0.2.4

package/CHANGELOG.md

@@ -7,19 +7,26 @@ 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.2](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.2)
+## [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.1...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
 

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.2",
+  "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/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/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;