This pull request will implement the bindings to OCCT using Emscripten's Embind instead of the current WebIDL approach.

The advantages:

• All overloaded functions and constructors can be exposed. You don't have to decide which overloads you want to use and / or recompile the library.
• All operators can be exposed.
• The binding code is a bit cleaner and less verbose than with the WebIDL approach (at least for non-overloaded functions).
• It seems like Emscripten offers better error messages now (but that could also be due to an Emscripten update I made).

Code conventions / How-To:

• I wrote down a few ideas on how I would organize and name things (like overloaded functions, overloaded constructors, operators) in this document.
• Look inside the embind folder. Start with main.cpp and then look at the header files in that folder.

Current limitations:

• Only a few classes have been exposed so far. However, I wanted to have this pull-request here, so that there is a place to discuss (if there is any need for that...).
• I could not find any solution to generate Typescript types using the Embind workflow. This is a huge drawback at the moment. Currently, I see following options on how to resolve that.
  1. Write the typescript definitions by hand (ew...)
  2. Use something like cppast to analyze the OCCT source files and auto-generate typescript bindings from those files. If there is the need for manual adjustments after this step, we might be able to use patch-files?!
  3. Wait until someone else creates a method to generate types from Embind definitions

Other improvements:

• Updated Emscripten
• Updated OCCT
• Updated Python
• Actions push to the respective branch, now

Next steps:

