@immugio/three-math-extensions 0.1.0 → 0.2.0

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.
Files changed (31) hide show
  1. package/CHANGELOG.md +17 -2
  2. package/cjs/BoundingBox.js +23 -0
  3. package/cjs/Polygon.js +38 -4
  4. package/cjs/Rectangle.js +77 -0
  5. package/cjs/Vec3.js +1 -1
  6. package/cjs/index.js +9 -1
  7. package/docs/classes/BoundingBox.md +117 -0
  8. package/docs/classes/Line2D.md +49 -49
  9. package/docs/classes/Line3D.md +59 -31
  10. package/docs/classes/Polygon.md +235 -0
  11. package/docs/classes/Rectangle.md +287 -0
  12. package/docs/classes/Size2.md +51 -0
  13. package/docs/classes/Vec2.md +5 -5
  14. package/docs/classes/Vec3.md +12 -12
  15. package/docs/modules.md +4 -0
  16. package/esm/BoundingBox.js +19 -0
  17. package/esm/Polygon.js +38 -4
  18. package/esm/Rectangle.js +73 -0
  19. package/esm/Vec3.js +1 -1
  20. package/esm/index.js +4 -0
  21. package/package.json +2 -2
  22. package/src/BoundingBox.ts +14 -0
  23. package/src/Polygon.ts +55 -11
  24. package/src/Rectangle.ts +93 -0
  25. package/src/Vec3.ts +1 -1
  26. package/src/index.ts +5 -1
  27. package/types/BoundingBox.d.ts +10 -0
  28. package/types/Polygon.d.ts +7 -8
  29. package/types/Rectangle.d.ts +25 -0
  30. package/types/Vec3.d.ts +1 -1
  31. package/types/index.d.ts +4 -0
package/docs/classes/Line2D.md CHANGED
@@ -79,7 +79,7 @@
79
79
 
80
80
  #### Defined in
81
81
 
82
- [src/Line2D.ts:7](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L7)
82
+ [src/Line2D.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L7)
83
83
 
84
84
  ## Properties
85
85
 
@@ -89,7 +89,7 @@
89
89
 
90
90
  #### Defined in
91
91
 
92
- [src/Line2D.ts:7](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L7)
92
+ [src/Line2D.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L7)
93
93
 
94
94
  ___
95
95
 
@@ -99,7 +99,7 @@ ___
99
99
 
100
100
  #### Defined in
101
101
 
102
- [src/Line2D.ts:7](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L7)
102
+ [src/Line2D.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L7)
103
103
 
104
104
  ___
105
105
 
@@ -109,7 +109,7 @@ ___
109
109
 
110
110
  #### Defined in
111
111
 
112
- [src/Line2D.ts:7](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L7)
112
+ [src/Line2D.ts:7](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L7)
113
113
 
114
114
  ## Accessors
115
115
 
@@ -123,7 +123,7 @@ ___
123
123
 
124
124
  #### Defined in
125
125
 
126
- [src/Line2D.ts:44](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L44)
126
+ [src/Line2D.ts:44](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L44)
127
127
 
128
128
  • `set` **center**(`value`): `void`
129
129
 
@@ -142,7 +142,7 @@ Modifies this line.
142
142
 
143
143
  #### Defined in
144
144
 
145
- [src/Line2D.ts:53](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L53)
145
+ [src/Line2D.ts:53](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L53)
146
146
 
147
147
  ___
148
148
 
@@ -158,7 +158,7 @@ Returns the direction of this line.
158
158
 
159
159
  #### Defined in
160
160
 
161
- [src/Line2D.ts:147](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L147)
161
+ [src/Line2D.ts:147](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L147)
162
162
 
163
163
  ___
164
164
 
@@ -175,7 +175,7 @@ Endpoints are not cloned.
175
175
 
176
176
  #### Defined in
177
177
 
178
- [src/Line2D.ts:140](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L140)
178
+ [src/Line2D.ts:140](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L140)
179
179
 
180
180
  ___
181
181
 
@@ -189,7 +189,7 @@ ___
189
189
 
190
190
  #### Defined in
