frenet-serret-frames 3.0.0 → 3.0.2

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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.
 
+## [3.0.2](https://github.com/dmnsgn/frenet-serret-frames/compare/v3.0.1...v3.0.2) (2023-07-31)
+
+
+
+## [3.0.1](https://github.com/dmnsgn/frenet-serret-frames/compare/v3.0.0...v3.0.1) (2023-07-31)
+
+
+
 # [3.0.0](https://github.com/dmnsgn/frenet-serret-frames/compare/v2.1.0...v3.0.0) (2023-07-31)
 
 

package/README.md

@@ -28,14 +28,20 @@ npm install frenet-serret-frames
 
 ```js
 import frenetSerretFrames from "frenet-serret-frames";
-import pathTangents from "path-tangents";
 
-const isClosed = true;
-const tangents = pathTangents(path, isClosed);
-const frames = frenetSerretFrames(path, tangents, {
-  closed: isClosed,
+const geometry = { positions, cells };
+frenetSerretFrames(geometry, {
+  closed: true,
   initialNormal: [0, 1, 0],
 });
+console.log(geometry);
+// {
+//   positions: Float32Array [x, y, z, x, y, z,  ...],
+//   tangents: Float32Array [x, y, z, x, y, z, ...]
+//   normals: Float32Array [x, y, z, x, y, z, ...]
+//   binormals: Float32Array [x, y, z, x, y, z, ...]
+//   cells: Uint8/16/32/Array [a, b, c, a, b, c, ...],
+// }
 ```
 
 ## API
@@ -53,6 +59,8 @@ const frames = frenetSerretFrames(path, tangents, {
 ## Typedefs
 
 <dl>
+<dt><a href="#vec2">vec2</a> : <code>Array.&lt;number&gt;</code></dt>
+<dd></dd>
 <dt><a href="#vec3">vec3</a> : <code>Array.&lt;number&gt;</code></dt>
 <dd></dd>
 <dt><a href="#SimplicialComplex">SimplicialComplex</a> : <code>object</code></dt>
@@ -80,6 +88,11 @@ Compute Frenet-Serret frames for a geometry of 3D positions and optionally provi
 | geometry  | [<code>SimplicialComplex</code>](#SimplicialComplex) |                 |
 | [options] | [<code>Options</code>](#Options)                     | <code>{}</code> |
 
+<a name="vec2"></a>
+
+## vec2 : <code>Array.&lt;number&gt;</code>
+
+**Kind**: global typedef
 <a name="vec3"></a>
 
 ## vec3 : <code>Array.&lt;number&gt;</code>
@@ -99,7 +112,7 @@ Geometry definition.
 | positions  | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3)                                                       |
 | [tangents] | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3)                                                       |
 | [normals]  | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3)                                                       |
-| [uvs]      | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3)                                                       |
+| [uvs]      | <code>Float32Array</code> \| [<code>Array.&lt;vec2&gt;</code>](#vec2)                                                       |
 | [cells]    | <code>Uint8Array</code> \| <code>Uint16Array</code> \| <code>Uint32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
 
 <a name="SimplicialComplexWithTNB"></a>
@@ -117,7 +130,7 @@ Geometry definition augmented with tangent, normals and binormals.
 | tangents  | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3)                                                       |
 | normals   | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3)                                                       |
 | binormals | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3)                                                       |
-| [uvs]     | <code>Float32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3)                                                       |
+| [uvs]     | <code>Float32Array</code> \| [<code>Array.&lt;vec2&gt;</code>](#vec2)                                                       |
 | [cells]   | <code>Uint8Array</code> \| <code>Uint16Array</code> \| <code>Uint32Array</code> \| [<code>Array.&lt;vec3&gt;</code>](#vec3) |
 
 <a name="Options"></a>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "frenet-serret-frames",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Compute Frenet-Serret frames for a geometry of 3D positions and optionally provided tangents.",
   "keywords": [
     "path",

package/types/types.d.ts

@@ -1,3 +1,4 @@
+export type vec2 = number[];
 export type vec3 = number[];
 /**
  * Geometry definition.
@@ -6,7 +7,7 @@ export type SimplicialComplex = {
     positions: Float32Array | vec3[];
     tangents?: Float32Array | vec3[];
     normals?: Float32Array | vec3[];
-    uvs?: Float32Array | vec3[];
+    uvs?: Float32Array | vec2[];
     cells?: (Uint8Array | Uint16Array | Uint32Array | vec3[]);
 };
 /**
@@ -17,7 +18,7 @@ export type SimplicialComplexWithTNB = {
     tangents: Float32Array | vec3[];
     normals: Float32Array | vec3[];
     binormals: Float32Array | vec3[];
-    uvs?: Float32Array | vec3[];
+    uvs?: Float32Array | vec2[];
     cells?: (Uint8Array | Uint16Array | Uint32Array | vec3[]);
 };
 /**

package/types.js

@@ -1,3 +1,6 @@
+/**
+ * @typedef {number[]} vec2
+ */
 /**
  * @typedef {number[]} vec3
  */
@@ -7,7 +10,7 @@
  * @property {Float32Array | vec3[]} positions
  * @property {Float32Array | vec3[]} [tangents]
  * @property {Float32Array | vec3[]} [normals]
- * @property {Float32Array | vec3[]} [uvs]
+ * @property {Float32Array | vec2[]} [uvs]
  * @property {(Uint8Array | Uint16Array | Uint32Array | vec3[])} [cells]
  */
 
@@ -17,7 +20,7 @@
  * @property {Float32Array | vec3[]} tangents
  * @property {Float32Array | vec3[]} normals
  * @property {Float32Array | vec3[]} binormals
- * @property {Float32Array | vec3[]} [uvs]
+ * @property {Float32Array | vec2[]} [uvs]
  * @property {(Uint8Array | Uint16Array | Uint32Array | vec3[])} [cells]
  */