@immugio/three-math-extensions 0.2.24 → 0.2.26

package/docs/classes/Vec2.md

@@ -74,7 +74,7 @@ Adds x amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec2.ts:53](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L53)
+[src/Vec2.ts:53](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L53)
 
 ___
 
@@ -96,7 +96,7 @@ Adds y amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec2.ts:44](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L44)
+[src/Vec2.ts:44](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L44)
 
 ___
 
@@ -120,7 +120,7 @@ A new Vec3 instance.
 
 #### Defined in
 
-[src/Vec2.ts:78](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L78)
+[src/Vec2.ts:78](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L78)
 
 ___
 
@@ -144,7 +144,7 @@ maxDistance is the maximum distance between the two vectors within which they ar
 
 #### Defined in
 
-[src/Vec2.ts:86](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L86)
+[src/Vec2.ts:86](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L86)
 
 ___
 
@@ -169,7 +169,7 @@ This Vec2 instance.
 
 #### Defined in
 
-[src/Vec2.ts:34](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L34)
+[src/Vec2.ts:34](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L34)
 
 ___
 
@@ -192,7 +192,7 @@ check if the angle between the two vectors is close enough to 0 or 180 degrees (
 
 #### Defined in
 
-[src/Vec2.ts:107](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L107)
+[src/Vec2.ts:107](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L107)
 
 ___
 
@@ -216,7 +216,7 @@ This Vec2 instance.
 
 #### Defined in
 
-[src/Vec2.ts:63](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L63)
+[src/Vec2.ts:63](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L63)
 
 ___
 
@@ -232,7 +232,7 @@ Returns the angle between this vector and positive x-axis, the return value is b
 
 #### Defined in
 
-[src/Vec2.ts:97](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L97)
+[src/Vec2.ts:97](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L97)
 
 ___
 
@@ -256,7 +256,7 @@ A new Vec2 instance.
 
 #### Defined in
 
-[src/Vec2.ts:16](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L16)
+[src/Vec2.ts:16](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L16)
 
 ___
 
@@ -279,4 +279,4 @@ Creates a new Vec2[] array from arguments of {x, y} objects.
 
 #### Defined in
 
-[src/Vec2.ts:24](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec2.ts#L24)
+[src/Vec2.ts:24](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec2.ts#L24)

package/docs/classes/Vec3.md

@@ -78,7 +78,7 @@ Adds x amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec3.ts:73](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L73)
+[src/Vec3.ts:73](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L73)
 
 ___
 
@@ -100,7 +100,7 @@ Adds y amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec3.ts:64](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L64)
+[src/Vec3.ts:64](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L64)
 
 ___
 
@@ -122,7 +122,7 @@ Adds z amount to this Vec3 instance and return this
 
 #### Defined in
 
-[src/Vec3.ts:82](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L82)
+[src/Vec3.ts:82](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L82)
 
 ___
 
@@ -140,7 +140,7 @@ Vector3.clone
 
 #### Defined in
 
-[src/Vec3.ts:131](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L131)
+[src/Vec3.ts:131](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L131)
 
 ___
 
@@ -162,7 +162,7 @@ Returns a clone of the point closest to this from the given points.
 
 #### Defined in
 
-[src/Vec3.ts:91](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L91)
+[src/Vec3.ts:91](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L91)
 
 ___
 
@@ -184,7 +184,7 @@ Get distance to another vector while ignoring the y-axis.
 
 #### Defined in
 
-[src/Vec3.ts:115](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L115)
+[src/Vec3.ts:115](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L115)
 
 ___
 
@@ -208,7 +208,7 @@ maxDistance is the maximum distance between the two vectors within which they ar
 
 #### Defined in
 
-[src/Vec3.ts:123](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L123)
+[src/Vec3.ts:123](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L123)
 
 ___
 
@@ -232,7 +232,7 @@ This Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:51](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L51)
+[src/Vec3.ts:51](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L51)
 
 ___
 
@@ -257,7 +257,7 @@ This Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:35](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L35)
+[src/Vec3.ts:35](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L35)
 
 ___
 