191
191
 
192
- [src/Line2D.ts:123](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L123)
192
+ [src/Line2D.ts:123](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L123)
193
193
 
194
194
  • `set` **length**(`l`): `void`
195
195
 
@@ -208,7 +208,7 @@ Modifies this line.
208
208
 
209
209
  #### Defined in
210
210
 
211
- [src/Line2D.ts:118](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L118)
211
+ [src/Line2D.ts:118](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L118)
212
212
 
213
213
  ## Methods
214
214
 
@@ -231,7 +231,7 @@ Clone the line, does not modify.
231
231
 
232
232
  #### Defined in
233
233
 
234
- [src/Line2D.ts:370](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L370)
234
+ [src/Line2D.ts:370](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L370)
235
235
 
236
236
  ___
237
237
 
@@ -247,7 +247,7 @@ Deep clone of this line
247
247
 
248
248
  #### Defined in
249
249
 
250
- [src/Line2D.ts:650](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L650)
250
+ [src/Line2D.ts:654](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L654)
251
251
 
252
252
  ___
253
253
 
@@ -269,7 +269,7 @@ Returns the closest point on the **infinite** line to the given point.
269
269
 
270
270
  #### Defined in
271
271
 
272
- [src/Line2D.ts:401](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L401)
272
+ [src/Line2D.ts:401](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L401)
273
273
 
274
274
  ___
275
275
 
@@ -291,7 +291,7 @@ Returns the closest point on the line **section** to the given point.
291
291
 
292
292
  #### Defined in
293
293
 
294
- [src/Line2D.ts:410](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L410)
294
+ [src/Line2D.ts:410](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L410)
295
295
 
296
296
  ___
297
297
 
@@ -313,7 +313,7 @@ Returns the closest point parameter on the **infinite** line to the given point.
313
313
 
314
314
  #### Defined in
315
315
 
316
- [src/Line2D.ts:387](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L387)
316
+ [src/Line2D.ts:387](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L387)
317
317
 
318
318
  ___
319
319
 
@@ -335,7 +335,7 @@ Returns the distance between the **infinite** line and the point.
335
335
 
336
336
  #### Defined in
337
337
 
338
- [src/Line2D.ts:423](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L423)
338
+ [src/Line2D.ts:423](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L423)
339
339
 
340
340
  ___
341
341
 
@@ -355,7 +355,7 @@ ___
355
355
 
356
356
  #### Defined in
357
357
 
358
- [src/Line2D.ts:658](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L658)
358
+ [src/Line2D.ts:647](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L647)
359
359
 
360
360
  ___
361
361
 
@@ -379,7 +379,7 @@ Does not create a copy. Provided line is modified.
379
379
 
380
380
  #### Defined in
381
381
 
382
- [src/Line2D.ts:560](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L560)
382
+ [src/Line2D.ts:560](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L560)
383
383
 
384
384
  ___
385
385
 
@@ -403,7 +403,7 @@ Modifies this line.
403
403
 
404
404
  #### Defined in
405
405
 
406
- [src/Line2D.ts:581](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L581)
406
+ [src/Line2D.ts:581](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L581)
407
407
 
408
408
  ___
409
409
 
@@ -420,7 +420,7 @@ Modifies this line.
420
420
 
421
421
  #### Defined in
422
422
 
423
- [src/Line2D.ts:155](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L155)
423
+ [src/Line2D.ts:155](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L155)
424
424
 
425
425
  ___
426
426
 
@@ -442,7 +442,7 @@ Logical AND of this and the other line section.
442
442
 
443
443
  #### Defined in
444
444
 
445
- [src/Line2D.ts:283](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L283)
445
+ [src/Line2D.ts:283](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L283)
446
446
 
447
447
  ___
448
448
 
@@ -465,7 +465,7 @@ Check that the infinite lines intersect and that they are in the specified angle
465
465
 
466
466
  #### Defined in
467
467
 
468
- [src/Line2D.ts:631](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L631)
468
+ [src/Line2D.ts:631](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L631)
469
469
 
470
470
  ___
471
471
 
