@sohale/implisolid

A Solid Modelling Kernel in Javascript based on Implicit Surfaces, for MP5 file format


Keywords
implicit, mp5, wedesign, 3d, 3dprinting, printing, geometry, emscripten, c++, THREE.js, 3d-printing, c-plus-plus, cpp, cpp14, geometric-algorithms, geometric-modeling, geometric-shapes, geometry-processing, implicit-surfaces, javascript, mesh-generation, mesh-simplification, polygonization, polygonizer, python, python-binding, webworkers
License
GPL-3.0
Install
npm install @sohale/implisolid@0.0.1

Documentation

ImpliSolid

Join the chat at https://gitter.im/implisolid/Lobby

ImpliSolid is a Geometric Modelling library suitable for solid omdlling engine based on Implicit Surfaces modelling (aka F-REP). The main usecase for ImpliSolid is 3D printing.

ImpliSolid uses very efficientcalculations to provide instant polygonisation of Implicit Surfaces efficient eniough to run on your browser using CPU only.

The main strength is its ability to work efficiently with sharp edges. It also uses adaptive subdivition for smooth and perfect curved surfaces. These are achieved using relatively lower resolution meshes.

It uses "vectorised" numerical calulations to achieve higher speed by utilising Instruction Pipelining in modern CPUs. This enables it to be useful on consumer and home computers.

ImpliSolid use is not limited to browsers. It has implementations in C++, Python (native) and JavaScript.

Implisolid homepage: homepage
Github: sohale/implisolid
An interactive live demo: mp5 editor

ImpliSolid uses academic research on the polygonization algorithm such as the algorithm by Ohtake & Belyaev.

Currently two open-source projects that use this library:

E2E demo

For single-click execution in your computer (tested on Ubuntu and MacOS), run:

git clone git@github.com:sohale/implisolid.git
cd implisolid/
bash ./scripts/e2e-test-builds.bash

This will run and end-to-end demo: Pulls the code, compiles the code for Emscripten. Then launches a web server and runs a demo on browser like this. The interactive live demo instantly polygonises the objects and visualises them as the mp5 file is edited.

Architectural Structure

"Implisolid current architecture (Some proposed changes shown in purple) svg

Implemenation

ImpliSolid is implemented for JavaSCript, C++, Python.

JavaScript

Implicit can be compiled into JavaScript using Emscripten.

The Javascript compile target part can run on Browser, or NodeJS, or as a Web Worker.

Implisolid was originally intended for use in Browsers without need to any serverside.

ImpliSolid will soon be available in WebAssembly (tutorial comming soon).

The npm is available from here (will be moved).

Architecture

The IMPLICIT javascript library is a wrapper for the library for browser: js + threejs. It has three levels, each with a separate API. The final version will have 5 levels. Levels 1 and 2 are independent of ThreeJS, hence can be used in NodeJS or as a WebWorker. Only the Highest level API (level 3) uses Three.JS (For example see: mp5_json_code.html and demo1-deploy.sh, mcc2_3js_r79.js or this code fragment).

  • A variant version builds objects incrementally.

  • A variant builds objects incrementally in Web Worker of browser (see implisolid_worker.js).

  • The main target can be compiled using scripts/build-emscripten.sh

  • A web-assembly version will be available soon.

C++

ImpliSolid is written in modern C++.

The C++ implementation can be used standalone for modern C++ compilers such as g++ and clang. The main target is compiled into JavaScript using Emscripten.

Python

Two Python implementations are already available:

  1. As a native Python implementation
  2. As a Python binding that connects to a binary compilation of the C++ version.

Available targets

List of platforms with scripts (to install and compile):

  • JavaScript (browser, formerly called asm.js)
  • JavaScript, WebWorker version
  • WebAssembly (comming soon)
  • JavaScript on npm (comming soon)
  • JavaScript (browser) using Docker (comming soon)
  • Python binding (recommended)
  • Python native (requires dependencies such as VTK or Mayavi)
  • Clang / LLVM
  • Native C++: g++ (see script)

