@immugio/three-math-extensions 0.0.11 → 0.0.13

package/cjs/Point2.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/Point3.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/Vec2.js

@@ -1,34 +1,62 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Vec2 = void 0;
-const three_1 = require("three");
-const Vec3_1 = require("./Vec3");
-class Vec2 extends three_1.Vector2 {
-    static fromPoint(point) {
-        return new Vec2(point.x, point.y);
-    }
-    moveTowards(target, amount) {
-        const move = target.clone().sub(this).normalize().multiplyScalar(amount);
-        this.add(move);
-        return this;
-    }
-    roundIfCloseToInteger(max = 0.000000000001) {
-        if (Math.abs(this.x - Math.round(this.x)) < max) {
-            this.x = Math.round(this.x);
-        }
-        if (Math.abs(this.y - Math.round(this.y)) < max) {
-            this.y = Math.round(this.y);
-        }
-        return this;
-    }
-    in3DSpace(z = 0) {
-        return new Vec3_1.Vec3(this.x, z, this.y);
-    }
-    isNear(v, maxDistance = undefined) {
-        if (!maxDistance) {
-            return this.equals(v);
-        }
-        return this.distanceTo(v) <= maxDistance;
-    }
-}
-exports.Vec2 = Vec2;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Vec2 = void 0;
+const three_1 = require("three");
+const Vec3_1 = require("./Vec3");
+/**
+ * Vec2 represents a 2D vector. It extends `Vector2` from the `three` library.
+ */
+class Vec2 extends three_1.Vector2 {
+    /**
+     * Creates a new Vec2 instance from an {x, y} object.
+     * @param point - The {x, y} instance.
+     * @returns A new Vec2 instance.
+     */
+    static fromPoint(point) {
+        return new Vec2(point.x, point.y);
+    }
+    /**
+     * Moves this Vec2 instance towards the target Vec2 by the given amount.
+     * @param target - The target Vec2.
+     * @param amount - The distance to move.
+     * @returns This Vec2 instance.
+     */
+    moveTowards(target, amount) {
+        const move = target.clone().sub(this).normalize().multiplyScalar(amount);
+        this.add(move);
+        return this;
+    }
+    /**
+     * Rounds the x and y values of this Vec2 instance if they are close to an integer value.
+     * @param max - The maximum difference between the value and the nearest integer.
+     * @returns This Vec2 instance.
+     */
+    roundIfCloseToInteger(max = 0.000000000001) {
+        if (Math.abs(this.x - Math.round(this.x)) < max) {
+            this.x = Math.round(this.x);
+        }
+        if (Math.abs(this.y - Math.round(this.y)) < max) {
+            this.y = Math.round(this.y);
+        }
+        return this;
+    }
+    /**
+     * Projects this Vec2 instance to a Vec3 instance in 3D space.
+     * @param z - The z value of the new Vec3 instance.
+     * @returns A new Vec3 instance.
+     */
+    in3DSpace(z = 0) {
+        return new Vec3_1.Vec3(this.x, z, this.y);
+    }
+    /**
+     * Determines if this Vec2 instance is near the target Vec2.
+     * maxDistance is the maximum distance between the two vectors within which they are considered `near`.
+     */
+    isNear(v, maxDistance = undefined) {
+        if (!maxDistance) {
+            return this.equals(v);
+        }
+        return this.distanceTo(v) <= maxDistance;
+    }
+}
+exports.Vec2 = Vec2;

package/cjs/Vec3.js

