@immugio/three-math-extensions 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -7,14 +7,29 @@ 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.1.0](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.1.0)
+## [0.2.0](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.0)
 
 ### 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 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.0.17...16.15.10) - 2023-01-02
+## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.1.1...16.15.10) - 2023-01-02
+
+## [0.1.1](https://github.com/Immugio/three-math-extensions/compare/0.1.0...0.1.1) - 2023-01-02
+
+### Commits
+
+- Add Polygon to exports [`ed66775`](https://github.com/Immugio/three-math-extensions/commit/ed66775c33e961835b23843222b822cfd9c16b1d)
+
+## [0.1.0](https://github.com/Immugio/three-math-extensions/compare/0.0.17...0.1.0) - 2023-01-02
+
+### Commits
+
+- Add Polygon [`629cff8`](https://github.com/Immugio/three-math-extensions/commit/629cff8ecbb963477e8ea76d7f8b16d95435cbad)
 
 ## [0.0.17](https://github.com/Immugio/three-math-extensions/compare/0.0.16...0.0.17) - 2023-01-02
 

package/cjs/BoundingBox.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoundingBox = void 0;
+const Vec2_1 = require("./Vec2");
+class BoundingBox {
+    minX;
+    maxX;
+    minY;
+    maxY;
+    constructor(minX, maxX, minY, maxY) {
+        this.minX = minX;
+        this.maxX = maxX;
+        this.minY = minY;
+        this.maxY = maxY;
+    }
+    equals(other) {
+        return this.minX === other.minX && this.maxX === other.maxX && this.minY === other.minY && this.maxY === other.maxY;
+    }
+    get size() {
+        return new Vec2_1.Vec2(this.maxX - this.minX, this.maxY - this.minY);
+    }
+}
+exports.BoundingBox = BoundingBox;

package/cjs/Polygon.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Polygon = void 0;
 const Vec2_1 = require("./Vec2");
-const Size2_1 = require("./Size2");
+const Rectangle_1 = require("./Rectangle");
+const BoundingBox_1 = require("./BoundingBox");
 class Polygon {
     contour;
     holes;
@@ -15,7 +16,7 @@ class Polygon {
     }
     get size() {
         const { minX, maxX, minY, maxY } = this.boundingBox();
-        return new Size2_1.Size2(maxX - minX, maxY - minY);
+        return new Vec2_1.Vec2(maxX - minX, maxY - minY);
     }
     centerOnOrigin() {
         const center = this.center();
@@ -39,7 +40,7 @@ class Polygon {
     }
     ensureLastPoint() {
         function ensure(points) {
-            if (points[0].x !== points.at(-1).x || points[0].y !== points.at(-1).y) {
+            if (!points[0].equals(points.at(-1))) {
                 points.push(points[0].clone());
             }
         }
@@ -61,7 +62,7 @@ class Polygon {
             if (maxY < p.y)
                 maxY = p.y;
         }
-        return { minX, maxX, minY, maxY };
+        return new BoundingBox_1.BoundingBox(minX, maxX, minY, maxY);
     }
     toBoundingPolygon() {
         const bounding = this.boundingBox();
@@ -84,5 +85,38 @@ class Polygon {
             point.x = point.x < centerX ? centerX + xDistanceToCenter : centerX - xDistanceToCenter;
         }
     }
+    toRectangle() {
+        const bounding = this.boundingBox();
+        return new Rectangle_1.Rectangle(bounding.minX, bounding.maxX, bounding.minY, bounding.maxY);
+    }
+    clone() {
+        return new Polygon(this.contour.map(p => p.clone()), this.holes?.map(h => h.map(p => p.clone())));
+    }
+    equals(other) {
+        if (this.contour.length !== other.contour.length) {
+            return false;
+        }
+        for (let i = 0; i < this.contour.length; i++) {
+            if (!this.contour[i].equals(other.contour[i])) {
+                return false;
+            }
+        }
+        if (this.holes?.length !== other.holes?.length) {
+            return false;
+        }
+        for (let i = 0; i < this.holes?.length; i++) {
+            const hole = this.holes[i];
+            const otherHole = other.holes[i];
+            if (hole.length !== otherHole.length) {
+                return false;
+            }
+            for (let j = 0; j < hole.length; j++) {
+                if (!hole[j].equals(otherHole[j])) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
 }
 exports.Polygon = Polygon;

package/cjs/Rectangle.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rectangle = void 0;
+const Polygon_1 = require("./Polygon");
+const Vec2_1 = require("./Vec2");
+class Rectangle {
+    leftX;
+    rightX;
+    topY;
+    bottomY;
+    constructor(leftX, rightX, topY, bottomY) {
+        this.leftX = leftX;
+        this.rightX = rightX;
+        this.topY = topY;
+        this.bottomY = bottomY;
+    }
+    clone() {
+        return new Rectangle(this.leftX, this.rightX, this.topY, this.bottomY);
+    }
+    get size() {
+        return new Vec2_1.Vec2(this.rightX - this.leftX, this.topY - this.bottomY);
+    }
+    get center() {
+        return new Vec2_1.Vec2((this.leftX + this.rightX) / 2, (this.topY + this.bottomY) / 2);
+    }
+    get offset() {
+        return new Vec2_1.Vec2((this.leftX + this.rightX) / -2, (this.topY + this.bottomY) / -2);
+    }
+    overlaps(other) {
+        // Proof is by contradiction. Any one of four conditions guarantees that NO OVERLAP CAN EXIST.
+        const result = this.bottomY >= other.topY || this.topY <= other.bottomY || this.rightX <= other.leftX || this.leftX >= other.rightX;
+        return !result;
+    }
+    get hasSize() {
+        return this.rightX - this.leftX > 1 && this.topY - this.bottomY > 1;
+    }
+    translate(diff) {
+        this.leftX += diff.x;
+        this.rightX += diff.x;
+        this.topY += diff.y;
+        this.bottomY += diff.y;
+        return this;
+    }
+    centerOnOrigin() {
+        const center = this.center;
+        this.leftX -= center.x;
+        this.rightX -= center.x;
+        this.topY -= center.y;
+        this.bottomY -= center.y;
+        return this;
+    }
+    toPolygon() {
+        return new Polygon_1.Polygon(this.toPoints());
+    }
+    /**
+     * The polygon is always constructed as "clockwise", assuming X axis to the right and Y axis down.
+     */
+    toPoints() {
+        return [
+            new Vec2_1.Vec2(this.leftX, Math.min(this.topY, this.bottomY)),
+            new Vec2_1.Vec2(this.rightX, Math.min(this.topY, this.bottomY)),
+            new Vec2_1.Vec2(this.rightX, Math.max(this.topY, this.bottomY)),
+            new Vec2_1.Vec2(this.leftX, Math.max(this.topY, this.bottomY)),
+        ];
+    }
+    flipVertical(xCenter) {
+        const left = xCenter - (this.rightX - xCenter);
+        const right = xCenter - (this.leftX - xCenter);
+        this.leftX = left;
+        this.rightX = right;
+        return this;
+    }
+    equals(other) {
+        return !!other && this.leftX === other.leftX && this.rightX === other.rightX && this.topY === other.topY && this.bottomY === other.bottomY;
+    }
+}
+exports.Rectangle = Rectangle;

package/cjs/Vec3.js

@@ -4,7 +4,7 @@ exports.Vec3 = void 0;
 const three_1 = require("three");
 const Vec2_1 = require("./Vec2");
 /**
- * Vec3 represents a 2D vector. It extends `Vector3` from the `threejs` library.
+ * Vec3 represents a 3D vector. It extends `Vector3` from the `threejs` library.
  */
 class Vec3 extends three_1.Vector3 {
     #target;

package/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Line3D = exports.Line2D = exports.Vec3 = exports.Vec2 = void 0;
+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");
@@ -9,3 +9,11 @@ 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; } });
+var Size2_1 = require("./Size2");
+Object.defineProperty(exports, "Size2", { enumerable: true, get: function () { return Size2_1.Size2; } });
+var Polygon_1 = require("./Polygon");
+Object.defineProperty(exports, "Polygon", { enumerable: true, get: function () { return Polygon_1.Polygon; } });
+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; } });

package/docs/classes/BoundingBox.md

@@ -0,0 +1,117 @@
+[@immugio/three-math-extensions](../README.md) / [Exports](../modules.md) / BoundingBox
+
+# Class: BoundingBox
+
+## Table of contents
+
+### Constructors
+
+- [constructor](BoundingBox.md#constructor)
+
+### Properties
+
+- [maxX](BoundingBox.md#maxx)
+- [maxY](BoundingBox.md#maxy)
+- [minX](BoundingBox.md#minx)
+- [minY](BoundingBox.md#miny)
+
+### Accessors
+
+- [size](BoundingBox.md#size)
+
+### Methods
+
+- [equals](BoundingBox.md#equals)
+
+## Constructors
+
+### constructor
+
+• **new BoundingBox**(`minX`, `maxX`, `minY`, `maxY`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `minX` | `number` |
+| `maxX` | `number` |
+| `minY` | `number` |
+| `maxY` | `number` |
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+
+## Properties
+
+### maxX
+
+• **maxX**: `number`
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+
+___
+
+### maxY
+
+• **maxY**: `number`
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+
+___
+
+### minX
+
+• **minX**: `number`
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+
+___
+
+### minY
+
+• **minY**: `number`
+
+#### Defined in
+
+[src/BoundingBox.ts:4](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L4)
+
+## Accessors
+
+### size
+
+• `get` **size**(): [`Vec2`](Vec2.md)
+
+#### Returns
+
+[`Vec2`](Vec2.md)
+
+#### Defined in
+
+[src/BoundingBox.ts:11](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L11)
+
+## Methods
+
+### equals
+
+▸ **equals**(`other`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `other` | [`BoundingBox`](BoundingBox.md) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/BoundingBox.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/BoundingBox.ts#L7)