@immugio/three-math-extensions 0.2.5 → 0.2.7

package/src/normalizeAngleDegrees.ts

@@ -1,3 +1,7 @@
+/**
+ * Normalizes an angle in degrees to the range [0, 360].
+ * @param angle in degrees
+ */
 export function normalizeAngleDegrees(angle: number): number {
     return ((angle % 360) + 360) % 360;
 }

package/src/normalizeAngleRadians.ts

@@ -1,9 +1,15 @@
+import { TwoPI } from "./MathConstants";
+
+/**
+ * Normalize an angle in radians to the range of 0 to 2π.
+ * @param angle in radians
+ */
 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π
+    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;
+        angle = angle + TwoPI;
     }
-    return angle;
-}
 
+    return angle;
+}

package/types/Line2D.d.ts

@@ -144,20 +144,14 @@ export declare class Line2D {
      */
     chunk(maxSegmentLength: number): Line2D[];
     /**
-     * Returns the closest point parameter on the **infinite** line to the given point.
+     * Returns the closest point on the line to the given point.
      * @param point
+     * @param clampToLine boolean (optional)
+     * @param target Vec2 (optional)
      */
-    closestPointToPointParameterOnInfiniteLine(point: Vector2): number;
-    /**
-     * Returns the closest point on the **infinite** line to the given point.
-     * @param point
-     */
-    closestPointOnInfiniteLine(point: Vector2): Vec2;
-    /**
-     * Returns the closest point on the line **section** to the given point.
-     * @param point
-     */
-    closestPointOnLine(point: Vector2): Vec2;
+    closestPointToPoint(point: Vector2, clampToLine?: boolean, target?: Vec2): Vec2;
+    delta(target: Vec2): Vec2;
+    closestPointToPointParameter(point: any, clampToLine: any): number;
     /**
      * Returns the distance between the **infinite** line and the point.
      * @param point
@@ -208,11 +202,13 @@ export declare class Line2D {
      */
     intersect(other: Line2D): Vec2;
     /**
-     * Check that the infinite lines intersect and that they are in the specified angle to each other
+     * Check that the line section intersect and that they are in the specified angle to each other
      * @param other Line
      * @param expectedAngleInRads number
+     * @param angleTolerance number
+     * @param distanceTolerance number
      */
-    hasIntersectionWithAngle(other: Line2D, expectedAngleInRads: number): Vec2;
+    hasIntersectionWithAngle(other: Line2D, expectedAngleInRads: number, angleTolerance?: number, distanceTolerance?: number): Vec2;
     equals(other: Line2D): boolean;
     /**
      * Deep clone of this line

package/types/MathConstants.d.ts

@@ -0,0 +1 @@
+export declare const TwoPI: number;

package/types/Vec2.d.ts

@@ -11,6 +11,11 @@ export declare class Vec2 extends Vector2 {
      * @returns A new Vec2 instance.
      */
     static fromPoint(point: Point2): Vec2;
+    /**
+     * Creates a new Vec2[] array from arguments of {x, y} objects.
+      * @param points - The ...{x, y} instances.
+     */
+    static fromPoints(...points: Point2[]): Vec2[];
     /**
      * Moves this Vec2 instance towards the target Vec2 by the given amount.
      * @param target - The target Vec2.
@@ -39,4 +44,10 @@ 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;
+    /**
+     * 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
+     * @param toleranceRadians number angle tolerance in radians
+     */
+    parallelTo(other: Vector2, toleranceRadians?: number): boolean;
 }

package/types/index.d.ts

@@ -8,3 +8,6 @@ export { BoundingBox } from "./BoundingBox";
 export { Rectangle } from "./Rectangle";
 export { normalizeAngleDegrees } from "./normalizeAngleDegrees";
 export { normalizeAngleRadians } from "./normalizeAngleRadians";
+export { TwoPI } from "./MathConstants";
+export { Point2 } from "./Point2";
+export { Point3 } from "./Point3";

package/types/normalizeAngleDegrees.d.ts

@@ -1 +1,5 @@
+/**
+ * Normalizes an angle in degrees to the range [0, 360].
+ * @param angle in degrees
+ */
 export declare function normalizeAngleDegrees(angle: number): number;

package/types/normalizeAngleRadians.d.ts

@@ -1 +1,5 @@
+/**
+ * Normalize an angle in radians to the range of 0 to 2π.
+ * @param angle in radians
+ */
 export declare function normalizeAngleRadians(angle: number): number;

package/HowToRelease.txt

@@ -1,13 +0,0 @@
-Update documentation:
-npx typedoc --plugin typedoc-plugin-markdown --out docs src/index.ts --excludeExternals --excludeProtected --excludePrivate --githubPages false
-
-Before release
-- Ensure clean working directory
-- Ensure that the last release commit has a tag that matches the latest release number in the format "0.0.11". This step should have been completed in the previous release. It's only mentioned here in case it's for any reason missing.
-- Run "prerelease" script to verify that the code builds and the tests pass
-
-Release:
-- Bump up version in package.json e.g. "0.0.11" -> "0.0.12"
-- Run "version" script, it should add the new commits since the last release into `CHANGELOG.md`
-- Commit and push the changes in `package.json` and `CHANGELOG.md`, ideally, call the commit as the new release e.g. "`0.0.12`". This is not necessary but makes it easier to find
-- **Tag the commit**  the new version number. In this example "`0.0.12`" and push. This is required for CI to build and publish to npm.