This is first and foremost a header library. Each header file should contain a single function. The function may have multiple prototypes. All functions should use the igl namespace and should adhere to the conventions and styles listed below.

Dependencies

Eigen3 Last tested with Eigen Version 3.2

Optional

OpenGL (IGL_NO_OPENGL)
AntTweakBar (IGL_NO_ANTTWEAKBAR) Last tested 1.16 (see
libigl/external/AntTweakBar)
GLEW Windows only
OpenMP
libpng libiglpng extra only
Mosek libiglmosek extra only
Matlab libiglmatlab extra only
boost libiglboost, libiglcgal extra only
SSE/AVX libiglsvd3x3 extra only
CGAL libiglcgal extra only
- boost
- gmp
- mpfr

Optional (included in external/)

TetGen libigltetgen extra only
Embree libiglembree extra only
tinyxml2 libiglxml extra only

Header only

libigl is designed to work "out-of-the-box" as a headers only library. To include libigl in your project. You need only include the libigl/include/ directory in your include path and define the IGL_HEADER_ONLY macro. To compile a hello-word example.cpp:

#include <Eigen/Dense>
#include <igl/readOBJ.h>
#include <iostream>
int main(int argc, char * argv[])
{
  if(argc>1)
  {
    Eigen::MatrixXd V;
    Eigen::MatrixXi F;
    igl::readOBJ(argv[1],V,F);
    std::cout<<"Hello, mesh with "<<V.rows()<<" vertices!"<<std::endl;
  }else{
    std::cout<<"Hello, world!"<<std::endl;
  }
  return 0;
}

using gcc (replacing appropriate paths):

g++ -DIGL_HEADER_ONLY -I/usr/local/igl/libigl/include \
  -I/opt/local/include/eigen3 example.cpp -o example

Then run this example with:

./example examples/shared/TinyTorus.obj

Compile

libigl is developed most often on Mac OS X, though has current users in Linux and Windows.

Linux/Mac OS X/Cygwin

libigl may also be compiled to a static library. This is advantageous when building a project with libigl, since the header only directive can slow down compile times.

To build the entire libigl library producing lib/libigl.a, issue:

cd build
make lib

You may need to edit Makefile.conf accordingly. Best to give yourself an IGL_USERNAME and add a custom install suite for yourself. Then you can enable appropriate extras.

Extras

Once you've set up an IGL_USERNAME and enabled extras within Makefile.conf. You can build the extra libraries (into lib/ligiglpng.a, lib/libiglmatlab.a, lib/libigltetgen.a, lib/libiglmosek.a, etc.) by issuing:

cd build
make extras

Examples

You can make a slew of examples by issuing:

cd build
make examples

External

Finally there are a number of external libraries that we include in ./external/ because they are either difficult to obtain or they have been patched for easier use with libigl. Please see the respective readmes in those directories.

Installing AntTweakBar

To build the a static AntTweakBar library on Mac OS X issue:

cd external/AntTweakBar/src
make -f Makefile.osx.igl

Installing Tetgen

To build the tetgen library and executable on Mac OS X issue:

cd external/tetgen
make clean
rm -f obj/*.o
make -f Makefile.igl tetgen
rm -f obj/*.o
make -f Makefile.igl tetlib

Installing medit

To build the igl version of the medit executable on Mac OS X issue:

cd external/medit
make -C libmesh 
make -f Makefile.igl medit

Installing Embree 2.0

To build the embree library and executables on Mac OS X issue:

cd external/embree
mkdir build
cd build
cmake ..
# Or using a different compiler
#cmake .. -DCMAKE_C_COMPILER=/opt/local/bin/gcc -DCMAKE_CXX_COMPILER=/opt/local/bin/g++
make
# Could also install embree to your root, but libigl examples don't expect
# this
#sudo make install

Installing tinyxml2

To build the a static tinyxml2 library on Mac OS X issue:

cd external/tinyxml2
cmake .
make

Installing YImg

To build the a static YImg library on Mac OS X issue:

cd external/yimg
make

You may need to install libpng. Systems with X11 might find this already installed at /usr/X11/lib.

Windows (Experimental)

To build a static library (.lib) on windows, open Visual Studio 2010.

New > Project ...
Visual C++ > Win32
Win32 Console Application
Name: libiglVisualStudio
Uncheck "Create directory for solution"
Then hit OK, and then Next
Check "Static Library"
Uncheck "Precompiled headers"
Add all include/igl/*.cpp to the sources directory
Add all include/igl/*.h to the headers directory
Open Project > libigl Properties...
Add the path to eigen3 to the include paths
Change the target name to libigl
Build and pray (this should create libigl.lib

Source

Examples

To get started, we advise that you take a look at a few examples:

./examples/hello-world/

./examples/meshio/

./examples/basic-topology/

./examples/ReAntTweakBar/

Extras

Libigl compartmentalizes dependences via its organization into a main libigl library and "extras."

bbw

This library extra contains functions for computing Bounded Biharmonic Weights, can be used with and without the mosek extra via the IGL_NO_MOSEK macro.

boost

This library extra utilizes the graph functions in the boost library for find connected components and performing breadth-first traversals.

cgal

This library extra utilizes CGAL's efficient and exact intersection and proximity queries.

embree

This library extra utilizes embree's efficient ray tracing queries.

matlab

This library extra provides support for reading and writing .mat workspace files, interfacing with Matlab at run time and compiling mex functions.

mosek

This library extra utilizes mosek's efficient interior-point solver for quadratic programs.

png

This library extra uses libpng and YImage to read and write .png files.

svd3x3

This library extra implements "as-rigid-as-possible" (ARAP) deformation techniques using the fast singular value decomposition routines written specifically for 3x3 matrices to use SSE intrinsics. This extra can still be compiled without sse support and support should be determined automatically at compile time via the __SSE__ macro.

tetgen

This library extra provides a simplified wrapper to the tetgen 3d tetrahedral meshing library.

viewer

This library extra utilizes glfw and glew to open an opengl context and launch a simple mesh viewer.

xml

This library extra utilizes tinyxml2 to read and write serialized classes containing Eigen matrices and other standard simple data-structures.

Development

Further documentation for developers is listed in tutorial.html, style_guidelines.html

License

See LICENSE.txt

Zipping

Zip this directory without .git litter and binaries using:

git archive —prefix=libigl/ -o libigl.zip master

Contact

libigl is a group endeavor led by Alec Jacobson and Daniele Panozzo. Please contact alecjacobson@gmail.com if you have questions or comments. We are happy to get feedback! Enjoy!

If you find bugs or have problems please use our github issue tracking page.