frenet-serret-frames 3.0.0 → 3.0.1

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 (5) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +11 -7
  3. package/package.json +1 -1
  4. package/types/types.d.ts +3 -2
  5. package/types.js +5 -2
package/CHANGELOG.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ## [3.0.1](https://github.com/dmnsgn/frenet-serret-frames/compare/v3.0.0...v3.0.1) (2023-07-31)
6
+
7
+
8
+
5
9
  # [3.0.0](https://github.com/dmnsgn/frenet-serret-frames/compare/v2.1.0...v3.0.0) (2023-07-31)
6
10
 
7
11
 
package/README.md CHANGED
@@ -28,12 +28,9 @@ npm install frenet-serret-frames
28
28
 
29
29
  ```js
30
30
  import frenetSerretFrames from "frenet-serret-frames";
31
- import pathTangents from "path-tangents";
32
31
 
33
- const isClosed = true;
34
- const tangents = pathTangents(path, isClosed);
35
- const frames = frenetSerretFrames(path, tangents, {
36
- closed: isClosed,
32
+ const frames = frenetSerretFrames({ positions }, {
33
+ closed: true,
37
34
  initialNormal: [0, 1, 0],
38
35
  });
39
36
  ```
@@ -53,6 +50,8 @@ const frames = frenetSerretFrames(path, tangents, {
53
50
  ## Typedefs
54
51
 
55
52
  <dl>
53
+ <dt><a href="#vec2">vec2</a> : <code>Array.&lt;number&gt;</code></dt>
54
+ <dd></dd>
56
55
  <dt><a href="#vec3">vec3</a> : <code>Array.&lt;number&gt;</code></dt>
57
56
  <dd></dd>
58
57
  <dt><a href="#SimplicialComplex">SimplicialComplex</a> : <code>object</code></dt>
@@ -80,6 +79,11 @@ Compute Frenet-Serret frames for a geometry of 3D positions and optionally provi
80
79
  | geometry | [<code>SimplicialComplex</code>](#SimplicialComplex) | |
81
80
  | [options] | [<code>Options</code>](#Options) | <code>{}</code> |
82
81
 
82
+ <a name="vec2"></a>
83
+
84
+ ## vec2 : <code>Array.&lt;number&gt;</code>
85
+
86
+ **Kind**: global typedef
83
87
  <a name="vec3"></a>
84
88
 
85
89
  ## vec3 : <code>Array.&lt;number&gt;</code>
@@ -99,7 +103,7 @@ Geometry definition.
99
103
  | positions | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
100
104
  | [tangents] | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
101
105
  | [normals] | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
102
- | [uvs] | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
106
+ | [uvs] | <code>Float32Array</code> \| [<code>Array.&lt;vec2&gt;</code>](#vec2) |
103
107
  | [cells] | <code>Uint8Array</code> \| <code>Uint16Array</code> \| <code>Uint32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
104
108
 
105
109
  <a name="SimplicialComplexWithTNB"></a>
@@ -117,7 +121,7 @@ Geometry definition augmented with tangent, normals and binormals.
117
121
  | tangents | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
118
122
  | normals | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
119
123
  | binormals | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
120
- | [uvs] | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
124
+ | [uvs] | <code>Float32Array</code> \| [<code>Array.&lt;vec2&gt;</code>](#vec2) |
121
125
  | [cells] | <code>Uint8Array</code> \| <code>Uint16Array</code> \| <code>Uint32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
122
126
 
123
127
  <a name="Options"></a>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "frenet-serret-frames",
3
- "version": "3.0.0",
3
+ "version": "3.0.1",
4
4
  "description": "Compute Frenet-Serret frames for a geometry of 3D positions and optionally provided tangents.",
5
5
  "keywords": [
6
6
  "path",
package/types/types.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ export type vec2 = number[];
1
2
  export type vec3 = number[];
2
3
  /**
3
4
  * Geometry definition.
@@ -6,7 +7,7 @@ export type SimplicialComplex = {
6
7
  positions: Float32Array | vec3[];
7
8
  tangents?: Float32Array | vec3[];
8
9
  normals?: Float32Array | vec3[];
9
- uvs?: Float32Array | vec3[];
10
+ uvs?: Float32Array | vec2[];
10
11
  cells?: (Uint8Array | Uint16Array | Uint32Array | vec3[]);
11
12
  };
12
13
  /**
@@ -17,7 +18,7 @@ export type SimplicialComplexWithTNB = {
17
18
  tangents: Float32Array | vec3[];
18
19
  normals: Float32Array | vec3[];
19
20
  binormals: Float32Array | vec3[];
20
- uvs?: Float32Array | vec3[];
21
+ uvs?: Float32Array | vec2[];
21
22
  cells?: (Uint8Array | Uint16Array | Uint32Array | vec3[]);
22
23
  };
23
24
  /**
package/types.js CHANGED
@@ -1,3 +1,6 @@
1
+ /**
2
+ * @typedef {number[]} vec2
3
+ */
1
4
  /**
2
5
  * @typedef {number[]} vec3
3
6
  */
@@ -7,7 +10,7 @@
7
10
  * @property {Float32Array | vec3[]} positions
8
11
  * @property {Float32Array | vec3[]} [tangents]
9
12
  * @property {Float32Array | vec3[]} [normals]
10
- * @property {Float32Array | vec3[]} [uvs]
13
+ * @property {Float32Array | vec2[]} [uvs]
11
14
  * @property {(Uint8Array | Uint16Array | Uint32Array | vec3[])} [cells]
12
15
  */
13
16
 
@@ -17,7 +20,7 @@
17
20
  * @property {Float32Array | vec3[]} tangents
18
21
  * @property {Float32Array | vec3[]} normals
19
22
  * @property {Float32Array | vec3[]} binormals
20
- * @property {Float32Array | vec3[]} [uvs]
23
+ * @property {Float32Array | vec2[]} [uvs]
21
24
  * @property {(Uint8Array | Uint16Array | Uint32Array | vec3[])} [cells]
22
25
  */
23
26