@@ -1,63 +1,63 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Vec3 = void 0;
-const three_1 = require("three");
-const Vec2_1 = require("./Vec2");
-class Vec3 extends three_1.Vector3 {
-    #target;
-    static fromPoint(point) {
-        return new Vec3(point.x, point.y, point.z);
-    }
-    moveTowards(target, amount) {
-        if (this.#target === undefined) {
-            this.#target = new three_1.Vector3();
-        }
-        this.#target.copy(target);
-        this.add(this.#target.sub(this).normalize().multiplyScalar(amount));
-        return this;
-    }
-    centerTowards(target) {
-        if (this.#target === undefined) {
-            this.#target = new three_1.Vector3();
-        }
-        return this.moveTowards(target, this.distanceTo(target) / 2);
-    }
-    addY(y) {
-        this.y += y;
-        return this;
-    }
-    addX(x) {
-        this.x += x;
-        return this;
-    }
-    scale(p) {
-        this.x *= p.x;
-        this.y *= p.y;
-        this.z *= p.z;
-        return this;
-    }
-    closest(...points) {
-        const withDistances = points.map(p => ({ point: p, distance: this.distanceTo(p) }));
-        const closest = withDistances.reduce((a, b) => a.distance < b.distance ? a : b);
-        return Vec3.fromPoint(closest.point);
-    }
-    toPointWithFlippedYZ() {
-        return new Vec3(this.x, this.z, this.y);
-    }
-    onPlan() {
-        return new Vec2_1.Vec2(this.x, this.z);
-    }
-    horizontalDistanceTo(point) {
-        return new three_1.Vector3(this.x, 0, this.z).distanceTo(new three_1.Vector3(point.x, 0, point.z));
-    }
-    isNear(v, maxDistance = undefined) {
-        if (maxDistance === undefined) {
-            return this.equals(v);
-        }
-        return this.distanceTo(v) <= maxDistance;
-    }
-    clone() {
-        return super.clone();
-    }
-}
-exports.Vec3 = Vec3;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Vec3 = void 0;
+const three_1 = require("three");
+const Vec2_1 = require("./Vec2");
+class Vec3 extends three_1.Vector3 {
+    #target;
+    static fromPoint(point) {
+        return new Vec3(point.x, point.y, point.z);
+    }
+    moveTowards(target, amount) {
+        if (this.#target === undefined) {
+            this.#target = new three_1.Vector3();
+        }
+        this.#target.copy(target);
+        this.add(this.#target.sub(this).normalize().multiplyScalar(amount));
+        return this;
+    }
+    centerTowards(target) {
+        if (this.#target === undefined) {
+            this.#target = new three_1.Vector3();
+        }
+        return this.moveTowards(target, this.distanceTo(target) / 2);
+    }
+    addY(y) {
+        this.y += y;
+        return this;
+    }
+    addX(x) {
+        this.x += x;
+        return this;
+    }
+    scale(p) {
+        this.x *= p.x;
+        this.y *= p.y;
+        this.z *= p.z;
+        return this;
+    }
+    closest(...points) {
+        const withDistances = points.map(p => ({ point: p, distance: this.distanceTo(p) }));
+        const closest = withDistances.reduce((a, b) => a.distance < b.distance ? a : b);
+        return Vec3.fromPoint(closest.point);
+    }
+    toPointWithFlippedYZ() {
+        return new Vec3(this.x, this.z, this.y);
+    }
+    onPlan() {
+        return new Vec2_1.Vec2(this.x, this.z);
+    }
+    horizontalDistanceTo(point) {
+        return new three_1.Vector3(this.x, 0, this.z).distanceTo(new three_1.Vector3(point.x, 0, point.z));
+    }
+    isNear(v, maxDistance = undefined) {
+        if (maxDistance === undefined) {
+            return this.equals(v);
+        }
+        return this.distanceTo(v) <= maxDistance;
+    }
+    clone() {
+        return super.clone();
+    }
+}
+exports.Vec3 = Vec3;

package/cjs/index.js

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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");
-Object.defineProperty(exports, "Vec3", { enumerable: true, get: function () { return Vec3_1.Vec3; } });
-var Line2D_1 = require("./Line2D");
-Object.defineProperty(exports, "Line2D", { enumerable: true, get: function () { return Line2D_1.Line2D; } });
-var Line3D_1 = require("./Line3D");
-Object.defineProperty(exports, "Line3D", { enumerable: true, get: function () { return Line3D_1.Line3D; } });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+Object.defineProperty(exports, "Vec3", { enumerable: true, get: function () { return Vec3_1.Vec3; } });
+var Line2D_1 = require("./Line2D");
+Object.defineProperty(exports, "Line2D", { enumerable: true, get: function () { return Line2D_1.Line2D; } });
+var Line3D_1 = require("./Line3D");
+Object.defineProperty(exports, "Line3D", { enumerable: true, get: function () { return Line3D_1.Line3D; } });