Package: manifold3d
UsersOpenSCAD,IFCjs,Grid.Space, andOCADmlhave all integrated our Manifold geometry kernel! Why? Because its reliability is guaranteed and it's 1,000 times faster than other libraries. See ourusageandperformancediscussions for all the latest and to add your own projects & analyses.Manifold Frontend SandboxesManifoldCAD.orgIf you like OpenSCAD / JSCAD, you might also like ManifoldCAD - our own solid modelling web app where you script in JS/TS. This uses our npm package,manifold-3d, built via WASM. It's not quite as fast as our raw C++, but it's hard to beat for interoperability.Note for Firefox users: If you find the editor is stuck onLoading..., settingdom.workers.modules.enabled: truein yourabout:config, as mentioned inissue#328may solve the problem.Python Colab ExampleIf you prefer Python to JS/TS, make your own copy of the example notebook above. It demonstrates interop between ourmanifold3dPyPI library and the populartrimeshlibrary, including showing the interactive model right in the notebook and saving 3D model output.ManifoldAPI Documentation|Algorithm Documentation|Blog Posts|Web ExamplesManifoldis a geometry library dedicated to creating and operating on manifold triangle meshes. Amanifold meshis a mesh that represents a solid object, and so is very important in manufacturing, CAD, structural analysis, etc. Further information can be found on thewiki.This is a modern C++ library that Github's CI verifies builds and runs on a variety of platforms. Additionally, we build bindings for JavaScript (manifold-3don npm), Python (manifold3d), and C to make this library more portable and easy to use.System Dependencies (note that we will automatically download the dependency if there is no such package on the system):GLM: A compact header-only vector library.Thrust: NVIDIA's parallel algorithms library (basically a superset of C++17 std::parallel_algorithms)tbb: Intel's thread building blocks library. (only whenMANIFOLD_PAR=TBBis enabled)gtest: Google test library (only when test is enabled, i.e.MANIFOLD_TEST=ON)Other dependencies:Clipper2: provides our 2D subsystemquickhull: 3D convex hull algorithm.What's hereThis library is fast with guaranteed manifold output. As such you need manifold meshes as input, which this library can create using constructors inspired by the OpenSCAD API, as well as more advanced features like smoothing and signed-distance function (SDF) level sets. You can also pass in your own mesh data, but you'll get an error status if the imported mesh isn't manifold. Various automated repair tools exist online for fixing non manifold models, usually for 3D printing.The most significant contribution here is a guaranteed-manifoldmesh Booleanalgorithm, which I believe is the first of its kind. If you know of another, please open a discussion - a mesh Boolean algorithm robust to edge cases has been an open problem for many years. Likewise, if the Boolean here ever fails you, please submit an issue! This Boolean forms the basis of a CAD kernel, as it allows simple shapes to be combined into more complex ones.To aid in speed, this library makes extensive use of parallelization, generally through Nvidia's Thrust library. You can switch between the TBB, and serial C++ backends by setting a CMake flag. Not everything is so parallelizable, for instance apolygon triangulationalgorithm is included which is serial. Even if compiled with parallel backend, the code will still fall back to the serial version of the algorithms if the problem size is small. The WASM build is serial-only for now, but still fast.Note: OMP and CUDA backends are now removedLook in thesamplesdirectory for examples of how to use this library to make interesting 3D models. You may notice that some of these examples bare a certain resemblance to my OpenSCAD designs onThingiverse, which is no accident. Much as I love OpenSCAD, my library is dramatically faster and the code is more flexible.BuildingOnly CMake, a C++ compiler, and Python are required to be installed and set up to build this library (it has been tested with GCC, LLVM, MSVC). However, a variety of optional dependencies can bring in more functionality, see below.Build and test (Ubuntu or similar):git clone --recurse-submodules https://github.com/elalish/manifold.git
cd manifold
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .. && make
test/manifold_testCMake flags (usage e.g.-DMANIFOLD_DEBUG=ON):MANIFOLD_JSBIND=[OFF, <ON>]: Build js binding when using emscripten.MANIFOLD_CBIND=[<OFF>, ON]: Build C FFI binding.MANIFOLD_PYBIND=[OFF, <ON>]: Build python binding.MANIFOLD_PAR=[<NONE>, TBB]: Provides multi-thread parallelization, requireslibtbb-devifTBBbackend is selected.MANIFOLD_EXPORT=[<OFF>, ON]: Enables GLB export of 3D models from the tests, requireslibassimp-dev.MANIFOLD_DEBUG=[<OFF>, ON]: Enables internal assertions and exceptions.MANIFOLD_TEST=[OFF, <ON>]: Build unittests.TRACY_ENABLE=[<OFF>, ON]: Enable integration with tracy profiler.
See profiling section below.BUILD_TEST_CGAL=[<OFF>, ON]: Builds a CGAL-based performancecomparison, requireslibcgal-dev.Offline building:FETCHCONTENT_SOURCE_DIR_GLM: path to glm source.FETCHCONTENT_SOURCE_DIR_GOOGLETEST: path to googletest source.FETCHCONTENT_SOURCE_DIR_THRUST: path to NVIDIA thrust source.The build instructions used by our CI are inmanifold.yml, which is a good source to check if something goes wrong and for instructions specific to other platforms, like Windows.WASMNote that we have only tested emscripten version 3.1.45. It is known that
3.1.48 has some issues compiling manifold.To build the JS WASM library, first install NodeJS and set up emscripten:(on Mac):brew install nodejs
brew install emscripten(on Linux):sudo apt install nodejs
git clone https://github.com/emscripten-core/emsdk.git
cd emsdk
./emsdk install latest
./emsdk activate latest
source ./emsdk/emsdk_env.shThen build:cd manifold
mkdir buildWASM
cd buildWASM
emcmake cmake -DCMAKE_BUILD_TYPE=Release .. && emmake make
node test/manifold_test.jsPythonThe CMake script will build the python bindingmanifold3dautomatically. To
use the extension, please add$BUILD_DIR/bindings/pythonto yourPYTHONPATH, where$BUILD_DIRis the build directory for CMake. Examples using the python binding
can be found inbindings/python/examples. To see exported samples, run:sudo apt install pkg-config libpython3-dev python3 python3-distutils python3-pip
pip install trimesh pytest
python3 run_all.py -eRun the following code in the interpreter for
python binding documentation:>>> import manifold3d
>>> help(manifold3d)For more detailed documentation, please refer to the C++ API.ContributingContributions are welcome! A lower barrier contribution is to simply make a PR that adds a test, especially if it repros an issue you've found. Simply name it prepended with DISABLED_, so that it passes the CI. That will be a very strong signal to me to fix your issue. However, if you know how to fix it yourself, then including the fix in your PR would be much appreciated!FormattingThere is a formatting scriptformat.shthat automatically formats everything.
It requires clang-format 11 and black formatter for python.If you have clang-format installed but without clang-11, you can specify the
clang-format executable by setting theCLANG_FORMATenvironment variable.ProfilingThere is now basic support for theTracy profilerfor our tests.
To enable tracing, compile with-DTRACY_ENABLE=oncmake option, and run the test with Tracy server running.
To enable memory profiling in addition to tracing, compile with-DTRACY_MEMORY_USAGE=ONin addition to-DTRACY_ENABLE=ON.Fuzzing SupportWe usehttps://github.com/google/fuzztestfor fuzzing the triangulator.To enable fuzzing, make sure that you are using clang compiler (-DCMAKE_CXX_COMPILER=clang -DCMAKE_C_COMPILER=clang), running Linux, and enable fuzzing support by setting-DMANIFOLD_FUZZ=ON.To run the fuzzer and minimize testcase, do../minimizer.sh ./test/polygon_fuzz --fuzz=PolygonFuzz.TriangulationNoCrashAbout the authorThis library was started byEmmett Lalish. I am currently a Google employee and this is my 20% project, not an official Google project. At my day job I'm the maintainer of<model-viewer>. I was the first employee at a 3D video startup,Omnivor, and before that I worked on 3D printing at Microsoft, including3D Builder. Originally an aerospace engineer, I started at a small DARPA contractor doing seedling projects, one of which becameSea Hunter. I earned my doctorate from the University of Washington in control theory and published somepapers.