Stargazers

Stargazers over time

Contributors

Tutorials:

E2E demo

For single-click execution in your computer (tested on Ubuntu and MacOS), run:

git clone git@github.com:sohale/implisolid.git
cd implisolid/
bash ./scripts/e2e-test-builds.bash

This will run and end-to-end demo: Pulls the code, compiles the code for Emscripten. Then launches a web server and runs a demo on browser like this. The interactive live demo instantly polygonises the objects and visualises them as the mp5 file is edited.

Deployment on web server

This document describes how to set up your installation so that you can work on the solid modeler projects.

Specifically, instructions for installing MP5/WeDesign Solid Modeler on web server:

Prerequisites


Basic requirements:
  • A Linux distribution of your choice (everything can work on an other os but these tutorials will focus on linux)
  • Git
  • Bash
  • NodeJS
  • A text editor
  • C++ compiler (g++ is a good choice and is often preinstalled)

Installation and proper configuration of above software is out of the scope of this document. Please refer to their documentation.

File organisation


As of 2016 there are three main folders to this project :

  • python_clean_code contains a for now frozen implementation of the Dual/Primal Mesh Optimization algorithme for Polygonized Implicit Surfaces. You can learn more about this algorithme here : http://www.hyperfun.org/SM02ob.pdf. It is the main output of the solid modeler project.
  • 'python_implicit' contains still worked on python scripts related to the project. A big part of this file has been transfered to python_clean_code.
  • js_iteration_1 contains the c++ implementation of the projet, as well as its transcription to javascript and html.

Python


In order to work on and execute the python scripts you may need to install the following libraries :

For most of those libraries, a simple sudo apt-get install python-LibraryName will do the trick. If not you may want to try the easy_install command or the use of pip.


C++ to javascript


See scripts/e2e-test-builds.bash. Simply run bash ./scripts/e2e-test-builds.bash

Older notes are below:

In this part of the project, Emscripten is used to convert c++ code into javascript code that is later used in html.

Boost

For the c++ code, we use the Boost library. It does not need to be built but still need to be installed. You can follow this tutorial to do so : http://www.boost.org/doc/libs/1_57_0/more/getting_started/unix-variants.html.

Emscripten

Emscripten can be used simply using Docker emscripten/emsdk. See abovementioned script.

Old note: The installation of Emscripten often proves a little trickier than the other installations. Here are two tutorials you should follow in the order proposed : https://kripken.github.io/emscripten-site/docs/getting_started/downloads.html#platform-notes-installation-instructions-portable-sdk http://kripken.github.io/emscripten-site/docs/building_from_source/building_fastcomp_manually_from_source.html#building-fastcomp-from-source.

How to compile

The combined use of the Boost library and Emscripten makes compiling a little bit different. For this, we have created the mc_name.sh files. For exemple, I use the mc_marc.sh file to compile a c++ file into a js file (that is later called in the html file you will simply need to launch in your browser). In this mc_name.sh file you'll only find on uncommented line : it is used to compile your c++ file and goes like this : ~/FolderComtainingYourEmsdk_PortableFolder/emsdk_portable/emscripten/master/em++ -I /LocationOfYourBoostInstalation/boost_1_57_0/ -s EXPORTED_FUNCTIONS="['_make_object', '_main']" -s NO_EXIT_RUNTIME=1 -s ASSERTIONS=1 -pedantic -std=c++14 mc2_sol.cpp -o mc2_sol.cpp.js. In this exemple you'll compile the file mc2_sol.cpp into mc2_sol.cpp.js exporting its important functions (make_object and main).


Compiling C++ to javascript using Docker

Simply see build-emscripten.sh.

Old note:

You can use a pre installed docker container to compile implisolid: docker run -v /Users/Tiger/Documents/mp5-private/implisolid:/src -t mp51/solidmodel /bin/bash /src/js_iteration_1/build_mcc2_docker.sh -o