1. Continue to expose all APIs required for running the bottle example and make that work with the new system
2. Expose everything that is currently implemented using WebIDL (also from @zalo's branch)
3. Merge

Any comments would be welcome, particularly from @zalo, @guidovanhilst, @ancorasir, @Johnly1986 (because you guys have actually already used this library :slightly_smiling_face:)

I can only get one shape when use STEPControl_Reader to load a stp as in the opencascade-excample and CascadeStudio. I found a way to implement it in C++, but I can't do it in js the code:

const fileText = await loadFileAsync(inputFile)
  const fileName = inputFile.name
  // Writes the uploaded file to Emscripten's Virtual Filesystem
  openCascade.FS.createDataFile('/', fileName, fileText, true, true)

  const aDoc = new openCascade.Handle_TDocStd_Document_1()
  console.log(aDoc)

  // XCAFApp is unsupported in API.md
  // const anApp = new openCascade.Handle_XCAFApp_Application_1().get()
  // console.log(anApp)

  const reader = new openCascade.STEPCAFControl_Reader_1()
  reader.SetColorMode(true)
  reader.SetNameMode(true)

  reader.ReadFile(fileName)

  console.log(reader)
  console.log(reader.NbRootsForTransfer())

  reader.Transfer_1(aDoc)

  const label = aDoc.get().Main()

  console.log(label)

the error in reader.Transfer_1(aDoc)

Is it the wrong way I use it, or is it not supported here ？

Hi @donalffons, I hope you're doing good :) I was trying to use GeomAPI_Interpolate, but it seems like it is missing during the runtime, it is listed in Supported APIs.md file of 1.1.4 node_modules. Is there something special about this API? Would it appear if I would try out v2 beta?

I have many STP files, but none of them can be loaded except box. But I can load all of them in CascadeStudio.

I find the api is different, how can I use it ?

webidl2ts can be used to automatically generate typescript definitions from the .idl file here (ensure that the "-emscripten" mode is active).

Typescript definitions are included in the package by adding "types": "dist/opencascade.d.ts", to the package.json.

This enables Intellisense completions in VS Code (and related editors) in both Javascript AND Typescript.

Here is an example generated typescript definitions file: https://gist.github.com/zalo/0277def37489ef8c3ce47fc551aa243b

HI. When running donalffons/opencascade.js using Docker Desktop, the following error occurs:

File "/opencascade.js/src/buildFromYaml.py", line 16, in <module>
buildConfig = yaml.safe_load(open(sys.argv[1], "r"))
IndexError: list index out of range

How can this be fixed?

I was trying to create a custom build - the build worked, but there is an issue with the build result. I have the following message in the console:

"Cannot call gp_Vec.XYZ due to unbound types: 6gp_XYZ"

From what I understand you are adding already adding "raw pointers" in order to avoid this kind of error. What am I missing?

My custom build setup is the following:

cadeau_single.js:
  bindings:
    - symbol: Message_ProgressRange
    - symbol: TColgp_Array1OfDir

    - symbol: gp_XYZ
    - symbol: gp_Vec
    - symbol: gp_Pnt
    - symbol: gp_Dir
    - symbol: gp_Ax2
    - symbol: gp_Ax3
    - symbol: gp_GTrsf

    - symbol: TopoDS
    - symbol: TopAbs_ShapeEnum
    - symbol: TopTools_ListOfShape
    - symbol: TopAbs_Orientation
    - symbol: TopLoc_Location
    - symbol: TopExp_Explorer

    - symbol: Poly_Connect
    - symbol: StdPrs_ToolTriangulatedShape

    - symbol: BRep_Tool
    - symbol: BRepTools
    - symbol: BRepGProp
    - symbol: BRepGProp_Face
    - symbol: GProp_GProps
    - symbol: BRepMesh_IncrementalMesh

    - symbol: BRepAdaptor_Curve
    - symbol: BRepAdaptor_CompCurve
    - symbol: GeomAbs_CurveType

    - symbol: StlAPI_Writer

    - symbol: BRepAlgoAPI_Cut
    - symbol: BRepAlgoAPI_Fuse

    - symbol: BRepBuilderAPI_Transform
    - symbol: BRepCheck_Analyzer
    - symbol: BRepPrimAPI_MakePrism
    - symbol: BRepOffsetAPI_MakeThickSolid
    - symbol: BRepOffsetAPI_MakeOffset
    - symbol: BRepOffset_Mode
    - symbol: BRepFilletAPI_MakeChamfer
    - symbol: ChFi3d_FilletShape
    - symbol: GeomAbs_JoinType
    - symbol: cadeau
  additionalCppCode: |
    #include <emscripten/val.h>
    class cadeau: public BRepTools {
    public:
      static emscripten::val UVBounds(const TopoDS_Face &f) {
        Standard_Real uMin;
        Standard_Real uMax;
        Standard_Real vMin;
        Standard_Real vMax;
        BRepTools::UVBounds(f, uMin, uMax, vMin, vMax);
        emscripten::val ret(emscripten::val::object());
        ret.set("uMin", emscripten::val(uMin));
        ret.set("uMax", emscripten::val(uMax));
        ret.set("vMin", emscripten::val(vMin));
        ret.set("vMax", emscripten::val(vMax));
        return ret;
      }

      static emscripten::val projectPointOnSurface( 
        const gp_Pnt & P,
        const opencascade::handle<Geom_Surface> & Surface
      ) {

        GeomAPI_ProjectPointOnSurf projectedPoint (P, Surface);

        Standard_Real u;
        Standard_Real v;

        projectedPoint.LowerDistanceParameters(u, v);

        emscripten::val ret(emscripten::val::object());
        ret.set("u", emscripten::val(u));
        ret.set("v", emscripten::val(v));
        return ret;
      }
    };
  emccFlags:
    - -sEXPORT_ES6=1
    - -sUSE_ES6_IMPORT_META=0
    - -sEXPORTED_RUNTIME_METHODS=["FS"]
    - -O3

P.S. If you want to have a look at what I am building, you can find a preview here

This is working until it gets to makeFace.Add(wire).

I can't figure out if I'm doing this wrong, or if there is a problem in the bindings.

makeFace.Add's binding entry is

.function("Add", static_cast<void (BRepBuilderAPI_MakeFace::*) (const TopoDS_Wire &) >(&BRepBuilderAPI_MakeFace::Add), allow_raw_pointers())

So it's weird that it's complaining that it wants a conversion to TopoDS_Wire.

Any idea?

This is using the embind branch

test('Offset', async t => {
  const oc = await getOc();
  const path = [[0, 0, 0], [1, 0, 0], [1, 1, 0]].map(([x, y, z]) => new oc.gp_Pnt_3(x, y, z));
  const makePolygon = new oc.BRepBuilderAPI_MakePolygon_1();
  for (let nth = 0; nth < path.length; nth++) {
    makePolygon.Add_1(path[nth]);
  }
  const wire = makePolygon.Wire();
  const makeFace = new oc.BRepBuilderAPI_MakeFace_1();
  makeFace.Add(wire);
/*
  @Object {
    message: 'Cannot convert argument of type TopoDS_Wire const* to parameter type TopoDS_Wire',
    name: 'BindingError',
    stack: `BindingError: Cannot convert argument of type TopoDS_Wire const* to parameter type TopoDS_Wire␊
        at Object.eval (webpack-internal:///../../../opencascade.js/dist/opencascade.wasm.js:12:79850)␊
        at new eval (webpack-internal:///../../../opencascade.js/dist/opencascade.wasm.js:12:79667)␊
        at throwBindingError (webpack-internal:///../../../opencascade.js/dist/opencascade.wasm.js:12:80291)␊
        at RegisteredPointer.genericPointerToWireType [as toWireType] (webpack-internal:///../../../opencascade.js/dist/opencascade.wasm.js:12:88943)␊
        at Object.eval [as Add] (webpack-internal:///../../../opencascade.js/dist/opencascade.wasm.js:12:100147)␊

*/
});

I was trying to retries the UV bounds of a face using this API. From what I understand in C++ you need to pass a reference to a real, and the function update the value pointed.

Is there a way to do this with opencascade.js? I have tried something like this:

  let u0 = 0;
  let u1 = 0;
  let v0 = 0;
  let v1 = 0;
  new oc.BRepTools.UVBounds_1(face, u0, u1, v0, v1);
  console.log(u0, u1, v0, v1);

but it fails miserably with a RuntimeError: function signature mismatch.

Am I missing a way to retrieve the values?

I'm currently in the process of exporting to STEP but I have a segmentation fault error with STEPCAFControl_Writer. Below you can find detailed steps for what I'm doing so far. I'm using the latest docker image to compile, below more details of what I'm using

• Using Open Cascade version 7.6.1 │ Commit d2abb6d844231cb8f29be6894440874a4700e4a5
• https://hub.docker.com/layers/opencascade.js/donalffons/opencascade.js/latest/images/sha256-f92022555539f04251de09fcf6c91f29d346c439eeab5b1a6212e7279a609a20?context=explore

Made a simple cube in Blender and exported as Gltf (Below an image of the settings) https://siasky.net/OADjO_xqTABc1CTM_z_W59_QQEft7yrWaBXOuekTcAaTUA

// Setup XCAF document
const app = new openCascade.TDocStd_Application();
const doc = new openCascade.Handle_TDocStd_Document_1();
const format = new openCascade.TCollection_ExtendedString_2("MDTV-XCAF", true);
app.NewDocument_2(format, doc);

// Create data file
var fileString = this.file // imported gltf file
openCascade.FS.createDataFile("/", "file.gltf", fileString, true, true);

// Read Gltf file
var readerGltf = new openCascade.RWGltf_CafReader()
readerGltf.SetSkipEmptyNodes(false)
readerGltf.SetMeshNameAsFallback(true)
readerGltf.Metadata()
readerGltf.SetDocument(doc)

// Translation to OCCT model
const str = new openCascade.TCollection_ExtendedString_2("/file.gltf", true);
const fileStr = new openCascade.TCollection_AsciiString_13(str, 0);
const progress = new openCascade.Message_ProgressRange_1()

readerGltf.Perform(fileStr, progress)

So far so good. I can get all the shapes with GetFreeShapes and loop through them to get naming and assembly structure. So I know the document has the shapes.

The problem I have is with STEPCAFControl_Writer.Transfer_1 and STEPCAFControl_Writer.Perform_2. I tested both and first I got a null error. I added -sASSERTION=1, SAFE_HEAP=1 and -sNO_DISABLE_EXCEPTION_CATCHING to the compiler settings and then I got the segmentation fault error.

I tested Transfer_1 with STEPControl_AsIs and Perform_2. These 2 give the same "segmentation fault" error. With Transfer_1 and STEPControl_ManifoldSolidBrep it exports the STEP file with the right assembly structure but the STEP is empty because I pass a string to multi and therefore uses external STEP files that are not exported with the root step file. I also have no idea how I can access them to check if they where exported correctly.

This is from the docs

Transfers a document (or single label) to a STEP model The mode of translation of shape is AsIs If multi is not null pointer, it switches to multifile mode (with external refs), and string pointed by gives prefix for names of extern files (can be empty string) Returns True if translation is OK.

Below the code to export to STEP

// Export to STEP
var fileLocation = "/model.step"
var writerCAF = new openCascade.STEPCAFControl_Writer_1()
writerCAF.SetColorMode(true);
writerCAF.SetNameMode(true);

openCascade.Interface_Static.SetIVal("write.precision.mode", 1);
openCascade.Interface_Static.SetIVal("write.precision.val", 0.1);
openCascade.Interface_Static.SetIVal("write.step.assembly", 1);
openCascade.Interface_Static.SetIVal("write.step.unit", this.units[unit].index);
openCascade.Interface_Static.SetIVal("write.step.schema", 4);
openCascade.Interface_Static.SetIVal("write.step.vertex.mode", 0);
openCascade.Interface_Static.SetIVal("write.surfacecurve.mode", 1);
openCascade.Interface_Static.SetIVal("write.stepcaf.subshapes.name", 1);

var progressOutput = new openCascade.Message_ProgressRange_1()

//var written = writerCAF.Transfer_1(doc, openCascade.STEPControl_StepModelType.STEPControl_AsIs, "", progressOutput);
//var written = writerCAF.Transfer_1(doc, openCascade.STEPControl_StepModelType.STEPControl_ManifoldSolidBrep, "", progressOutput);
var written = writerCAF.Perform_2(doc, fileLocation, progressOutput)

I also tested by constructing a simple shape with occt. Everything above is the same but I removed the imported gltf file and added a simple shape to the doc. This was successful so I think it has something to do with the imported gltf to the occt model conversion?

// Added OCCT model to test export
var sphere_radius = 1.0
var sphere_angle = Math.atan(0.5);
var org = new openCascade.gp_Pnt_3(0,0,0)
var direction = new openCascade.gp_Dir_4(0,0,1)
var sphere_origin = new openCascade.gp_Ax2_3(org, direction);
var sphere_shape = new openCascade.BRepPrimAPI_MakeSphere_11(sphere_origin, sphere_radius, -sphere_angle, sphere_angle).Shape();
var aLabel = shapeTool.get().NewShape()
shapeTool.get().SetShape(aLabel, sphere_shape)

This PR sets up a Github Action that automatically builds the opencascade.js library upon each push, and pushes the resulting build products in dist back to master. It takes about 2 hours and 45 minutes to build the first time, and then about 25 minutes each subsequent time (since it is able to lean on the cache).

The PR also exposes some new functionality relating to Trasnsforms in the IDL, which enable moving, scaling, and rotating objects (common OpenSCAD operations). There are also improvements for Intersection Booleans, MakePrism, a few 2D edge definition commands, and more (though I wasn't able to get PolygonOnTriangulation to return anything, so the outlines are mismatched from the mesh unfortunately :( ).

On the line where the workflow logs into the Github Package Registry, you'll probably want to change my username to yours.

Please ignore/squash the commit history in the merge; it turns out that once you have a working CI system you tend to use it to test changes in broad daylight 🙃

These changes are live in the editor at https://zalo.github.io/CascadeStudio/

Bumps json5 to 2.2.3 and updates ancestor dependencies json5, webpack and nuxt. These dependencies need to be updated together.

Updates json5 from 2.2.1 to 2.2.3

Updates webpack from 4.46.0 to 5.75.0

Updates nuxt from 2.15.8 to 3.0.0

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

I can't use the iterator from NCollection_List.begin(), because of UnboundTypeError

I made this somewhat hacky workaround:

function MoveListToJs(list: TopTools_ListOfShape){
    let res = []
    while(list.Size() > 0){
        res.push(list.First_1())
        list.RemoveFirst()
    }
    list.delete()
    return res
}

Is there a better solution?

I can't build it using docker

docker run \
            -v $(pwd):/src \
            -u $(id -u):$(id -g) \
            donalffons/opencascade.js \
            /src/builds/opencascade.full.yml

Logs:

2023-01-01 16:21:20   /emsdk/upstream/emscripten/system/lib/libcxx/include/__support/musl/xlocale.h:42:34: error: static declaration of 'wcstoull_l' follows non-static declaration
2023-01-01 16:21:20   /emsdk/upstream/emscripten/system/lib/libcxx/include/__support/musl/xlocale.h:48:27: error: static declaration of 'wcstold_l' follows non-static declaration
2023-01-01 16:21:20   /emsdk/upstream/emscripten/system/lib/libcxx/include/locale:752:26: error: call to 'strtoll_l' is ambiguous
2023-01-01 16:21:20   /emsdk/upstream/emscripten/system/lib/libcxx/include/locale:792:35: error: call to 'strtoull_l' is ambiguous
2023-01-01 16:21:34 Diagnostic Messages:
2023-01-01 16:21:34   /emsdk/upstream/emscripten/system/lib/libcxx/include/__support/musl/xlocale.h:27:25: error: static declaration of 'strtoll_l' follows non-static declaration
2023-01-01 16:21:34   /emsdk/upstream/emscripten/system/lib/libcxx/include/__support/musl/xlocale.h:32:34: error: static declaration of 'strtoull_l' follows non-static declaration
2023-01-01 16:21:34   /emsdk/upstream/emscripten/system/lib/libcxx/include/__support/musl/xlocale.h:37:25: error: static declaration of 'wcstoll_l' follows non-static declaration
2023-01-01 16:21:34   /emsdk/upstream/emscripten/system/lib/libcxx/include/__support/musl/xlocale.h:42:34: error: static declaration of 'wcstoull_l' follows non-static declaration
2023-01-01 16:21:34   /emsdk/upstream/emscripten/system/lib/libcxx/include/__support/musl/xlocale.h:48:27: error: static declaration of 'wcstold_l' follows non-static declaration
2023-01-01 16:21:34   /emsdk/upstream/emscripten/system/lib/libcxx/include/locale:752:26: error: call to 'strtoll_l' is ambiguous
2023-01-01 16:21:34   /emsdk/upstream/emscripten/system/lib/libcxx/include/locale:792:35: error: call to 'strtoull_l' is ambiguous
2023-01-01 16:21:35 building /opencascade.js/build/bindings/myMain.h/Handle_IMeshTools_Context.cpp
2023-01-01 16:21:35 building /opencascade.js/build/bindings/myMain.h/OCJS.cpp
2023-01-01 16:21:50 building /opencascade.js/build/additionalBindCode/opencascade.full.js.cpp
2023-01-01 16:21:50 Running build: opencascade.full.js
2023-01-01 16:21:54 ports:INFO: retrieving port: freetype from https://github.com/emscripten-ports/FreeType/archive/version_1.zip
2023-01-01 16:21:55 ports:INFO: unpacking port: freetype

.....

cache:INFO: generating system library: sysroot/lib/wasm32-emscripten/lto/libcompiler_rt.a... (this will be cached in "/emsdk/upstream/emscripten/cache/sysroot/lib/wasm32-emscripten/lto/libcompiler_rt.a" for subsequent builds)
cache:INFO:  - ok
cache:INFO: generating system library: sysroot/lib/wasm32-emscripten/lto/libc++.a... (this will be cached in "/emsdk/upstream/emscripten/cache/sysroot/lib/wasm32-emscripten/lto/libc++.a" for subsequent builds)
cache:INFO:  - ok
cache:INFO: generating system library: sysroot/lib/wasm32-emscripten/lto/libc++abi.a... (this will be cached in "/emsdk/upstream/emscripten/cache/sysroot/lib/wasm32-emscripten/lto/libc++abi.a" for subsequent builds)
cache:INFO:  - ok
cache:INFO: generating system library: sysroot/lib/wasm32-emscripten/lto/libsockets.a... (this will be cached in "/emsdk/upstream/emscripten/cache/sysroot/lib/wasm32-emscripten/lto/libsockets.a" for subsequent builds)
cache:INFO:  - ok
 emcc: error: '/emsdk/upstream/bin/wasm-ld @/tmp/emscripten_f_zc1vqr.rsp.utf-8' failed (received SIGKILL (-9))
Traceback (most recent call last):
 File "/opencascade.js/src/buildFromYaml.py", line 127, in <module>
 runBuild(buildConfig["mainBuild"])
File "/opencascade.js/src/buildFromYaml.py", line 118, in runBuild
subprocess.check_call([
File "/usr/lib/python3.8/subprocess.py", line 364, in check_call
raise CalledProcessError(retcode, cmd)

I tried on WSL and Ubuntu github actions

https://github.com/kerimcharfi/opencascade.js/actions/runs/3817610186

Bumps decode-uri-component from 0.2.0 to 0.2.2.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps decode-uri-component from 0.2.0 to 0.2.2.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps decode-uri-component from 0.2.0 to 0.2.2.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.