Improve post-processing system (#350)

trungleduc · web-flow · commit c7f4cadccc2f · 2024-04-18T15:30:04.000+02:00
* Add GLTF support

* Update external worker interface
diff --git a/packages/base/package.json b/packages/base/package.json
@@ -70,6 +70,7 @@
   "devDependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.9",
     "@types/node": "^18.15.11",
+    "@types/three": "^0.135.0",
     "rimraf": "^3.0.2",
     "typescript": "^5"
   },
diff --git a/packages/base/src/3dview/mainview.tsx b/packages/base/src/3dview/mainview.tsx
@@ -6,6 +6,7 @@ import {
   IJupyterCadClientState,
   IJupyterCadDoc,
   IJupyterCadModel,
+  IPostOperatorInput,
   IPostResult,
   ISelection
 } from '@jupytercad/schema';
@@ -19,6 +20,7 @@ import * as React from 'react';
 import * as THREE from 'three';
 import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls';
 import { TransformControls } from 'three/examples/jsm/controls/TransformControls.js';
+import { GLTFExporter } from 'three/examples/jsm/exporters/GLTFExporter.js';
 import { STLLoader } from 'three/examples/jsm/loaders/STLLoader';
 
 import { FloatingAnnotation } from '../annotation';
@@ -719,11 +721,43 @@ export class MainView extends React.Component<IProps, IStates> {
 
   private _requestRender(
     sender: MainViewModel,
-    renderData: { shapes: any; postShapes: any }
+    renderData: {
+      shapes: any;
+      postShapes?: IDict<IPostResult> | null;
+      postResult?: IDict<IPostOperatorInput>;
+    }
   ) {
-    const { shapes, postShapes } = renderData;
+    const { shapes, postShapes, postResult } = renderData;
     if (shapes !== null && shapes !== undefined) {
       this._shapeToMesh(renderData.shapes);
+      const options = {
+        binary: true,
+        onlyVisible: false
+      };
+
+      if (postResult && this._meshGroup) {
+        const exporter = new GLTFExporter();
+        Object.values(postResult).forEach(pos => {
+          const objName = pos.jcObject.parameters?.['Object'];
+          if (!objName) {
+            return;
+          }
+          const threeShape = this._meshGroup!.getObjectByName(
+            `${objName}-group`
+          );
+          if (!threeShape) {
+            return;
+          }
+          exporter.parse(
+            threeShape,
+            exported => {
+              pos.postShape = exported as any;
+            },
+            options
+          );
+        });
+        this._mainViewModel.sendRawGeomeryToWorker(postResult);
+      }
     }
     if (postShapes !== null && postShapes !== undefined) {
       Object.entries(postShapes).forEach(([objName, postResult]) => {
diff --git a/packages/base/src/3dview/mainviewmodel.ts b/packages/base/src/3dview/mainviewmodel.ts
@@ -1,13 +1,17 @@
 import { IWorkerMessage } from '@jupytercad/occ-worker';
 import {
   IAnnotation,
+  IDict,
   IDisplayShape,
   IJcadObjectDocChange,
   IJCadWorker,
   IJCadWorkerRegistry,
   IJupyterCadDoc,
   IJupyterCadModel,
   IMainMessage,
+  IPostOperatorInput,
+  IPostResult,
+  JCadWorkerSupportedFormat,
   MainAction,
   WorkerAction
 } from '@jupytercad/schema';
@@ -31,7 +35,14 @@ export class MainViewModel implements IDisposable {
   get id(): string {
     return this._id;
   }
-  get renderSignal(): ISignal<this, { shapes: any; postShapes: any }> {
+  get renderSignal(): ISignal<
+    this,
+    {
+      shapes: any;
+      postShapes?: IDict<IPostResult> | null;
+      postResult?: IDict<IPostOperatorInput>;
+    }
+  > {
     return this._renderSignal;
   }
   get jcadModel() {
@@ -76,21 +87,37 @@ export class MainViewModel implements IDisposable {
     switch (msg.action) {
       case MainAction.DISPLAY_SHAPE: {
         const { result, postResult } = msg.payload;
+
+        const rawPostResult: IDict<IPostOperatorInput> = {};
+        const threejsPostResult: IDict<IPostOperatorInput> = {};
+
+        Object.entries(postResult).forEach(([key, val]) => {
+          const format = val.jcObject?.shapeMetadata?.shapeFormat;
+          if (format === JCadWorkerSupportedFormat.BREP) {
+            rawPostResult[key] = val;
+          } else if (format === JCadWorkerSupportedFormat.GLTF) {
+            threejsPostResult[key] = val;
+          }
+        });
+
         this._saveMeta(result);
 
         if (this._firstRender) {
-          const postShapes = this._jcadModel.sharedModel.outputs;
-          this._renderSignal.emit({ shapes: result, postShapes });
+          const postShapes = this._jcadModel.sharedModel
+            .outputs as any as IDict<IPostResult>;
+          this._renderSignal.emit({
+            shapes: result,
+            postShapes,
+            postResult: threejsPostResult
+          });
           this._firstRender = false;
         } else {
-          this._renderSignal.emit({ shapes: result, postShapes: null });
-          this._postWorkerId.forEach((wk, id) => {
-            wk.postMessage({
-              id,
-              action: WorkerAction.POSTPROCESS,
-              payload: postResult
-            });
+          this._renderSignal.emit({
+            shapes: result,
+            postShapes: null,
+            postResult: threejsPostResult
           });
+          this.sendRawGeomeryToWorker(rawPostResult);
         }
 
         break;
@@ -111,10 +138,35 @@ export class MainViewModel implements IDisposable {
     }
   };
 
+  sendRawGeomeryToWorker(postResult: IDict<IPostOperatorInput>): void {
+    Object.values(postResult).forEach(res => {
+      this._postWorkerId.forEach((wk, id) => {
+        const shape = res.jcObject.shape;
+        if (!shape) {
+          return;
+        }
+
+        const { shapeFormat, workerId } = res.jcObject?.shapeMetadata ?? {};
+        const worker = this._workerRegistry.getWorker(workerId ?? '');
+        if (wk !== worker) {
+          return;
+        }
+
+        if (wk.shapeFormat === shapeFormat) {
+          wk.postMessage({
+            id,
+            action: WorkerAction.POSTPROCESS,
+            payload: res
+          });
+        }
+      });
+    });
+  }
+
   postProcessWorkerHandler = (msg: IMainMessage): void => {
     switch (msg.action) {
       case MainAction.DISPLAY_POST: {
-        const postShapes: any = {};
+        const postShapes: IDict<IPostResult> = {};
         msg.payload.forEach(element => {
           const { jcObject, postResult } = element;
           this._jcadModel.sharedModel.setOutput(jcObject.name, postResult);
@@ -168,9 +220,14 @@ export class MainViewModel implements IDisposable {
   private _postWorkerId: Map<string, IJCadWorker> = new Map();
   private _firstRender = true;
   private _id: string;
-  private _renderSignal = new Signal<this, { shapes: any; postShapes: any }>(
-    this
-  );
+  private _renderSignal = new Signal<
+    this,
+    {
+      shapes: any;
+      postShapes?: IDict<IPostResult> | null;
+      postResult?: IDict<IPostOperatorInput>;
+    }
+  >(this);
   private _isDisposed = false;
 }
 
diff --git a/packages/occ-worker/src/actions.ts b/packages/occ-worker/src/actions.ts
@@ -3,11 +3,11 @@ import {
   IJCadContent,
   IJCadObject,
   IPostOperatorInput,
+  JCadWorkerSupportedFormat,
   WorkerAction
 } from '@jupytercad/schema';
 
-import { ObjectFile, getShapesFactory } from './occapi';
-
+import { getShapesFactory, ObjectFile } from './occapi';
 import { OccParser } from './occparser';
 import { IOperatorArg, IOperatorFuncOutput } from './types';
 
@@ -21,7 +21,7 @@ function buildModel(
   const { objects } = model;
 
   objects.forEach(object => {
-    const { shape, parameters } = object;
+    const { shape, parameters, shapeMetadata } = object;
     if (!shape || !parameters) {
       return;
     }
@@ -33,11 +33,28 @@ function buildModel(
       // Creating occ shape from brep file.
       const type = parameters['Type'] ?? 'brep';
       shapeData = ObjectFile({ content: parameters['Shape'], type }, model);
-    } else if (shape.startsWith('Post::')) {
-      shapeData = shapeFactory['Post::Operator']?.(
-        parameters as IOperatorArg,
-        model
-      );
+    } else if (shape.startsWith('Post::') && shapeMetadata) {
+      const shapeFormat = (shapeMetadata.shapeFormat ??
+        JCadWorkerSupportedFormat.BREP) as JCadWorkerSupportedFormat;
+
+      switch (shapeFormat) {
+        case JCadWorkerSupportedFormat.BREP: {
+          shapeData = shapeFactory['Post::Operator']?.(
+            parameters as IOperatorArg,
+            model
+          );
+          break;
+        }
+        case JCadWorkerSupportedFormat.GLTF: {
+          shapeData = {
+            postShape: ''
+          };
+          break;
+        }
+
+        default:
+          break;
+      }
     }
     if (shapeData) {
       outputModel.push({ shapeData, jcObject: object });
@@ -57,10 +74,11 @@ function loadFile(payload: { content: IJCadContent }): IDict | null {
     if (item.jcObject.shape?.startsWith('Post::')) {
       postResult[item.jcObject.name] = {
         jcObject: item.jcObject,
-        occBrep: item.shapeData.occBrep
+        postShape: item.shapeData.postShape
       };
     }
   });
+
   return { result, postResult };
 }
 
diff --git a/packages/occ-worker/src/occapi/postOperator.ts b/packages/occ-worker/src/occapi/postOperator.ts
@@ -7,10 +7,10 @@ import { getShapesFactory } from './common';
 export function _PostOperator(
   arg: IPostOperator,
   content: IJCadContent
-): { occBrep: string } {
+): { postShape: string } {
   const baseObject = content.objects.filter(obj => obj.name === arg.Object);
   if (baseObject.length === 0) {
-    return { occBrep: '' };
+    return { postShape: '' };
   }
   const shapesFactory = getShapesFactory();
   const baseShape = baseObject[0].shape;
@@ -20,9 +20,9 @@ export function _PostOperator(
       content
     );
     if (base?.occShape) {
-      const occBrep = _writeBrep(base.occShape);
-      return { occBrep };
+      const postShape = _writeBrep(base.occShape);
+      return { postShape };
     }
   }
-  return { occBrep: '' };
+  return { postShape: '' };
 }
diff --git a/packages/occ-worker/src/types.ts b/packages/occ-worker/src/types.ts
@@ -2,22 +2,22 @@ import { OCC } from '@jupytercad/opencascade';
 import {
   IAny,
   IBox,
+  IChamfer,
   ICone,
   ICut,
   ICylinder,
   IExtrusion,
+  IFillet,
   IFuse,
   IIntersection,
   IJCadContent,
+  IPostOperator,
   IShapeMetadata,
   ISketchObject,
   ISphere,
   ITorus,
-  IPostOperator,
-  WorkerAction,
   IWorkerMessageBase,
-  IChamfer,
-  IFillet
+  WorkerAction
 } from '@jupytercad/schema';
 
 export interface IDict<T = any> {
@@ -45,7 +45,7 @@ export type IWorkerMessage = ILoadFile | IRegister;
 export interface IOperatorFuncOutput {
   occShape?: OCC.TopoDS_Shape;
   metadata?: IShapeMetadata | undefined;
-  occBrep?: string;
+  postShape?: string | ArrayBuffer;
 }
 
 type IOperatorFunc<T> = (
diff --git a/packages/schema/src/interfaces.ts b/packages/schema/src/interfaces.ts
@@ -215,7 +215,7 @@ export interface IParsedShape {
 
 export interface IPostOperatorInput {
   jcObject: IJCadObject;
-  occBrep?: string;
+  postShape?: string | ArrayBuffer;
 }
 
 /**
@@ -278,8 +278,13 @@ export type IMessageHandler =
   | ((msg: IMainMessageBase) => void)
   | ((msg: IMainMessageBase) => Promise<void>);
 
+export enum JCadWorkerSupportedFormat {
+  BREP = 'BREP',
+  GLTF = 'GLTF'
+}
 export interface IJCadWorker {
   ready: Promise<void>;
+  shapeFormat?: JCadWorkerSupportedFormat;
   postMessage(msg: IWorkerMessageBase): void;
   register(options: { messageHandler: IMessageHandler; thisArg?: any }): string;
   unregister(id: string): void;
diff --git a/packages/schema/src/schema/jcad.json b/packages/schema/src/schema/jcad.json
@@ -52,9 +52,14 @@
     "shapeMetadata": {
       "title": "IShapeMetadata",
       "type": "object",
-      "required": ["mass", "centerOfMass", "matrixOfInertia"],
       "additionalProperties": false,
       "properties": {
+        "shapeFormat": {
+          "type": "string"
+        },
+        "workerId": {
+          "type": "string"
+        },
         "mass": {
           "type": "number"
         },
diff --git a/yarn.lock b/yarn.lock
