@immugio/three-math-extensions 0.1.0 → 0.2.0

package/docs/classes/Rectangle.md

@@ -0,0 +1,287 @@
+[@immugio/three-math-extensions](../README.md) / [Exports](../modules.md) / Rectangle
+
+# Class: Rectangle
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Rectangle.md#constructor)
+
+### Properties
+
+- [bottomY](Rectangle.md#bottomy)
+- [leftX](Rectangle.md#leftx)
+- [rightX](Rectangle.md#rightx)
+- [topY](Rectangle.md#topy)
+
+### Accessors
+
+- [center](Rectangle.md#center)
+- [hasSize](Rectangle.md#hassize)
+- [offset](Rectangle.md#offset)
+- [size](Rectangle.md#size)
+
+### Methods
+
+- [centerOnOrigin](Rectangle.md#centeronorigin)
+- [clone](Rectangle.md#clone)
+- [equals](Rectangle.md#equals)
+- [flipVertical](Rectangle.md#flipvertical)
+- [overlaps](Rectangle.md#overlaps)
+- [toPoints](Rectangle.md#topoints)
+- [toPolygon](Rectangle.md#topolygon)
+- [translate](Rectangle.md#translate)
+
+## Constructors
+
+### constructor
+
+• **new Rectangle**(`leftX`, `rightX`, `topY`, `bottomY`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `leftX` | `number` |
+| `rightX` | `number` |
+| `topY` | `number` |
+| `bottomY` | `number` |
+
+#### Defined in
+
+[src/Rectangle.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L7)
+
+## Properties
+
+### bottomY
+
+• **bottomY**: `number`
+
+#### Defined in
+
+[src/Rectangle.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L7)
+
+___
+
+### leftX
+
+• **leftX**: `number`
+
+#### Defined in
+
+[src/Rectangle.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L7)
+
+___
+
+### rightX
+
+• **rightX**: `number`
+
+#### Defined in
+
+[src/Rectangle.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L7)
+
+___
+
+### topY
+
+• **topY**: `number`
+
+#### Defined in
+
+[src/Rectangle.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L7)
+
+## Accessors
+
+### center
+
+• `get` **center**(): [`Vec2`](Vec2.md)
+
+#### Returns
+
+[`Vec2`](Vec2.md)
+
+#### Defined in
+
+[src/Rectangle.ts:20](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L20)
+
+___
+
+### hasSize
+
+• `get` **hasSize**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/Rectangle.ts:41](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L41)
+
+___
+
+### offset
+
+• `get` **offset**(): [`Vec2`](Vec2.md)
+
+#### Returns
+
+[`Vec2`](Vec2.md)
+
+#### Defined in
+
+[src/Rectangle.ts:27](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L27)
+
+___
+
+### size
+
+• `get` **size**(): [`Vec2`](Vec2.md)
+
+#### Returns
+
+[`Vec2`](Vec2.md)
+
+#### Defined in
+
+[src/Rectangle.ts:13](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L13)
+
+## Methods
+
+### centerOnOrigin
+
+▸ **centerOnOrigin**(): [`Rectangle`](Rectangle.md)
+
+#### Returns
+
+[`Rectangle`](Rectangle.md)
+
+#### Defined in
+
+[src/Rectangle.ts:54](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L54)
+
+___
+
+### clone
+
+▸ **clone**(): [`Rectangle`](Rectangle.md)
+
+#### Returns
+
+[`Rectangle`](Rectangle.md)
+
+#### Defined in
+
+[src/Rectangle.ts:9](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L9)
+
+___
+
+### equals
+
+▸ **equals**(`other`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `other` | [`Rectangle`](Rectangle.md) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/Rectangle.ts:90](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L90)
+
+___
+
+### flipVertical
+
+▸ **flipVertical**(`xCenter`): [`Rectangle`](Rectangle.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `xCenter` | `number` |
+
+#### Returns
+
+[`Rectangle`](Rectangle.md)
+
+#### Defined in
+
+[src/Rectangle.ts:80](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L80)
+
+___
+
+### overlaps
+
+▸ **overlaps**(`other`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `other` | [`Rectangle`](Rectangle.md) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[src/Rectangle.ts:34](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L34)
+
+___
+
+### toPoints
+
+▸ **toPoints**(): [`Vec2`](Vec2.md)[]
+
+The polygon is always constructed as "clockwise", assuming X axis to the right and Y axis down.
+
+#### Returns
+
+[`Vec2`](Vec2.md)[]
+
+#### Defined in
+
+[src/Rectangle.ts:71](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L71)
+
+___
+
+### toPolygon
+
+▸ **toPolygon**(): [`Polygon`](Polygon.md)
+
+#### Returns
+
+[`Polygon`](Polygon.md)
+
+#### Defined in
+
+[src/Rectangle.ts:64](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L64)
+
+___
+
+### translate
+
+▸ **translate**(`diff`): [`Rectangle`](Rectangle.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `diff` | `Point2` |
+
+#### Returns
+
+[`Rectangle`](Rectangle.md)
+
+#### Defined in
+
+[src/Rectangle.ts:45](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Rectangle.ts#L45)

package/docs/classes/Size2.md

@@ -0,0 +1,51 @@
+[@immugio/three-math-extensions](../README.md) / [Exports](../modules.md) / Size2
+
+# Class: Size2
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Size2.md#constructor)
+
+### Properties
+
+- [height](Size2.md#height)
+- [width](Size2.md#width)
+
+## Constructors
+
+### constructor
+
+• **new Size2**(`width`, `height`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `width` | `number` |
+| `height` | `number` |
+
+#### Defined in
+
+[src/Size2.ts:2](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Size2.ts#L2)
+
+## Properties
+
+### height
+
+• **height**: `number`
+
+#### Defined in
+
+[src/Size2.ts:2](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Size2.ts#L2)
+
+___
+
+### width
+
+• **width**: `number`
+
+#### Defined in
+
+[src/Size2.ts:2](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Size2.ts#L2)

package/docs/classes/Vec2.md

@@ -67,7 +67,7 @@ A new Vec3 instance.
 
 #### Defined in
 
-[src/Vec2.ts:51](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec2.ts#L51)
+[src/Vec2.ts:51](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec2.ts#L51)
 
 ___
 
@@ -91,7 +91,7 @@ maxDistance is the maximum distance between the two vectors within which they ar
 
 #### Defined in
 
-[src/Vec2.ts:59](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec2.ts#L59)
+[src/Vec2.ts:59](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec2.ts#L59)
 
 ___
 
@@ -116,7 +116,7 @@ This Vec2 instance.
 
 #### Defined in
 
-[src/Vec2.ts:25](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec2.ts#L25)
+[src/Vec2.ts:25](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec2.ts#L25)
 
 ___
 
@@ -140,7 +140,7 @@ This Vec2 instance.
 
 #### Defined in
 
-[src/Vec2.ts:36](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec2.ts#L36)
+[src/Vec2.ts:36](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec2.ts#L36)
 
 ___
 
@@ -164,4 +164,4 @@ A new Vec2 instance.
 
 #### Defined in
 
-[src/Vec2.ts:15](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec2.ts#L15)
+[src/Vec2.ts:15](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec2.ts#L15)

package/docs/classes/Vec3.md

@@ -2,7 +2,7 @@
 
 # Class: Vec3
 
-Vec3 represents a 2D vector. It extends `Vector3` from the `threejs` library.
+Vec3 represents a 3D vector. It extends `Vector3` from the `threejs` library.
 
 ## Hierarchy
 
@@ -72,7 +72,7 @@ Adds x amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec3.ts:65](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L65)
+[src/Vec3.ts:65](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L65)
 
 ___
 
@@ -94,7 +94,7 @@ Adds y amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec3.ts:56](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L56)
+[src/Vec3.ts:56](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L56)
 
 ___
 
@@ -112,7 +112,7 @@ Vector3.clone
 
 #### Defined in
 
-[src/Vec3.ts:114](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L114)
+[src/Vec3.ts:114](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L114)
 
 ___
 
@@ -134,7 +134,7 @@ Returns a clone of the point closest to this from the given points.
 
 #### Defined in
 
-[src/Vec3.ts:74](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L74)
+[src/Vec3.ts:74](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L74)
 
 ___
 
@@ -156,7 +156,7 @@ Get distance to another vector while ignoring the y-axis.
 
 #### Defined in
 
-[src/Vec3.ts:98](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L98)
+[src/Vec3.ts:98](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L98)
 
 ___
 
@@ -180,7 +180,7 @@ maxDistance is the maximum distance between the two vectors within which they ar
 
 #### Defined in
 
-[src/Vec3.ts:106](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L106)
+[src/Vec3.ts:106](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L106)
 
 ___
 
@@ -204,7 +204,7 @@ This Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:43](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L43)
+[src/Vec3.ts:43](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L43)
 
 ___
 
@@ -229,7 +229,7 @@ This Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:27](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L27)
+[src/Vec3.ts:27](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L27)
 
 ___
 
@@ -245,7 +245,7 @@ Projects this Vec3 instance onto 2d plan. Vec3.z becomes Vec2.y and Vec3.y is ig
 
 #### Defined in
 
-[src/Vec3.ts:90](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L90)
+[src/Vec3.ts:90](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L90)
 
 ___
 
@@ -261,7 +261,7 @@ Returns a clone of this Vec3 instance with y and z swapped.
 
 #### Defined in
 
-[src/Vec3.ts:83](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L83)
+[src/Vec3.ts:83](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L83)
 
 ___
 
@@ -285,4 +285,4 @@ A new Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:17](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Vec3.ts#L17)
+[src/Vec3.ts:17](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Vec3.ts#L17)

package/docs/modules.md

@@ -6,7 +6,11 @@
 
 ### Classes
 
+- [BoundingBox](classes/BoundingBox.md)
 - [Line2D](classes/Line2D.md)
 - [Line3D](classes/Line3D.md)
+- [Polygon](classes/Polygon.md)
+- [Rectangle](classes/Rectangle.md)
+- [Size2](classes/Size2.md)
 - [Vec2](classes/Vec2.md)
 - [Vec3](classes/Vec3.md)

package/esm/BoundingBox.js

@@ -0,0 +1,19 @@
+import { Vec2 } from "./Vec2";
+export 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(this.maxX - this.minX, this.maxY - this.minY);
+    }
+}

package/esm/Polygon.js

@@ -1,5 +1,6 @@
 import { Vec2 } from "./Vec2";
-import { Size2 } from "./Size2";
+import { Rectangle } from "./Rectangle";
+import { BoundingBox } from "./BoundingBox";
 export class Polygon {
     contour;
     holes;
@@ -12,7 +13,7 @@ export class Polygon {
     }
     get size() {
         const { minX, maxX, minY, maxY } = this.boundingBox();
-        return new Size2(maxX - minX, maxY - minY);
+        return new Vec2(maxX - minX, maxY - minY);
     }
     centerOnOrigin() {
         const center = this.center();
@@ -36,7 +37,7 @@ export 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());
             }
         }
@@ -58,7 +59,7 @@ export class Polygon {
             if (maxY < p.y)
                 maxY = p.y;
         }
-        return { minX, maxX, minY, maxY };
+        return new BoundingBox(minX, maxX, minY, maxY);
     }
     toBoundingPolygon() {
         const bounding = this.boundingBox();
@@ -81,4 +82,37 @@ export class Polygon {
             point.x = point.x < centerX ? centerX + xDistanceToCenter : centerX - xDistanceToCenter;
         }
     }
+    toRectangle() {
+        const bounding = this.boundingBox();
+        return new 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;
+    }
 }

package/esm/Rectangle.js

@@ -0,0 +1,73 @@
+import { Polygon } from "./Polygon";
+import { Vec2 } from "./Vec2";
+export 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(this.rightX - this.leftX, this.topY - this.bottomY);
+    }
+    get center() {
+        return new Vec2((this.leftX + this.rightX) / 2, (this.topY + this.bottomY) / 2);
+    }
+    get offset() {
+        return new 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(this.toPoints());
+    }
+    /**
+     * The polygon is always constructed as "clockwise", assuming X axis to the right and Y axis down.
+     */
+    toPoints() {
+        return [
+            new Vec2(this.leftX, Math.min(this.topY, this.bottomY)),
+            new Vec2(this.rightX, Math.min(this.topY, this.bottomY)),
+            new Vec2(this.rightX, Math.max(this.topY, this.bottomY)),
+            new 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;
+    }
+}

package/esm/Vec3.js

@@ -1,7 +1,7 @@
 import { Vector3 } from "three";
 import { Vec2 } from "./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.
  */
 export class Vec3 extends Vector3 {
     #target;

package/esm/index.js

@@ -2,3 +2,7 @@ export { Vec2 } from "./Vec2";
 export { Vec3 } from "./Vec3";
 export { Line2D } from "./Line2D";
 export { Line3D } from "./Line3D";
+export { Size2 } from "./Size2";
+export { Polygon } from "./Polygon";
+export { BoundingBox } from "./BoundingBox";
+export { Rectangle } from "./Rectangle";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immugio/three-math-extensions",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Set of utilities for 2d and 3d line math built on top of three.js",
   "author": "Jan Mikeska <janmikeska@gmail.com>",
   "license": "ISC",
@@ -42,7 +42,7 @@
     "ts-jest": "^29.0.0",
     "typedoc": "^0.23.23",
     "typedoc-plugin-markdown": "^3.14.0",
-    "typescript": "4.7.4"
+    "typescript": "4.9.5"
   },
   "peerDependencies": {
     "three": ">=0.130.1"