Repository files navigation

Infrastructure for solid modeling.
Homepage |API Examples |Downloads

libfive is a framework for solid modeling usingfunctional representations.

It includes several layers, ranging from infrastructure to GUI:

• Thelibfive shared library contains functions to build, manipulate, and render f-reps.A great deal of work has gone into the meshing algorithm,which produces watertight, manifold,hierarchical, feature-preserving triangle meshes.The library is written in C++ and exposes a C API inlibfive.h.
• Thelibfive standard library is a library of common shapes, transforms, and CSG operations.It is implemented in C++ and exposes a C API inlibfive/stdlib/stdlib.h
• The standard library is parsed and used to generate bindings for bothGuile SchemeandPython,for use in the REPL or as part of larger applications.
• Studio is a GUI application in the style ofOpenSCAD.It uses the Python and Guile bindings and allows for live-coding of solid models.The interface also includes direct modeling,where the user can push and pull on the model's surfaceto change variables in the script.

• Tovero: A 3D modeling system for Common Lisp
• libfivepy: A Python CAD library (work in progress)
• Bindings for Unity
• High levelRust bindings
• UnpublishedStanza bindings (email for details)

• Inspekt3D: Lightweight pure-Guile viewer
• PyFive3D: Lightweight pure-Python viewer (work in progress)
• C5H12 (Pentane): Lightweight C viewer

• Massively Parallel Rendering of Complex Closed-Form Implicit Surfaces:a technical paper extendinglibfive to render on the GPU(reference implementation)

Forlibfive-specific discussions, consider opening a topic in theGithub Discussions tab.

There's also alibfive subforum in theSDF User Group Discourse,which is a good place for general discussion of modeling with signed distancefields.

(c) 2015-2021 Matthew Keeter

Different layers of this project are released under different licenses:

• Thelibfive library,libfive-stdlib library, and Python bindingsare released under theMozilla Public License, version 2.
• libfive-guile andStudio are released under theGNU General Public License, version 2or later.

Contact the authorto discuss custom development, integration,or commercial support.

libfive and Studio are compatible with macOS, Linux, and Windows.

• cmake 1.65 or later
• pkg-config
• Eigen 3.3.x
• libpng
• Boost 1.65 or later

• Guile 2.2.1 or later

• Python 3.7 or later

• Qt 5.12 or later

Whencmake is first run,it will check for all dependencies and print details of whatwill be build, e.g.

Checking dependencies:  libfive:              ✓  Guile bindings:       ✓  Python bindings:      ✓  Studio:               ✓   (Python + Guile)

Withhomebrew installed, run

brew install cmake pkg-config eigen libpng boost guile python3 qt

Omitguile,python3, orqt to avoid building bindings and/or the UI.

Then, from thelibfive folder, run something like:

mkdir buildcd buildcmake -DCMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.12.0  ..make

(adjust based on your Qt installation,and consider usingninja for faster builds.

libfive should build out of the box on the latest Ubuntu LTS(currently 20.04). If you find that's not the case, please open an issue!

Start by installing dependencies through the package manager:

sudo apt-get install g++ cmake pkg-config libeigen3-dev libpng-dev libboost-all-dev guile-3.0-dev qtbase5-dev python3

Omitguile-3.0-dev and/orqtbase5-dev if you do not want Guile bindings and/or Studio to be built too.

Building is similar as on Mac: clone the repository, then run something like

mkdir buildcd buildcmake ..make -j4

Once building is complete, run Studio with./studio/Studio.

Runningsudo make install will install components to system-wide destinations,e.g./usr/local/bin/Studio for the main executable.This will let you invokeStudio from anywhere in the system,rather than just thebuild directory.If you are using this workflow,sudo make install must be run after changes to the repositoryto update the system-wide installation of the executable and libraries.Studio.desktopmay be used to put a shortcut on your desktop.

If you don't want the Python bindings installed under/usr/lib, youcan specify the install directory using thecmake variablePYTHON_SITE_PACKAGES_DIR, e.g.

cmake -DPYTHON_SITE_PACKAGES_DIR=/usr/local/lib/python3.9/dist-packages .

Ubuntu releases before 20.04 are not officially supported;if you insist,there are hintshereand a discussion of Python linking issueshere.

InstallGit,choosing settings so that it can be invoked from a WindowsCommand Prompt(the defaults should be fine).

InstallVS2022 (Community Edition),configured for "Desktop development with C++".You onlyneed MSVC, Windows 10 SDK, and C++ CMake tools for Windows,so feel free to uncheck other optional packages in the right sidebar,then run the installation!

Next, install dependencies usingvcpkg.

(This step touches many files, so you may want to disable theAntimalware Service Executable,which will otherwise scan every single file and slow things down dramatically:in "Windows Security → Virus & threat protection settings",uncheck "Real-time protection".)

In a WindowsCommand Prompt:

git.exe clone https://github.com/libfive/libfivecd libfivegit clone https://github.com/Microsoft/vcpkg.git.\vcpkg\bootstrap-vcpkg.bat.\vcpkg\vcpkg.exe install --triplet x64-windows eigen3 boost-container boost-bimap boost-interval boost-lockfree boost-functional boost-algorithm boost-math libpng qt5-base python3

Go get some coffee or something - this will take a while.

Once this is done installing,you're ready to actually buildlibfive and Studio!

mkdir buildcd build& "C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin\cmake.exe" -DCMAKE_TOOLCHAIN_FILE="..\vcpkg\scripts\buildsystems\vcpkg.cmake" -DVCPKG_TARGET_TRIPLET="x64-windows" -G"Visual Studio 17 2022" ..& "C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin\cmake.exe" --build . --config Release --target Studio --.\studio\Release\Studio.exe

At this point, you can also double-click onStudio.exe to launch it,and create a shortcut to put it on your desktop.

(don't move it out of thebuild directory,or the precarious house of cards that finds Python will come tumbling down)

When changes are made, youshould only need to re-run the build step, i.e.

& "C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin\cmake.exe" --build . --config Release --target Studio --