@immugio/three-math-extensions 0.0.11 → 0.0.13

package/esm/Point2.js

@@ -1 +1 @@
-export {};
+export {};

package/esm/Point3.js

@@ -1 +1 @@
-export {};
+export {};

package/esm/Vec2.js

@@ -1,30 +1,58 @@
-import { Vector2 } from "three";
-import { Vec3 } from "./Vec3";
-export class Vec2 extends 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(this.x, z, this.y);
-    }
-    isNear(v, maxDistance = undefined) {
-        if (!maxDistance) {
-            return this.equals(v);
-        }
-        return this.distanceTo(v) <= maxDistance;
-    }
-}
+import { Vector2 } from "three";
+import { Vec3 } from "./Vec3";
+/**
+ * Vec2 represents a 2D vector. It extends `Vector2` from the `three` library.
+ */
+export class Vec2 extends 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(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;
+    }
+}

package/esm/Vec3.js

@@ -1,59 +1,59 @@
-import { Vector3 } from "three";
-import { Vec2 } from "./Vec2";
-export class Vec3 extends Vector3 {
-    #target;
-    static fromPoint(point) {
-        return new Vec3(point.x, point.y, point.z);
-    }
-    moveTowards(target, amount) {
-        if (this.#target === undefined) {
-            this.#target = new 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 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(this.x, this.z);
-    }
-    horizontalDistanceTo(point) {
-        return new Vector3(this.x, 0, this.z).distanceTo(new 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();
-    }
-}
+import { Vector3 } from "three";
+import { Vec2 } from "./Vec2";
+export class Vec3 extends Vector3 {
+    #target;
+    static fromPoint(point) {
+        return new Vec3(point.x, point.y, point.z);
+    }
+    moveTowards(target, amount) {
+        if (this.#target === undefined) {
+            this.#target = new 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 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(this.x, this.z);
+    }
+    horizontalDistanceTo(point) {
+        return new Vector3(this.x, 0, this.z).distanceTo(new 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();
+    }
+}

package/esm/index.js

@@ -1,4 +1,4 @@
-export { Vec2 } from "./Vec2";
-export { Vec3 } from "./Vec3";
-export { Line2D } from "./Line2D";
-export { Line3D } from "./Line3D";
+export { Vec2 } from "./Vec2";
+export { Vec3 } from "./Vec3";
+export { Line2D } from "./Line2D";
+export { Line3D } from "./Line3D";

package/package.json

@@ -1,52 +1,52 @@
-{
-  "name": "@immugio/three-math-extensions",
-  "version": "0.0.11",
-  "description": "Set of utilities for 2d and 3d line math built on top of three.js",
-  "author": "Jan Mikeska <janmikeska@gmail.com>",
-  "license": "ISC",
-  "keywords": [
-    "threejs",
-    "three",
-    "math"
-  ],
-  "bugs": {
-    "url": "https://github.com/Immugio/three-math-extensions/issues"
-  },
-  "homepage": "https://github.com/Immugio/three-math-extensions#readme",
-  "sideEffects": false,
-  "source": "src/index.ts",
-  "main": "cjs/index.js",
-  "module": "esm/index.js",
-  "types": "types/index.d.ts",
-  "auto-changelog": {
-    "commitLimit": false,
-    "template": "keepachangelog"
-  },
-  "scripts": {
-    "test": "npx jest",
-    "build:esm": "tsc",
-    "build:cjs": "tsc -p tsconfig-cjs.json",
-    "clean": "rimraf types cjs esm",
-    "build": "npm run clean && npm run build:esm && npm run build:cjs",
-    "preversion": "npm run clean && npm run build && npm run test",
-    "version": "auto-changelog -p && git add CHANGELOG.md",
-    "postversion": "git push && git push --tags"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.2.1",
-    "@types/offscreencanvas": "2019.7.0",
-    "@types/three": "0.130.1",
-    "auto-changelog": "^2.4.0",
-    "jest": "^29.2.2",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^29.0.0",
-    "typescript": "4.7.4"
-  },
-  "peerDependencies": {
-    "three": "^0.130.1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Immugio/three-math-extensions.git"
-  }
-}
+{
+  "name": "@immugio/three-math-extensions",
+  "version": "0.0.13",
+  "description": "Set of utilities for 2d and 3d line math built on top of three.js",
+  "author": "Jan Mikeska <janmikeska@gmail.com>",
+  "license": "ISC",
+  "keywords": [
+    "threejs",
+    "three",
+    "math"
+  ],
+  "bugs": {
+    "url": "https://github.com/Immugio/three-math-extensions/issues"
+  },
+  "homepage": "https://github.com/Immugio/three-math-extensions#readme",
+  "sideEffects": false,
+  "source": "src/index.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "auto-changelog": {
+    "commitLimit": false,
+    "template": "keepachangelog"
+  },
+  "scripts": {
+    "test": "npx jest",
+    "build:esm": "tsc",
+    "build:cjs": "tsc -p tsconfig-cjs.json",
+    "clean": "rimraf types cjs esm",
+    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "preversion": "npm run clean && npm run build && npm run test",
+    "version": "auto-changelog -p && git add CHANGELOG.md",
+    "postversion": "git push && git push --tags"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.1",
+    "@types/offscreencanvas": "2019.7.0",
+    "@types/three": "0.130.1",
+    "auto-changelog": "^2.4.0",
+    "jest": "^29.2.2",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^29.0.0",
+    "typescript": "4.7.4"
+  },
+  "peerDependencies": {
+    "three": "^0.130.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Immugio/three-math-extensions.git"
+  }
+}