@@ -273,7 +273,7 @@ Projects this Vec3 instance onto 2d plan. Vec3.z becomes Vec2.y and Vec3.y is ig
 
 #### Defined in
 
-[src/Vec3.ts:107](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L107)
+[src/Vec3.ts:107](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L107)
 
 ___
 
@@ -289,7 +289,7 @@ Returns a clone of this Vec3 instance with y and z swapped.
 
 #### Defined in
 
-[src/Vec3.ts:100](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L100)
+[src/Vec3.ts:100](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L100)
 
 ___
 
@@ -313,7 +313,7 @@ A new Vec3 instance.
 
 #### Defined in
 
-[src/Vec3.ts:17](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L17)
+[src/Vec3.ts:17](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L17)
 
 ___
 
@@ -335,4 +335,4 @@ Creates a new Vec3[] array from arguments of {x, y, z} objects.
 
 #### Defined in
 
-[src/Vec3.ts:25](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Vec3.ts#L25)
+[src/Vec3.ts:25](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Vec3.ts#L25)

package/docs/interfaces/Point2.md

@@ -17,7 +17,7 @@
 
 #### Defined in
 
-[src/Point2.ts:2](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point2.ts#L2)
+[src/Point2.ts:2](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Point2.ts#L2)
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 #### Defined in
 
-[src/Point2.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point2.ts#L3)
+[src/Point2.ts:3](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Point2.ts#L3)

package/docs/interfaces/Point3.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[src/Point3.ts:2](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point3.ts#L2)
+[src/Point3.ts:2](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Point3.ts#L2)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[src/Point3.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point3.ts#L3)
+[src/Point3.ts:3](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Point3.ts#L3)
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-[src/Point3.ts:4](https://github.com/Immugio/three-math-extensions/blob/336678b/src/Point3.ts#L4)
+[src/Point3.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/Point3.ts#L4)

package/docs/modules.md

@@ -33,6 +33,7 @@
 - [isPointInPolygon](modules.md#ispointinpolygon)
 - [normalizeAngleDegrees](modules.md#normalizeangledegrees)
 - [normalizeAngleRadians](modules.md#normalizeangleradians)
+- [polygonPerimeter](modules.md#polygonperimeter)
 
 ## Variables
 
@@ -42,7 +43,7 @@
 
 #### Defined in
 
-[src/MathConstants.ts:2](https://github.com/Immugio/three-math-extensions/blob/336678b/src/MathConstants.ts#L2)
+[src/MathConstants.ts:2](https://github.com/Immugio/three-math-extensions/blob/e397290/src/MathConstants.ts#L2)
 
 ___
 
@@ -52,7 +53,7 @@ ___
 
 #### Defined in
 
-[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/336678b/src/MathConstants.ts#L1)
+[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/e397290/src/MathConstants.ts#L1)
 
 ___
 
@@ -73,7 +74,7 @@ ___
 
 #### Defined in
 
-[src/directions.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/directions.ts#L3)
+[src/directions.ts:3](https://github.com/Immugio/three-math-extensions/blob/e397290/src/directions.ts#L3)
 
 ___
 
@@ -92,7 +93,7 @@ ___
 
 #### Defined in
 
-[src/directions2d.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/directions2d.ts#L3)
+[src/directions2d.ts:3](https://github.com/Immugio/three-math-extensions/blob/e397290/src/directions2d.ts#L3)
 
 ## Functions
 
@@ -119,7 +120,7 @@ ___
 
 #### Defined in
 
-[src/isContinuousClosedShape.ts:4](https://github.com/Immugio/three-math-extensions/blob/336678b/src/isContinuousClosedShape.ts#L4)
+[src/isContinuousClosedShape.ts:4](https://github.com/Immugio/three-math-extensions/blob/e397290/src/isContinuousClosedShape.ts#L4)
 
 ___
 
@@ -140,7 +141,7 @@ ___
 
 #### Defined in
 
-[src/isPointInPolygon.ts:3](https://github.com/Immugio/three-math-extensions/blob/336678b/src/isPointInPolygon.ts#L3)
+[src/isPointInPolygon.ts:3](https://github.com/Immugio/three-math-extensions/blob/e397290/src/isPointInPolygon.ts#L3)
 
 ___
 
@@ -162,7 +163,7 @@ Normalizes an angle in degrees to the range [0, 360].
 
 #### Defined in
 
-[src/normalizeAngleDegrees.ts:5](https://github.com/Immugio/three-math-extensions/blob/336678b/src/normalizeAngleDegrees.ts#L5)
+[src/normalizeAngleDegrees.ts:5](https://github.com/Immugio/three-math-extensions/blob/e397290/src/normalizeAngleDegrees.ts#L5)
 
 ___
 
@@ -184,4 +185,25 @@ Normalize an angle in radians to the range of 0 to 2π.
 
 #### Defined in
 
-[src/normalizeAngleRadians.ts:7](https://github.com/Immugio/three-math-extensions/blob/336678b/src/normalizeAngleRadians.ts#L7)
+[src/normalizeAngleRadians.ts:7](https://github.com/Immugio/three-math-extensions/blob/e397290/src/normalizeAngleRadians.ts#L7)
+
+___
+
+### polygonPerimeter
+
+▸ **polygonPerimeter**(`polygon`, `forceClosedPolygon?`): `number`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `polygon` | [`Vec2`](classes/Vec2.md)[] | `undefined` |
+| `forceClosedPolygon` | `boolean` | `false` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[src/polygonPerimeter.ts:3](https://github.com/Immugio/three-math-extensions/blob/e397290/src/polygonPerimeter.ts#L3)

package/esm/Line2D.js

@@ -457,7 +457,7 @@ export class Line2D {
      * @param source
      * @param clips
      */
-    static clipLines(source, clips) {
+    static clipLines(source, clips, distanceTolerance = 0, parallelTolerance = 0) {
         if (!clips || clips.length === 0)
             return [source];
         clips = clips.map(c => {
@@ -473,7 +473,7 @@ export class Line2D {
             let isFree = true;
             const tested = sources.pop();
             for (const cover of clips) {
-                if (tested.overlaps(cover)) {
+                if (tested.overlaps(cover, distanceTolerance, parallelTolerance)) {
                     isFree = false;
                     const subtracted = this.subtractSingle(tested, cover);
                     sources.push(...subtracted);

package/esm/Polygon.js

@@ -98,6 +98,11 @@ export class Polygon {
             point.x = point.x < centerX ? centerX + xDistanceToCenter : centerX - xDistanceToCenter;
         }
     }
+    translate(translate) {
+        this.contour.forEach(p => p.add(translate));
+        this.holes?.forEach(hole => hole.forEach(p => p.add(translate)));
+        return this;
+    }
     toRectangle() {
         const bounding = this.boundingBox();
         return new Rectangle(bounding.minX, bounding.maxX, bounding.minY, bounding.maxY);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immugio/three-math-extensions",
-  "version": "0.2.24",
+  "version": "0.2.26",
   "description": "Set of utilities for 2d and 3d line math built on top of three.js",
   "author": "Jan Mikeska <janmikeska@gmail.com>",
   "license": "ISC",

package/src/Line2D.ts

@@ -504,7 +504,7 @@ export class Line2D {
         return target.subVectors(this.end, this.start);
     }
 
-    public closestPointToPointParameter(point, clampToLine): number {
+    public closestPointToPointParameter(point: Vector2, clampToLine: boolean): number {
         _startP.subVectors(point, this.start);
         _startEnd.subVectors(this.end, this.start);
 
@@ -538,7 +538,7 @@ export class Line2D {
      * @param source
      * @param clips
      */
-    public static clipLines(source: Line2D, clips: Line2D[]): Line2D[] {
+    public static clipLines(source: Line2D, clips: Line2D[], distanceTolerance: number = 0, parallelTolerance: number = 0): Line2D[] {
         if (!clips || clips.length === 0) return [source];
 
         clips = clips.map(c => {
@@ -560,7 +560,7 @@ export class Line2D {
 
             for (const cover of clips) {
 
-                if (tested.overlaps(cover)) {
+                if (tested.overlaps(cover, distanceTolerance, parallelTolerance)) {
                     isFree = false;
                     const subtracted = this.subtractSingle(tested, cover);
                     sources.push(...subtracted);

package/src/Polygon.ts

@@ -28,7 +28,7 @@ export class Polygon {
         return new Vec2(maxX - minX, maxY - minY);
     }
 
-    public centerOnOrigin(): Polygon {
+    public centerOnOrigin(): this {
         const center = this.center();
 
         function centerPoints(points: Vec2[]): void {
@@ -56,7 +56,7 @@ export class Polygon {
         return new Vec2(x, y);
     }
 
-    public ensureLastPoint(): Polygon {
+    public ensureLastPoint(): this {
         function ensure(points: Vec2[]): void {
             if (!points[0].equals(points.at(-1))) {
                 points.push(points[0].clone());
@@ -95,7 +95,7 @@ export class Polygon {
         ]);
     }
 
-    public flip(): Polygon {
+    public flip(): this {
         const centerX = this.center().x;
         this.flipSingle(centerX, this.contour);
         this.holes?.forEach(hole => this.flipSingle(centerX, hole));
@@ -110,13 +110,19 @@ export class Polygon {
         return isPointInPolygon(this.contour, point) && (this.holes || []).every(hole => !isPointInPolygon(hole, point));
     }
 
-    private flipSingle(centerX: number, poly: Vec2[]) {
+    private flipSingle(centerX: number, poly: Vec2[]): void {
         for (const point of poly) {
             const xDistanceToCenter = Math.abs(centerX - point.x);
             point.x = point.x < centerX ? centerX + xDistanceToCenter : centerX - xDistanceToCenter;
         }
     }
 
+    public translate(translate: Vec2): this {
+        this.contour.forEach(p => p.add(translate));
+        this.holes?.forEach(hole => hole.forEach(p => p.add(translate)));
+        return this;
+    }
+
     public toRectangle(): Rectangle {
         const bounding = this.boundingBox();
         return new Rectangle(bounding.minX, bounding.maxX, bounding.minY, bounding.maxY);

package/types/Line2D.d.ts

@@ -185,7 +185,7 @@ export declare class Line2D {
      */
     closestPointToPoint(point: Vector2, clampToLine?: boolean, target?: Vec2): Vec2;
     delta(target: Vec2): Vec2;
-    closestPointToPointParameter(point: any, clampToLine: any): number;
+    closestPointToPointParameter(point: Vector2, clampToLine: boolean): number;
     /**
      * Returns the distance between the **infinite** line and the point.
      * @param point
@@ -198,7 +198,7 @@ export declare class Line2D {
      * @param source
      * @param clips
      */
-    static clipLines(source: Line2D, clips: Line2D[]): Line2D[];
+    static clipLines(source: Line2D, clips: Line2D[], distanceTolerance?: number, parallelTolerance?: number): Line2D[];
     /**
      * Returns the original line section split into two parts, if the line **sections** overlap, otherwise null
      */

package/types/Polygon.d.ts

@@ -9,15 +9,16 @@ export declare class Polygon {
     static fromPoints(contour: Point2[], holes?: Point2[][]): Polygon;
     static fromSize(width: number, height: number): Polygon;
     get size(): Vec2;
-    centerOnOrigin(): Polygon;
+    centerOnOrigin(): this;
     center(): Vec2;
-    ensureLastPoint(): Polygon;
+    ensureLastPoint(): this;
     boundingBox(): BoundingBox;
     toBoundingPolygon(): Polygon;
-    flip(): Polygon;
+    flip(): this;
     perimeter(): number;
     containsPoint(point: Vec2): boolean;
     private flipSingle;
+    translate(translate: Vec2): this;
     toRectangle(): Rectangle;
     clone(): Polygon;
     equals(other: Polygon): boolean;