@@ -487,7 +487,7 @@ Returns the intersection point of two lines. The lines are assumed to be infinit
487
487
 
488
488
  #### Defined in
489
489
 
490
- [src/Line2D.ts:604](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L604)
490
+ [src/Line2D.ts:604](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L604)
491
491
 
492
492
  ___
493
493
 
@@ -509,7 +509,7 @@ Returns true if other line is collinear and overlaps or at least touching this l
509
509
 
510
510
  #### Defined in
511
511
 
512
- [src/Line2D.ts:255](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L255)
512
+ [src/Line2D.ts:255](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L255)
513
513
 
514
514
  ___
515
515
 
@@ -531,7 +531,7 @@ Returns true when the point is beside the line **segment**
531
531
 
532
532
  #### Defined in
533
533
 
534
- [src/Line2D.ts:235](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L235)
534
+ [src/Line2D.ts:235](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L235)
535
535
 
536
536
  ___
537
537
 
@@ -554,7 +554,7 @@ Returns true when the point is beside the line **segment** and within the maxDis
554
554
 
555
555
  #### Defined in
556
556
 
557
- [src/Line2D.ts:226](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L226)
557
+ [src/Line2D.ts:226](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L226)
558
558
 
559
559
  ___
560
560
 
@@ -576,7 +576,7 @@ Returns true when the point is on the **infinite** line.
576
576
 
577
577
  #### Defined in
578
578
 
579
- [src/Line2D.ts:247](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L247)
579
+ [src/Line2D.ts:247](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L247)
580
580
 
581
581
  ___
582
582
 
@@ -600,7 +600,7 @@ https://stackoverflow.com/questions/6865832/detecting-if-a-point-is-of-a-line-se
600
600
 
601
601
  #### Defined in
602
602
 
603
- [src/Line2D.ts:213](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L213)
603
+ [src/Line2D.ts:213](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L213)
604
604
 
605
605
  ___
606
606
 
@@ -623,7 +623,7 @@ Modifies this line.
623
623
 
624
624
  #### Defined in
625
625
 
626
- [src/Line2D.ts:98](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L98)
626
+ [src/Line2D.ts:98](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L98)
627
627
 
628
628
  ___
629
629
 
@@ -643,7 +643,7 @@ ___
643
643
 
644
644
  #### Defined in
645
645
 
646
- [src/Line2D.ts:87](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L87)
646
+ [src/Line2D.ts:87](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L87)
647
647
 
648
648
  ___
649
649
 
@@ -669,7 +669,7 @@ line section.
669
669
 
670
670
  #### Defined in
671
671
 
672
- [src/Line2D.ts:267](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L267)
672
+ [src/Line2D.ts:267](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L267)
673
673
 
674
674
  ___
675
675
 
@@ -689,7 +689,7 @@ ___
689
689
 
690
690
  #### Defined in
691
691
 
692
- [src/Line2D.ts:77](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L77)
692
+ [src/Line2D.ts:77](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L77)
693
693
 
694
694
  ___
695
695
 
@@ -713,7 +713,7 @@ Modifies this line.
713
713
 
714
714
  #### Defined in
715
715
 
716
- [src/Line2D.ts:169](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L169)
716
+ [src/Line2D.ts:169](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L169)
717
717
 
718
718
  ___
719
719
 
@@ -736,7 +736,7 @@ Modifies this line.
736
736
 
737
737
  #### Defined in
738
738
 
739
- [src/Line2D.ts:68](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L68)
739
+ [src/Line2D.ts:68](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L68)
740
740
 
741
741
  ___
742
742
 
@@ -758,7 +758,7 @@ Set the length of this line. Center and direction remain unchanged.
758
758
 
759
759
  #### Defined in
760
760
 
761
- [src/Line2D.ts:131](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L131)
761
+ [src/Line2D.ts:131](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L131)
762
762
 
763
763
  ___
764
764
 
@@ -781,7 +781,7 @@ Returns the original line section split into two parts, if the line **sections**
781
781
 
782
782
  #### Defined in
783
783
 
