@immugio/three-math-extensions 0.2.10 → 0.2.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -7,31 +7,57 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
9
9
 
10
- ## [0.2.10](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.10)
10
+ ## [0.2.12](https://github.com/Immugio/three-math-extensions/compare/16.15.10...0.2.12)
11
11
 
12
12
  ### Commits
13
13
 
14
+ - Add eslint [`98e4912`](https://github.com/Immugio/three-math-extensions/commit/98e4912d637b42ba80e2f3267638b43296113019)
15
+ - Update jest packages [`af23b4f`](https://github.com/Immugio/three-math-extensions/commit/af23b4f08154bba3407f05b773865215e7e1cba8)
14
16
  - Add Rectangle, update Polygon [`58ee875`](https://github.com/Immugio/three-math-extensions/commit/58ee87539af8f9ade186e5250cba9e01926da514)
15
17
  - Add isPointInPolygon [`a59eb4b`](https://github.com/Immugio/three-math-extensions/commit/a59eb4be026f17a3106070ae626a0588cd4f4411)
16
18
  - Improve Line2D.closestPointToPoint, add Vec2.signedAngle [`151f214`](https://github.com/Immugio/three-math-extensions/commit/151f21462e0358057ad8e9d75d5782563a1061f6)
17
19
  - Improve documentation [`d0fcb51`](https://github.com/Immugio/three-math-extensions/commit/d0fcb5132f127b4382ac5f7291575a061b8ec121)
18
20
  - Vec3, Line3D - update documentation [`67d9c32`](https://github.com/Immugio/three-math-extensions/commit/67d9c328e08cc0a5599932d2f0529e97f31c9213)
19
21
  - Add Polygon [`629cff8`](https://github.com/Immugio/three-math-extensions/commit/629cff8ecbb963477e8ea76d7f8b16d95435cbad)
22
+ - Line3D.groupConnectedLines added [`29f372b`](https://github.com/Immugio/three-math-extensions/commit/29f372bc984c06b00c50fcd9428ce9a7b9cab799)
23
+ - Dependencies update and remove now duplicate Vec2.angleTo implementation [`4774abb`](https://github.com/Immugio/three-math-extensions/commit/4774abb81d882082df0da606c79a3c7bd3aecc57)
24
+ - Line2D.isCloserToHorizontal [`b6f1429`](https://github.com/Immugio/three-math-extensions/commit/b6f14292d1d2765f7314c45e4c74be91280ac764)
25
+ - Add Vec2.angleTo and tests [`dcf1e53`](https://github.com/Immugio/three-math-extensions/commit/dcf1e531aecf8c115f323e14e5e44059e5c5d15c)
20
26
  - Add Vec2.signedAngle [`863c8f2`](https://github.com/Immugio/three-math-extensions/commit/863c8f27f11288cbda535e21bb688206259269ed)
21
27
  - Add Vec2.fromPoints to accept multiple points [`a261402`](https://github.com/Immugio/three-math-extensions/commit/a2614027cf5fb8263189b48f7e0bb9a23a552c15)
22
28
  - Add Vec2.parallelTo [`989874d`](https://github.com/Immugio/three-math-extensions/commit/989874dcfe122d3ee84d8d56d79cb88e4e441736)
23
29
  - Line2D.intersect - enable line segments intersection only [`1f1470e`](https://github.com/Immugio/three-math-extensions/commit/1f1470e1cf00118e643f5c44a135e0baf6b76d41)
30
+ - Add Line2D.projectOn [`4c52c5c`](https://github.com/Immugio/three-math-extensions/commit/4c52c5c2e649fbddb72ce3fca60cfd3f1319f72f)
31
+ - Add Line3D.index [`7ed13d2`](https://github.com/Immugio/three-math-extensions/commit/7ed13d213748056c9dafd86288c3bcec9a28d1ba)
24
32
  - Polygon from bounding size [`eae6701`](https://github.com/Immugio/three-math-extensions/commit/eae67012f57f426f8b5259b765000447ce06d608)
25
33
  - Line2D and Line3D to return this instead of specific type [`761ef6a`](https://github.com/Immugio/three-math-extensions/commit/761ef6a9d8cc4e35120b666576794e521aa3b991)
26
34
  - Line2D.in3DSpace added [`a6ce0ec`](https://github.com/Immugio/three-math-extensions/commit/a6ce0ecb67f5c7b2a75fcc283c28af626153a4af)
27
35
  - Line2D.hasIntersectionWithAngle to support optional tolerance [`b313bbe`](https://github.com/Immugio/three-math-extensions/commit/b313bbe118d435d53750deefd9a9e29ba6ec5c71)
28
36
  - Line2D.hasIntersectionWithAngle - modulo all angles [`5409aa0`](https://github.com/Immugio/three-math-extensions/commit/5409aa0bc41510efa86d548e91837e44e5b6c343)
37
+ - Use Vec2 instead of Vector2 [`7e6a6ea`](https://github.com/Immugio/three-math-extensions/commit/7e6a6ea272f4441ef4bc78b3fdec23fc783fa1db)
29
38
  - Update release instructions [`5b41a2e`](https://github.com/Immugio/three-math-extensions/commit/5b41a2ed7e15450dbb6088a7f7ed0031a013badc)
30
39
  - Add Polygon to exports [`ed66775`](https://github.com/Immugio/three-math-extensions/commit/ed66775c33e961835b23843222b822cfd9c16b1d)
31
40
  - Vec2.fromPoint and Vec3.fromPoint should accept null [`4b871af`](https://github.com/Immugio/three-math-extensions/commit/4b871af297bdcbe8584f1e2b99d602247b77687c)
41
+ - Documentation update [`d5c7a07`](https://github.com/Immugio/three-math-extensions/commit/d5c7a0765f6097f5d3a3be01967d4059f19682fb)
32
42
  - Excluded files from build [`ec70614`](https://github.com/Immugio/three-math-extensions/commit/ec70614bc7df7a98f854c7a6693365118e04faf7)
33
43
 
34
- ## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.9...16.15.10) - 2023-01-02
44
+ ## [16.15.10](https://github.com/Immugio/three-math-extensions/compare/0.2.11...16.15.10) - 2023-01-02
45
+
46
+ ## [0.2.11](https://github.com/Immugio/three-math-extensions/compare/0.2.10...0.2.11) - 2023-08-24
47
+
48
+ ### Commits
49
+
50
+ - Line2D.isCloserToHorizontal [`b6f1429`](https://github.com/Immugio/three-math-extensions/commit/b6f14292d1d2765f7314c45e4c74be91280ac764)
51
+ - Add Vec2.angleTo and tests [`dcf1e53`](https://github.com/Immugio/three-math-extensions/commit/dcf1e531aecf8c115f323e14e5e44059e5c5d15c)
52
+ - Add Line2D.projectOn [`4c52c5c`](https://github.com/Immugio/three-math-extensions/commit/4c52c5c2e649fbddb72ce3fca60cfd3f1319f72f)
53
+ - Use Vec2 instead of Vector2 [`7e6a6ea`](https://github.com/Immugio/three-math-extensions/commit/7e6a6ea272f4441ef4bc78b3fdec23fc783fa1db)
54
+ - Documentation update [`d5c7a07`](https://github.com/Immugio/three-math-extensions/commit/d5c7a0765f6097f5d3a3be01967d4059f19682fb)
55
+
56
+ ## [0.2.10](https://github.com/Immugio/three-math-extensions/compare/0.2.9...0.2.10) - 2023-05-30
57
+
58
+ ### Commits
59
+
60
+ - Add isPointInPolygon [`a59eb4b`](https://github.com/Immugio/three-math-extensions/commit/a59eb4be026f17a3106070ae626a0588cd4f4411)
35
61
 
36
62
  ## [0.2.9](https://github.com/Immugio/three-math-extensions/compare/0.2.8...0.2.9) - 2023-05-22
37
63
 
package/cjs/Line2D.js CHANGED
@@ -6,6 +6,7 @@ const Vec2_1 = require("./Vec2");
6
6
  const three_2 = require("three");
7
7
  const MathConstants_1 = require("./MathConstants");
8
8
  const Line3D_1 = require("./Line3D");
9
+ const directions2d_1 = require("./directions2d");
9
10
  const _startP = /*@__PURE__*/ new Vec2_1.Vec2();
10
11
  const _startEnd = /*@__PURE__*/ new Vec2_1.Vec2();
11
12
  class Line2D {
@@ -316,6 +317,16 @@ class Line2D {
316
317
  }
317
318
  return result;
318
319
  }
320
+ /**
321
+ * Returns a new line that is the projection of this line onto @other. Uses `closestPointToPoint` to find the projection.
322
+ * @param other
323
+ * @param clampToLine
324
+ */
325
+ projectOn(other, clampToLine) {
326
+ const p1 = other.closestPointToPoint(this.start, clampToLine, new Vec2_1.Vec2());
327
+ const p2 = other.closestPointToPoint(this.end, clampToLine, new Vec2_1.Vec2());
328
+ return p1.distanceTo(this.start) < p2.distanceTo(this.start) ? new Line2D(p1, p2) : new Line2D(p2, p1);
329
+ }
319
330
  /**
320
331
  * Divides the Line3D into a number of segments of the given length.
321
332
  * Clone the line, does not modify.
@@ -562,6 +573,13 @@ class Line2D {
562
573
  }
563
574
  return null;
564
575
  }
576
+ get isCloserToHorizontal() {
577
+ const direction = this.direction;
578
+ return direction.angleTo(directions2d_1.directions2d.Right) < Math.PI / 4 || direction.angleTo(directions2d_1.directions2d.Left) < Math.PI / 4;
579
+ }
580
+ get isCloserToVertical() {
581
+ return !this.isCloserToHorizontal;
582
+ }
565
583
  /**
566
584
  * Project the line to 2D space. For start and end points Vec2.y becomes Vec3.z. and Vec3.y is provided as an argument.
567
585
  * @param y - The y value of the new Vec3 instance.
package/cjs/Line3D.js CHANGED
@@ -5,13 +5,15 @@ const three_1 = require("three");
5
5
  const Vec3_1 = require("./Vec3");
6
6
  const Line2D_1 = require("./Line2D");
7
7
  class Line3D extends three_1.Line3 {
8
+ index;
8
9
  #target;
9
- constructor(start, end) {
10
+ constructor(start, end, index = 0) {
10
11
  super(start, end);
12
+ this.index = index;
11
13
  this.#target = new Vec3_1.Vec3();
12
14
  }
13
- static fromPoints(start, end) {
14
- return new Line3D(new Vec3_1.Vec3(start.x, start.y, start.z), new Vec3_1.Vec3(end.x, end.y, end.z));
15
+ static fromPoints(start, end, index = 0) {
16
+ return new Line3D(new Vec3_1.Vec3(start.x, start.y, start.z), new Vec3_1.Vec3(end.x, end.y, end.z), index);
15
17
  }
16
18
  /**
17
19
  * Creates a polygon formed by an array of lines from points provided.
@@ -27,7 +29,7 @@ class Line3D extends three_1.Line3 {
27
29
  }
28
30
  const lines = [];
29
31
  for (let i = 0; i < polygon.length - 1; i++) {
30
- lines.push(Line3D.fromPoints(polygon[i], polygon[i + 1]));
32
+ lines.push(Line3D.fromPoints(polygon[i], polygon[i + 1], i));
31
33
  }
32
34
  return lines;
33
35
  }
@@ -406,6 +408,41 @@ class Line3D extends three_1.Line3 {
406
408
  const resultSegmentPoint2 = new Vec3_1.Vec3((p3.x + mub * p43.x), (p3.y + mub * p43.y), (p3.z + mub * p43.z));
407
409
  return new Line3D(resultSegmentPoint1, resultSegmentPoint2);
408
410
  }
411
+ /**
412
+ * Accepts an array of Line3D and groups them into arrays of connected lines
413
+ * @param lines Lines to be grouped
414
+ * @param tolerance Tolerance for considering lines as connected
415
+ */
416
+ static groupConnectedLines(lines, tolerance = 0) {
417
+ const visited = new Set();
418
+ // Use graph-based approach. Each line can be considered as an edge in the graph, and the endpoints of the lines can be considered as vertices.
419
+ // Then use Depth-First Search (DFS) to find connected components in the graph.
420
+ const dfs = (line, group) => {
421
+ if (visited.has(line))
422
+ return;
423
+ visited.add(line);
424
+ group.push(line);
425
+ lines.forEach((neighbor) => {
426
+ if (!visited.has(neighbor)) {
427
+ if ((line.start).isNear(neighbor.start, tolerance) ||
428
+ (line.start).isNear(neighbor.end, tolerance) ||
429
+ (line.end).isNear(neighbor.start, tolerance) ||
430
+ (line.end).isNear(neighbor.end, tolerance)) {
431
+ dfs(neighbor, group);
432
+ }
433
+ }
434
+ });
435
+ };
436
+ const connectedLines = [];
437
+ lines.forEach((line) => {
438
+ if (!visited.has(line)) {
439
+ const group = [];
440
+ dfs(line, group);
441
+ connectedLines.push(group);
442
+ }
443
+ });
444
+ return connectedLines;
445
+ }
409
446
  /**
410
447
  * Project the line to 2D space, Y value is dropped
411
448
  */
@@ -422,7 +459,7 @@ class Line3D extends three_1.Line3 {
422
459
  * Deep clone of this line
423
460
  */
424
461
  clone() {
425
- return new Line3D(this.start.clone(), this.end.clone());
462
+ return new Line3D(this.start.clone(), this.end.clone(), this.index);
426
463
  }
427
464
  toString() {
428
465
  return `Line3D { start: ${this.start.x}, ${this.start.y}, ${this.start.z}, end: ${this.end.x}, ${this.end.y}, ${this.end.z}}`;
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.directions = void 0;
4
+ const Vec3_1 = require("./Vec3");
5
+ exports.directions = {
6
+ North: new Vec3_1.Vec3(0, 0, -1),
7
+ South: new Vec3_1.Vec3(0, 0, 1),
8
+ East: new Vec3_1.Vec3(1, 0, 0),
9
+ West: new Vec3_1.Vec3(-1, 0, 0),
10
+ Up: new Vec3_1.Vec3(0, 1, 0),
11
+ Down: new Vec3_1.Vec3(0, -1, 0)
12
+ };
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.directions2d = void 0;
4
+ const Vec2_1 = require("./Vec2");
5
+ exports.directions2d = {
6
+ Up: new Vec2_1.Vec2(0, -1),
7
+ Down: new Vec2_1.Vec2(0, 1),
8
+ Left: new Vec2_1.Vec2(-1, 0),
9
+ Right: new Vec2_1.Vec2(1, 0)
10
+ };
package/cjs/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isPointInPolygon = exports.TwoPI = exports.normalizeAngleRadians = exports.normalizeAngleDegrees = exports.Rectangle = exports.BoundingBox = exports.Polygon = exports.Size2 = exports.Line3D = exports.Line2D = exports.Vec3 = exports.Vec2 = void 0;
3
+ exports.directions2d = exports.directions = exports.isPointInPolygon = exports.TwoPI = exports.normalizeAngleRadians = exports.normalizeAngleDegrees = exports.Rectangle = exports.BoundingBox = exports.Polygon = exports.Size2 = exports.Line3D = exports.Line2D = exports.Vec3 = exports.Vec2 = void 0;
4
4
  var Vec2_1 = require("./Vec2");
5
5
  Object.defineProperty(exports, "Vec2", { enumerable: true, get: function () { return Vec2_1.Vec2; } });
6
6
  var Vec3_1 = require("./Vec3");
@@ -25,3 +25,7 @@ var MathConstants_1 = require("./MathConstants");
25
25
  Object.defineProperty(exports, "TwoPI", { enumerable: true, get: function () { return MathConstants_1.TwoPI; } });
26
26
  var isPointInPolygon_1 = require("./isPointInPolygon");
27
27
  Object.defineProperty(exports, "isPointInPolygon", { enumerable: true, get: function () { return isPointInPolygon_1.isPointInPolygon; } });
28
+ var directions_1 = require("./directions");
29
+ Object.defineProperty(exports, "directions", { enumerable: true, get: function () { return directions_1.directions; } });
30
+ var directions2d_1 = require("./directions2d");
31
+ Object.defineProperty(exports, "directions2d", { enumerable: true, get: function () { return directions2d_1.directions2d; } });
package/esm/Line2D.js CHANGED
@@ -3,6 +3,7 @@ import { Vec2 } from "./Vec2";
3
3
  import { MathUtils } from "three";
4
4
  import { TwoPI } from "./MathConstants";
5
5
  import { Line3D } from "./Line3D";
6
+ import { directions2d } from "./directions2d";
6
7
  const _startP = /*@__PURE__*/ new Vec2();
7
8
  const _startEnd = /*@__PURE__*/ new Vec2();
8
9
  export class Line2D {
@@ -313,6 +314,16 @@ export class Line2D {
313
314
  }
314
315
  return result;
315
316
  }
317
+ /**
318
+ * Returns a new line that is the projection of this line onto @other. Uses `closestPointToPoint` to find the projection.
319
+ * @param other
320
+ * @param clampToLine
321
+ */
322
+ projectOn(other, clampToLine) {
323
+ const p1 = other.closestPointToPoint(this.start, clampToLine, new Vec2());
324
+ const p2 = other.closestPointToPoint(this.end, clampToLine, new Vec2());
325
+ return p1.distanceTo(this.start) < p2.distanceTo(this.start) ? new Line2D(p1, p2) : new Line2D(p2, p1);
326
+ }
316
327
  /**
317
328
  * Divides the Line3D into a number of segments of the given length.
318
329
  * Clone the line, does not modify.
@@ -559,6 +570,13 @@ export class Line2D {
559
570
  }
560
571
  return null;
561
572
  }
573
+ get isCloserToHorizontal() {
574
+ const direction = this.direction;
575
+ return direction.angleTo(directions2d.Right) < Math.PI / 4 || direction.angleTo(directions2d.Left) < Math.PI / 4;
576
+ }
577
+ get isCloserToVertical() {
578
+ return !this.isCloserToHorizontal;
579
+ }
562
580
  /**
563
581
  * Project the line to 2D space. For start and end points Vec2.y becomes Vec3.z. and Vec3.y is provided as an argument.
564
582
  * @param y - The y value of the new Vec3 instance.
package/esm/Line3D.js CHANGED
@@ -2,13 +2,15 @@ import { Line3 } from "three";
2
2
  import { Vec3 } from "./Vec3";
3
3
  import { Line2D } from "./Line2D";
4
4
  export class Line3D extends Line3 {
5
+ index;
5
6
  #target;
6
- constructor(start, end) {
7
+ constructor(start, end, index = 0) {
7
8
  super(start, end);
9
+ this.index = index;
8
10
  this.#target = new Vec3();
9
11
  }
10
- static fromPoints(start, end) {
11
- return new Line3D(new Vec3(start.x, start.y, start.z), new Vec3(end.x, end.y, end.z));
12
+ static fromPoints(start, end, index = 0) {
13
+ return new Line3D(new Vec3(start.x, start.y, start.z), new Vec3(end.x, end.y, end.z), index);
12
14
  }
13
15
  /**
14
16
  * Creates a polygon formed by an array of lines from points provided.
@@ -24,7 +26,7 @@ export class Line3D extends Line3 {
24
26
  }
25
27
  const lines = [];
26
28
  for (let i = 0; i < polygon.length - 1; i++) {
27
- lines.push(Line3D.fromPoints(polygon[i], polygon[i + 1]));
29
+ lines.push(Line3D.fromPoints(polygon[i], polygon[i + 1], i));
28
30
  }
29
31
  return lines;
30
32
  }
@@ -403,6 +405,41 @@ export class Line3D extends Line3 {
403
405
  const resultSegmentPoint2 = new Vec3((p3.x + mub * p43.x), (p3.y + mub * p43.y), (p3.z + mub * p43.z));
404
406
  return new Line3D(resultSegmentPoint1, resultSegmentPoint2);
405
407
  }
408
+ /**
409
+ * Accepts an array of Line3D and groups them into arrays of connected lines
410
+ * @param lines Lines to be grouped
411
+ * @param tolerance Tolerance for considering lines as connected
412
+ */
413
+ static groupConnectedLines(lines, tolerance = 0) {
414
+ const visited = new Set();
415
+ // Use graph-based approach. Each line can be considered as an edge in the graph, and the endpoints of the lines can be considered as vertices.
416
+ // Then use Depth-First Search (DFS) to find connected components in the graph.
417
+ const dfs = (line, group) => {
418
+ if (visited.has(line))
419
+ return;
420
+ visited.add(line);
421
+ group.push(line);
422
+ lines.forEach((neighbor) => {
423
+ if (!visited.has(neighbor)) {
424
+ if ((line.start).isNear(neighbor.start, tolerance) ||
425
+ (line.start).isNear(neighbor.end, tolerance) ||
426
+ (line.end).isNear(neighbor.start, tolerance) ||
427
+ (line.end).isNear(neighbor.end, tolerance)) {
428
+ dfs(neighbor, group);
429
+ }
430
+ }
431
+ });
432
+ };
433
+ const connectedLines = [];
434
+ lines.forEach((line) => {
435
+ if (!visited.has(line)) {
436
+ const group = [];
437
+ dfs(line, group);
438
+ connectedLines.push(group);
439
+ }
440
+ });
441
+ return connectedLines;
442
+ }
406
443
  /**
407
444
  * Project the line to 2D space, Y value is dropped
408
445
  */
@@ -419,7 +456,7 @@ export class Line3D extends Line3 {
419
456
  * Deep clone of this line
420
457
  */
421
458
  clone() {
422
- return new Line3D(this.start.clone(), this.end.clone());
459
+ return new Line3D(this.start.clone(), this.end.clone(), this.index);
423
460
  }
424
461
  toString() {
425
462
  return `Line3D { start: ${this.start.x}, ${this.start.y}, ${this.start.z}, end: ${this.end.x}, ${this.end.y}, ${this.end.z}}`;
@@ -0,0 +1,9 @@
1
+ import { Vec3 } from "./Vec3";
2
+ export const directions = {
3
+ North: new Vec3(0, 0, -1),
4
+ South: new Vec3(0, 0, 1),
5
+ East: new Vec3(1, 0, 0),
6
+ West: new Vec3(-1, 0, 0),
7
+ Up: new Vec3(0, 1, 0),
8
+ Down: new Vec3(0, -1, 0)
9
+ };
@@ -0,0 +1,7 @@
1
+ import { Vec2 } from "./Vec2";
2
+ export const directions2d = {
3
+ Up: new Vec2(0, -1),
4
+ Down: new Vec2(0, 1),
5
+ Left: new Vec2(-1, 0),
6
+ Right: new Vec2(1, 0)
7
+ };
package/esm/index.js CHANGED
@@ -10,3 +10,5 @@ export { normalizeAngleDegrees } from "./normalizeAngleDegrees";
10
10
  export { normalizeAngleRadians } from "./normalizeAngleRadians";
11
11
  export { TwoPI } from "./MathConstants";
12
12
  export { isPointInPolygon } from "./isPointInPolygon";
13
+ export { directions } from "./directions";
14
+ export { directions2d } from "./directions2d";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@immugio/three-math-extensions",
3
- "version": "0.2.10",
3
+ "version": "0.2.12",
4
4
  "description": "Set of utilities for 2d and 3d line math built on top of three.js",
5
5
  "author": "Jan Mikeska <janmikeska@gmail.com>",
6
6
  "license": "ISC",
@@ -33,19 +33,21 @@
33
33
  "postversion": "git push && git push --tags"
34
34
  },
35
35
  "devDependencies": {
36
- "@types/jest": "^29.2.1",
36
+ "@types/jest": "^29.5.4",
37
37
  "@types/offscreencanvas": "2019.7.0",
38
- "@types/three": "0.130.1",
38
+ "@types/three": "0.152.0",
39
+ "@typescript-eslint/eslint-plugin": "^6.5.0",
39
40
  "auto-changelog": "^2.4.0",
40
- "jest": "^29.2.2",
41
+ "jest": "^29.6.4",
41
42
  "rimraf": "^3.0.2",
42
43
  "ts-jest": "^29.0.0",
43
44
  "typedoc": "^0.23.23",
44
45
  "typedoc-plugin-markdown": "^3.14.0",
45
- "typescript": "4.9.5"
46
+ "typescript": "4.9.5",
47
+ "eslint": "^8.48.0"
46
48
  },
47
49
  "peerDependencies": {
48
- "three": ">=0.130.1"
50
+ "three": "0.152.2"
49
51
  },
50
52
  "repository": {
51
53
  "type": "git",
package/src/Line2D.ts CHANGED
@@ -4,6 +4,7 @@ import { Vec2 } from "./Vec2";
4
4
  import { MathUtils } from "three";
5
5
  import { TwoPI } from "./MathConstants";
6
6
  import { Line3D } from "./Line3D";
7
+ import {directions2d} from "./directions2d";
7
8
 
8
9
  const _startP = /*@__PURE__*/ new Vec2();
9
10
  const _startEnd = /*@__PURE__*/ new Vec2();
@@ -368,6 +369,18 @@ export class Line2D {
368
369
  return result;
369
370
  }
370
371
 
372
+ /**
373
+ * Returns a new line that is the projection of this line onto @other. Uses `closestPointToPoint` to find the projection.
374
+ * @param other
375
+ * @param clampToLine
376
+ */
377
+ public projectOn(other: Line2D, clampToLine: boolean): Line2D {
378
+ const p1 = other.closestPointToPoint(this.start, clampToLine, new Vec2());
379
+ const p2 = other.closestPointToPoint(this.end, clampToLine, new Vec2());
380
+
381
+ return p1.distanceTo(this.start) < p2.distanceTo(this.start) ? new Line2D(p1, p2) : new Line2D(p2, p1);
382
+ }
383
+
371
384
  /**
372
385
  * Divides the Line3D into a number of segments of the given length.
373
386
  * Clone the line, does not modify.
@@ -660,6 +673,15 @@ export class Line2D {
660
673
  return null;
661
674
  }
662
675
 
676
+ public get isCloserToHorizontal(): boolean {
677
+ const direction = this.direction;
678
+ return direction.angleTo(directions2d.Right) < Math.PI / 4 || direction.angleTo(directions2d.Left) < Math.PI / 4;
679
+ }
680
+
681
+ public get isCloserToVertical(): boolean {
682
+ return !this.isCloserToHorizontal;
683
+ }
684
+
663
685
  /**
664
686
  * Project the line to 2D space. For start and end points Vec2.y becomes Vec3.z. and Vec3.y is provided as an argument.
665
687
  * @param y - The y value of the new Vec3 instance.
package/src/Line3D.ts CHANGED
@@ -10,13 +10,13 @@ export class Line3D extends Line3 {
10
10
 
11
11
  readonly #target: Vec3;
12
12
 
13
- constructor(start: Vec3, end: Vec3) {
13
+ constructor(start: Vec3, end: Vec3, public index: number = 0) {
14
14
  super(start, end);
15
15
  this.#target = new Vec3();
16
16
  }
17
17
 
18
- public static fromPoints(start: Point3, end: Point3): Line3D {
19
- return new Line3D(new Vec3(start.x, start.y, start.z), new Vec3(end.x, end.y, end.z));
18
+ public static fromPoints(start: Point3, end: Point3, index: number = 0): Line3D {
19
+ return new Line3D(new Vec3(start.x, start.y, start.z), new Vec3(end.x, end.y, end.z), index);
20
20
  }
21
21
 
22
22
  /**
@@ -35,7 +35,7 @@ export class Line3D extends Line3 {
35
35
 
36
36
  const lines: Line3D[] = [];
37
37
  for (let i = 0; i < polygon.length - 1; i++) {
38
- lines.push(Line3D.fromPoints(polygon[i], polygon[i + 1]));
38
+ lines.push(Line3D.fromPoints(polygon[i], polygon[i + 1], i));
39
39
  }
40
40
 
41
41
  return lines;
@@ -502,6 +502,48 @@ export class Line3D extends Line3 {
502
502
  return new Line3D(resultSegmentPoint1, resultSegmentPoint2);
503
503
  }
504
504
 
505
+ /**
506
+ * Accepts an array of Line3D and groups them into arrays of connected lines
507
+ * @param lines Lines to be grouped
508
+ * @param tolerance Tolerance for considering lines as connected
509
+ */
510
+ public static groupConnectedLines(lines: Line3D[], tolerance: number = 0): Line3D[][] {
511
+ const visited: Set<Line3D> = new Set();
512
+
513
+ // Use graph-based approach. Each line can be considered as an edge in the graph, and the endpoints of the lines can be considered as vertices.
514
+ // Then use Depth-First Search (DFS) to find connected components in the graph.
515
+ const dfs = (line: Line3D, group: Line3D[]) => {
516
+ if (visited.has(line)) return;
517
+ visited.add(line);
518
+ group.push(line);
519
+
520
+ lines.forEach((neighbor) => {
521
+ if (!visited.has(neighbor)) {
522
+ if (
523
+ (line.start).isNear(neighbor.start, tolerance) ||
524
+ (line.start).isNear(neighbor.end, tolerance) ||
525
+ (line.end).isNear(neighbor.start, tolerance) ||
526
+ (line.end).isNear(neighbor.end, tolerance)
527
+ ) {
528
+ dfs(neighbor, group);
529
+ }
530
+ }
531
+ });
532
+ };
533
+
534
+ const connectedLines: Line3D[][] = [];
535
+
536
+ lines.forEach((line) => {
537
+ if (!visited.has(line)) {
538
+ const group: Line3D[] = [];
539
+ dfs(line, group);
540
+ connectedLines.push(group);
541
+ }
542
+ });
543
+
544
+ return connectedLines;
545
+ }
546
+
505
547
  /**
506
548
  * Project the line to 2D space, Y value is dropped
507
549
  */
@@ -520,7 +562,7 @@ export class Line3D extends Line3 {
520
562
  * Deep clone of this line
521
563
  */
522
564
  public clone(): this {
523
- return new Line3D(this.start.clone(), this.end.clone()) as this;
565
+ return new Line3D(this.start.clone(), this.end.clone(), this.index) as this;
524
566
  }
525
567
 
526
568
  public toString(): string {
package/src/Vec2.ts CHANGED
@@ -1,7 +1,7 @@
1
- import { Vector2 } from "three";
2
- import { Vec3 } from "./Vec3";
3
- import { Point2 } from "./Point2";
4
- import { normalizeAngleRadians } from "./normalizeAngleRadians";
1
+ import {Vector2} from "three";
2
+ import {Vec3} from "./Vec3";
3
+ import {Point2} from "./Point2";
4
+ import {normalizeAngleRadians} from "./normalizeAngleRadians";
5
5
 
6
6
  /**
7
7
  * Vec2 represents a 2D vector. It extends `Vector2` from the `threejs` library.
@@ -0,0 +1,10 @@
1
+ import { Vec3 } from "./Vec3";
2
+
3
+ export const directions = {
4
+ North: new Vec3(0, 0, -1),
5
+ South: new Vec3(0, 0, 1),
6
+ East: new Vec3(1, 0, 0),
7
+ West: new Vec3(-1, 0, 0),
8
+ Up: new Vec3(0, 1, 0),
9
+ Down: new Vec3(0, -1, 0)
10
+ };
@@ -0,0 +1,8 @@
1
+ import { Vec2 } from "./Vec2";
2
+
3
+ export const directions2d = {
4
+ Up: new Vec2(0, -1),
5
+ Down: new Vec2(0, 1),
6
+ Left: new Vec2(-1, 0),
7
+ Right: new Vec2(1, 0)
8
+ };
package/src/index.ts CHANGED
@@ -11,4 +11,6 @@ export { normalizeAngleRadians } from "./normalizeAngleRadians";
11
11
  export { TwoPI } from "./MathConstants";
12
12
  export { Point2 } from "./Point2";
13
13
  export { Point3 } from "./Point3";
14
- export { isPointInPolygon } from "./isPointInPolygon";
14
+ export { isPointInPolygon } from "./isPointInPolygon";
15
+ export { directions } from "./directions";
16
+ export { directions2d } from "./directions2d";
package/types/Line2D.d.ts CHANGED
@@ -138,6 +138,12 @@ export declare class Line2D {
138
138
  * @param lines
139
139
  */
140
140
  static joinLines(lines: Line2D[]): Line2D[];
141
+ /**
142
+ * Returns a new line that is the projection of this line onto @other. Uses `closestPointToPoint` to find the projection.
143
+ * @param other
144
+ * @param clampToLine
145
+ */
146
+ projectOn(other: Line2D, clampToLine: boolean): Line2D;
141
147
  /**
142
148
  * Divides the Line3D into a number of segments of the given length.
143
149
  * Clone the line, does not modify.
@@ -212,6 +218,8 @@ export declare class Line2D {
212
218
  * @param distanceTolerance number
213
219
  */
214
220
  hasIntersectionWithAngle(other: Line2D, expectedAngleInRads: number, angleTolerance?: number, distanceTolerance?: number): Vec2;
221
+ get isCloserToHorizontal(): boolean;
222
+ get isCloserToVertical(): boolean;
215
223
  /**
216
224
  * Project the line to 2D space. For start and end points Vec2.y becomes Vec3.z. and Vec3.y is provided as an argument.
217
225
  * @param y - The y value of the new Vec3 instance.
package/types/Line3D.d.ts CHANGED
@@ -4,10 +4,11 @@ import { Point3 } from "./Point3";
4
4
  import { Line2D } from "./Line2D";
5
5
  export declare class Line3D extends Line3 {
6
6
  #private;
7
+ index: number;
7
8
  start: Vec3;
8
9
  end: Vec3;
9
- constructor(start: Vec3, end: Vec3);
10
- static fromPoints(start: Point3, end: Point3): Line3D;
10
+ constructor(start: Vec3, end: Vec3, index?: number);
11
+ static fromPoints(start: Point3, end: Point3, index?: number): Line3D;
11
12
  /**
12
13
  * Creates a polygon formed by an array of lines from points provided.
13
14
  * The polygon will only be closed if either
@@ -145,6 +146,12 @@ export declare class Line3D extends Line3 {
145
146
  * @param other
146
147
  */
147
148
  intersect(other: Line3D): Line3D;
149
+ /**
150
+ * Accepts an array of Line3D and groups them into arrays of connected lines
151
+ * @param lines Lines to be grouped
152
+ * @param tolerance Tolerance for considering lines as connected
153
+ */
154
+ static groupConnectedLines(lines: Line3D[], tolerance?: number): Line3D[][];
148
155
  /**
149
156
  * Project the line to 2D space, Y value is dropped
150
157
  */
@@ -0,0 +1,9 @@
1
+ import { Vec3 } from "./Vec3";
2
+ export declare const directions: {
3
+ North: Vec3;
4
+ South: Vec3;
5
+ East: Vec3;
6
+ West: Vec3;
7
+ Up: Vec3;
8
+ Down: Vec3;
9
+ };
@@ -0,0 +1,7 @@
1
+ import { Vec2 } from "./Vec2";
2
+ export declare const directions2d: {
3
+ Up: Vec2;
4
+ Down: Vec2;
5
+ Left: Vec2;
6
+ Right: Vec2;
7
+ };
package/types/index.d.ts CHANGED
@@ -12,3 +12,5 @@ export { TwoPI } from "./MathConstants";
12
12
  export { Point2 } from "./Point2";
13
13
  export { Point3 } from "./Point3";
14
14
  export { isPointInPolygon } from "./isPointInPolygon";
15
+ export { directions } from "./directions";
16
+ export { directions2d } from "./directions2d";