@immugio/three-math-extensions 0.2.21 → 0.2.22

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 (23) hide show
  1. package/CHANGELOG.md +11 -2
  2. package/README.md +183 -1
  3. package/cjs/Line2D.js +59 -8
  4. package/cjs/Line3D.js +1 -1
  5. package/docs/classes/BoundingBox.md +13 -9
  6. package/docs/classes/Line2D.md +292 -80
  7. package/docs/classes/Line3D.md +155 -84
  8. package/docs/classes/Polygon.md +23 -19
  9. package/docs/classes/Rectangle.md +23 -19
  10. package/docs/classes/Size2.md +8 -4
  11. package/docs/classes/Vec2.md +62 -12
  12. package/docs/classes/Vec3.md +65 -15
  13. package/docs/interfaces/Point2.md +3 -3
  14. package/docs/interfaces/Point3.md +4 -4
  15. package/docs/modules.md +86 -5
  16. package/esm/Line2D.js +59 -8
  17. package/esm/Line3D.js +1 -1
  18. package/package.json +1 -1
  19. package/src/Line2D.ts +69 -8
  20. package/src/Line3D.ts +1 -1
  21. package/types/Line2D.d.ts +21 -2
  22. package/types/Line3D.d.ts +1 -1
  23. package/docs/README.md +0 -90
package/types/Line3D.d.ts CHANGED
@@ -94,7 +94,7 @@ export declare class Line3D extends Line3 {
94
94
  */
95
95
  containsPoint(p: Vector3, tolerance?: number): boolean;
96
96
  /**
97
- * Distance from this line to provided point.
97
+ * Distance from this line to the provided point.
98
98
  * @param p
99
99
  * @param clampToLine
100
100
  */
package/docs/README.md DELETED
@@ -1,90 +0,0 @@
1
- @immugio/three-math-extensions / [Exports](modules.md)
2
-
3
- # Set of utilities for 2d and 3d math built on top of three.js
4
-
5
- [![Build](https://github.com/Immugio/three-math-extensions/actions/workflows/build.yml/badge.svg)](https://github.com/Immugio/three-math-extensions/actions/workflows/build.yml)
6
-
7
- [@immugio/three-math-extensions](README.md) / Exports
8
-
9
- # @immugio/three-math-extensions
10
-
11
- ## Table of contents
12
-
13
- ### Classes
14
-
15
- - [BoundingBox](docs/classes/BoundingBox.md)
16
- - [Line2D](docs/classes/Line2D.md)
17
- - [Line3D](docs/classes/Line3D.md)
18
- - [Polygon](docs/classes/Polygon.md)
19
- - [Rectangle](docs/classes/Rectangle.md)
20
- - [Size2](docs/classes/Size2.md)
21
- - [Vec2](docs/classes/Vec2.md)
22
- - [Vec3](docs/classes/Vec3.md)
23
-
24
- ### Interfaces
25
-
26
- - [Point2](docs/interfaces/Point2.md)
27
- - [Point3](docs/interfaces/Point3.md)
28
-
29
- ### Variables
30
-
31
- - [TwoPI](docs/modules.md#twopi)
32
-
33
- ### Functions
34
-
35
- - [normalizeAngleDegrees](docs/modules.md#normalizeangledegrees)
36
- - [normalizeAngleRadians](docs/modules.md#normalizeangleradians)
37
-
38
- ## Variables
39
-
40
- ### TwoPI
41
-
42
- • `Const` **TwoPI**: `number`
43
-
44
- #### Defined in
45
-
46
- [src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/151f214/src/MathConstants.ts#L1)
47
-
48
- ## Functions
49
-
50
- ### normalizeAngleDegrees
51
-
52
- ▸ **normalizeAngleDegrees**(`angle`): `number`
53
-
54
- Normalizes an angle in degrees to the range [0, 360].
55
-
56
- #### Parameters
57
-
58
- | Name | Type | Description |
59
- | :------ | :------ | :------ |
60
- | `angle` | `number` | in degrees |
61
-
62
- #### Returns
63
-
64
- `number`
65
-
66
- #### Defined in
67
-
68
- [src/normalizeAngleDegrees.ts:5](https://github.com/Immugio/three-math-extensions/blob/151f214/src/normalizeAngleDegrees.ts#L5)
69
-
70
- ___
71
-
72
- ### normalizeAngleRadians
73
-
74
- ▸ **normalizeAngleRadians**(`angle`): `number`
75
-
76
- Normalize an angle in radians to the range of 0 to 2π.
77
-
78
- #### Parameters
79
-
80
- | Name | Type | Description |
81
- | :------ | :------ | :------ |
82
- | `angle` | `number` | in radians |
83
-
84
- #### Returns
85
-
86
- `number`
87
-
88
- #### Defined in
89
-
90
- [src/normalizeAngleRadians.ts:7](https://github.com/Immugio/three-math-extensions/blob/151f214/src/normalizeAngleRadians.ts#L7)