@js-draw/math 1.7.0 → 1.9.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Henry Heino
+Copyright (c) 2023 Henry Heino
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/cjs/Vec3.d.ts

@@ -46,6 +46,15 @@ export declare class Vec3 {
      * Return this' angle in the XY plane (treats this as a Vec2).
      *
      * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     *
+     * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+     * the resultant angle is in the range $[-\pi, pi]$.
+     *
+     * ```ts,runnable,console
+     * import { Vec2 } from '@js-draw/math';
+     * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+     * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+     * ```
      */
     angle(): number;
     /**

package/dist/cjs/Vec3.js

@@ -71,6 +71,15 @@ class Vec3 {
      * Return this' angle in the XY plane (treats this as a Vec2).
      *
      * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     *
+     * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+     * the resultant angle is in the range $[-\pi, pi]$.
+     *
+     * ```ts,runnable,console
+     * import { Vec2 } from '@js-draw/math';
+     * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+     * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+     * ```
      */
     angle() {
         return Math.atan2(this.y, this.x);

package/dist/cjs/shapes/Path.d.ts

@@ -63,6 +63,8 @@ export declare class Path {
     private cachedPolylineApproximation;
     polylineApproximation(): LineSegment2[];
     static computeBBoxForSegment(startPoint: Point2, part: PathCommand): Rect2;
+    /** **Note**: `strokeRadius = strokeWidth / 2` */
+    signedDistance(point: Point2, strokeRadius: number): number;
     /**
      * Let `S` be a closed path a distance `strokeRadius` from this path.
      *

package/dist/cjs/shapes/Path.js

@@ -154,6 +154,17 @@ class Path {
         }
         return Rect2_1.default.bboxOf(points);
     }
+    /** **Note**: `strokeRadius = strokeWidth / 2` */
+    signedDistance(point, strokeRadius) {
+        let minDist = Infinity;
+        for (const part of this.geometry) {
+            const currentDist = part.signedDistance(point) - strokeRadius;
+            if (currentDist < minDist) {
+                minDist = currentDist;
+            }
+        }
+        return minDist;
+    }
     /**
      * Let `S` be a closed path a distance `strokeRadius` from this path.
      *

package/dist/cjs/shapes/Rect2.d.ts

@@ -43,6 +43,7 @@ export declare class Rect2 extends Abstract2DShape {
     isWithinRadiusOf(radius: number, point: Point2): boolean;
     get corners(): Point2[];
     get maxDimension(): number;
+    get minDimension(): number;
     get bottomRight(): Vec3;
     get topRight(): Vec3;
     get bottomLeft(): Vec3;

package/dist/cjs/shapes/Rect2.js

@@ -164,6 +164,9 @@ class Rect2 extends Abstract2DShape_1.default {
     get maxDimension() {
         return Math.max(this.w, this.h);
     }
+    get minDimension() {
+        return Math.min(this.w, this.h);
+    }
     get bottomRight() {
         return this.topLeft.plus(this.size);
     }

package/dist/mjs/Vec3.d.ts

@@ -46,6 +46,15 @@ export declare class Vec3 {
      * Return this' angle in the XY plane (treats this as a Vec2).
      *
      * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     *
+     * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+     * the resultant angle is in the range $[-\pi, pi]$.
+     *
+     * ```ts,runnable,console
+     * import { Vec2 } from '@js-draw/math';
+     * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+     * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+     * ```
      */
     angle(): number;
     /**

package/dist/mjs/Vec3.mjs

@@ -68,6 +68,15 @@ export class Vec3 {
      * Return this' angle in the XY plane (treats this as a Vec2).
      *
      * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     *
+     * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+     * the resultant angle is in the range $[-\pi, pi]$.
+     *
+     * ```ts,runnable,console
+     * import { Vec2 } from '@js-draw/math';
+     * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+     * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+     * ```
      */
     angle() {
         return Math.atan2(this.y, this.x);

package/dist/mjs/shapes/Path.d.ts

@@ -63,6 +63,8 @@ export declare class Path {
     private cachedPolylineApproximation;
     polylineApproximation(): LineSegment2[];
     static computeBBoxForSegment(startPoint: Point2, part: PathCommand): Rect2;
+    /** **Note**: `strokeRadius = strokeWidth / 2` */
+    signedDistance(point: Point2, strokeRadius: number): number;
     /**
      * Let `S` be a closed path a distance `strokeRadius` from this path.
      *

package/dist/mjs/shapes/Path.mjs

@@ -148,6 +148,17 @@ export class Path {
         }
         return Rect2.bboxOf(points);
     }
+    /** **Note**: `strokeRadius = strokeWidth / 2` */
+    signedDistance(point, strokeRadius) {
+        let minDist = Infinity;
+        for (const part of this.geometry) {
+            const currentDist = part.signedDistance(point) - strokeRadius;
+            if (currentDist < minDist) {
+                minDist = currentDist;
+            }
+        }
+        return minDist;
+    }
     /**
      * Let `S` be a closed path a distance `strokeRadius` from this path.
      *

package/dist/mjs/shapes/Rect2.d.ts

@@ -43,6 +43,7 @@ export declare class Rect2 extends Abstract2DShape {
     isWithinRadiusOf(radius: number, point: Point2): boolean;
     get corners(): Point2[];
     get maxDimension(): number;
+    get minDimension(): number;
     get bottomRight(): Vec3;
     get topRight(): Vec3;
     get bottomLeft(): Vec3;

package/dist/mjs/shapes/Rect2.mjs

@@ -158,6 +158,9 @@ export class Rect2 extends Abstract2DShape {
     get maxDimension() {
         return Math.max(this.w, this.h);
     }
+    get minDimension() {
+        return Math.min(this.w, this.h);
+    }
     get bottomRight() {
         return this.topLeft.plus(this.size);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@js-draw/math",
-	"version": "1.7.0",
+	"version": "1.9.0",
 	"description": "A math library for js-draw. ",
 	"types": "./dist/mjs/lib.d.ts",
 	"main": "./dist/cjs/lib.js",
@@ -19,7 +19,7 @@
 	"license": "MIT",
 	"private": false,
 	"scripts": {
-		"dist-test": "npm run build && cd dist-test/test_imports && npm install && npm run test",
+		"dist-test": "cd dist-test/test_imports && npm install && npm run test",
 		"dist": "npm run build && npm run dist-test",
 		"build": "rm -rf ./dist && mkdir dist && build-tool build",
 		"watch": "rm -rf ./dist/* && mkdir -p dist && build-tool watch"
@@ -45,5 +45,5 @@
 		"svg",
 		"math"
 	],
-	"gitHead": "e7d8a68e6a5ae3063de9c1f033ed8f08c567b393"
+	"gitHead": "e824c37e9f216852cf096976e3a74fb4f177ead3"
 }

package/src/Vec3.ts

@@ -77,6 +77,15 @@ export class Vec3 {
 	 * Return this' angle in the XY plane (treats this as a Vec2).
 	 *
 	 * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+	 *
+	 * As such, observing that `Math.atan2(-0, -1)` $\approx -\pi$ and `Math.atan2(0, -1)`$\approx \pi$
+	 * the resultant angle is in the range $[-\pi, pi]$.
+	 *
+	 * ```ts,runnable,console
+	 * import { Vec2 } from '@js-draw/math';
+	 * console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
+	 * console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
+	 * ```
 	 */
 	public angle(): number {
 		return Math.atan2(this.y, this.x);

package/src/shapes/Path.ts

@@ -225,6 +225,20 @@ export class Path {
 		return Rect2.bboxOf(points);
 	}
 
+	/** **Note**: `strokeRadius = strokeWidth / 2` */
+	public signedDistance(point: Point2, strokeRadius: number) {
+		let minDist = Infinity;
+
+		for (const part of this.geometry) {
+			const currentDist = part.signedDistance(point) - strokeRadius;
+			if (currentDist < minDist) {
+				minDist = currentDist;
+			}
+		}
+
+		return minDist;
+	}
+
 	/**
 	 * Let `S` be a closed path a distance `strokeRadius` from this path.
 	 *

package/src/shapes/Rect2.ts

@@ -220,6 +220,10 @@ export class Rect2 extends Abstract2DShape {
 		return Math.max(this.w, this.h);
 	}
 
+	public get minDimension() {
+		return Math.min(this.w, this.h);
+	}
+
 	public get bottomRight() {
 		return this.topLeft.plus(this.size);
 	}