nodi-modular 0.0.0 → 0.0.2

package/README.md

@@ -18,5 +18,63 @@ or yarn
 yarn add nodi-modular
 ```
 
+## Example
+
+We provide examples of how to use the Modular module in the `examples` directory with following environments:
+
+- [deno](https://github.com/Nodi3d/modular/tree/main/examples/deno)
+- [react](https://github.com/Nodi3d/modular/tree/main/examples/react)
+
 ## Usage
 
+```javascript
+
+import init, { Modular } from "nodi-modular";
+
+// Initialize the WebAssembly module
+await init();
+
+// Create a new instance of the Modular
+const modular = Modular.new();
+
+// Load a node graph in JSON format as a string
+modular.loadGraph(JSON.stringify({
+  nodes: { ... },
+}));
+
+// Evaluate the node graph to get the result
+const result = modular.evaluate();
+
+// Geometry identifiers are the keys of the geometries in the result
+const { geometryIdentifiers } = result;
+
+geometryIdentifiers.forEach((identifier) => {
+  // Get the geometry variant by identifier
+  // variants are curve, surface, mesh, and etc.
+  const geometry = modular.findGeometryById(identifier);
+
+  // Get the geometry interop by identifier
+  // geometry interop has the data that can be rendered as a polygonalized data (polyline or triangle mesh)
+  const interop = modular.findGeometryInteropById(identifier);
+});
+
+// Get the nodes of the node graph
+const nodes = modular.getNodes();
+
+// Find the node by the variant and label
+const numberOfGrid = nodes.find((n) => n.variant === "Number" && n.label === 'number of grid');
+
+// Each nodes have the properties that can be changed
+// What properties can be changed depends on the node variant, so you need to check the node variant's properties (numberGrid["properties"])
+modular.changeNodeProperty(numberOfGrid.id, {
+  name: "value",
+  value: {
+    type: "Number",
+    content: 30,
+  }
+});
+
+// re-evaluate the node graph to get the result after the property change
+const resultAfterPropertyChange = await modular.evaluate();
+
+```

package/index.d.ts

@@ -40,7 +40,7 @@ export interface EvaluationInterop {
     geometryIdentifiers: GeometryIdentifier[];
 }
 
-export type GeometryInteropHandleProxy = { type: "Mesh"; content: MeshInteropHandle } | { type: "Curve"; content: CurveInteropHandle } | { type: "Group"; content: GroupInteropHandle };
+export type GeometryInteropHandleProxy = { variant: "Mesh"; data: MeshInteropHandle } | { variant: "Curve"; data: CurveInteropHandle } | { variant: "Group"; data: GroupInteropHandle };
 
 export interface GeometryIdentifier {
     nodeId?: NodeId;
@@ -127,6 +127,8 @@ export type Point2<T = number> = Point<T, 2>;
 export type Vector2<T = number> = SVector<T, 2>;
 export type Point3<T = number> = Point<T, 3>;
 export type Vector3<T = number> = SVector<T, 3>;
+export type Point4<T = number> = Point<T, 4>;
+export type Vector4<T = number> = SVector<T, 4>;
 export type Transform3<T = number> = FixedLengthArray<T, 16>;
 
 
@@ -237,7 +239,7 @@ export interface Graph<T, U> {
 
 
 export type NurbsCurve3D<T = number> = {
-    control_points: Point3<T>[];
+    control_points: Point4<T>[];
     knots: T[];
     degree: T;
 };
@@ -285,7 +287,7 @@ export type BoundingBox3D = {
     max: Vector3;
 };
 
-export type GeometryInterop = { type: "Mesh"; content: MeshInterop } | { type: "Curve"; content: CurveInterop } | { type: "Point"; content: PointCloudInterop } | { type: "Plane"; content: Plane } | { type: "Group"; content: GeometryInterop[] };
+export type GeometryInterop = { variant: "Mesh"; data: MeshInterop } | { variant: "Curve"; data: CurveInterop } | { variant: "Point"; data: PointCloudInterop } | { variant: "Plane"; data: Plane } | { variant: "Group"; data: GeometryInterop[] };
 
 export interface CurveInterop {
     vertices: [number, number, number][];
@@ -343,7 +345,7 @@ export type PolylineCurve3D = {
 
 
 export type NurbsSurface3D<T = number> = {
-    control_points: Point3<T>[][];
+    control_points: Point4<T>[][];
     u_knots: T[];
     v_knots: T[];
     u_degree: T;

package/index.js

@@ -691,7 +691,7 @@ function __wbg_get_imports() {
         const ret = wasm.memory;
         return ret;
     };
-    imports.wbg.__wbindgen_closure_wrapper2519 = function(arg0, arg1, arg2) {
+    imports.wbg.__wbindgen_closure_wrapper2518 = function(arg0, arg1, arg2) {
         const ret = makeMutClosure(arg0, arg1, 538, __wbg_adapter_52);
         return ret;
     };

package/package.json

@@ -5,7 +5,7 @@
     "Masatatsu Nakamura <masatatsu.nakamura@gmail.com"
   ],
   "description": "Modular is a module project designed to import node graphs created in Nodi in JSON format, enabling the extraction of geometric data generated based on the node graph structure.",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "license": "MIT",
   "repository": {
     "type": "git",