784
- [src/Line2D.ts:476](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L476)
784
+ [src/Line2D.ts:476](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L476)
785
785
 
786
786
  ___
787
787
 
@@ -805,7 +805,7 @@ Otherwise, null if the lines are parallel and do not intersect
805
805
 
806
806
  #### Defined in
807
807
 
808
- [src/Line2D.ts:495](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L495)
808
+ [src/Line2D.ts:495](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L495)
809
809
 
810
810
  ___
811
811
 
@@ -819,7 +819,7 @@ ___
819
819
 
820
820
  #### Defined in
821
821
 
822
- [src/Line2D.ts:654](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L654)
822
+ [src/Line2D.ts:658](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L658)
823
823
 
824
824
  ___
825
825
 
@@ -842,7 +842,7 @@ Modifies this line.
842
842
 
843
843
  #### Defined in
844
844
 
845
- [src/Line2D.ts:180](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L180)
845
+ [src/Line2D.ts:180](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L180)
846
846
 
847
847
  ___
848
848
 
@@ -865,7 +865,7 @@ Modifies this line.
865
865
 
866
866
  #### Defined in
867
867
 
868
- [src/Line2D.ts:193](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L193)
868
+ [src/Line2D.ts:193](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L193)
869
869
 
870
870
  ___
871
871
 
@@ -888,7 +888,7 @@ Modifies this line.
888
888
 
889
889
  #### Defined in
890
890
 
891
- [src/Line2D.ts:202](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L202)
891
+ [src/Line2D.ts:202](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L202)
892
892
 
893
893
  ___
894
894
 
@@ -911,7 +911,7 @@ Does not create a copy. Provided line is modified.
911
911
 
912
912
  #### Defined in
913
913
 
914
- [src/Line2D.ts:538](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L538)
914
+ [src/Line2D.ts:538](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L538)
915
915
 
916
916
  ___
917
917
 
@@ -940,7 +940,7 @@ Clones the line, does not modify this.
940
940
 
941
941
  #### Defined in
942
942
 
943
- [src/Line2D.ts:437](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L437)
943
+ [src/Line2D.ts:437](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L437)
944
944
 
945
945
  ___
946
946
 
@@ -964,7 +964,7 @@ ___
964
964
 
965
965
  #### Defined in
966
966
 
967
- [src/Line2D.ts:10](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L10)
967
+ [src/Line2D.ts:10](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L10)
968
968
 
969
969
  ___
970
970
 
@@ -984,7 +984,7 @@ ___
984
984
 
985
985
  #### Defined in
986
986
 
987
- [src/Line2D.ts:40](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L40)
987
+ [src/Line2D.ts:40](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L40)
988
988
 
989
989
  ___
990
990
 
@@ -1006,7 +1006,7 @@ ___
1006
1006
 
1007
1007
  #### Defined in
1008
1008
 
1009
- [src/Line2D.ts:14](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L14)
1009
+ [src/Line2D.ts:14](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L14)
1010
1010
 
1011
1011
  ___
1012
1012
 
@@ -1031,7 +1031,7 @@ The polygon will only be closed if either
1031
1031
 
1032
1032
  #### Defined in
1033
1033
 
1034
- [src/Line2D.ts:23](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L23)
1034
+ [src/Line2D.ts:23](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L23)
1035
1035
 
1036
1036
  ___
1037
1037
 
@@ -1065,7 +1065,7 @@ Clones the line, does not modify.
1065
1065
 
1066
1066
  #### Defined in
1067
1067
 
1068
- [src/Line2D.ts:317](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L317)
1068
+ [src/Line2D.ts:317](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L317)
1069
1069
 
1070
1070
  ___
1071
1071
 
@@ -1089,4 +1089,4 @@ Clone the lines, does not modify.
1089
1089
 
1090
1090
  #### Defined in
1091
1091
 
1092
- [src/Line2D.ts:334](https://github.com/Immugio/three-math-extensions/blob/70c8d5e/src/Line2D.ts#L334)
1092
+ [src/Line2D.ts:334](https://github.com/Immugio/three-math-extensions/blob/c004965/src/Line2D.ts#L334)