Directional - A Directional-Field Processing Library¶
Directional is a C++ library for creating, manipulating and visualizing directional fields on 3D meshes. It is based on Eigen. Directional represents directional fields: discrete sets of vectors on meshes. Much of the content and the notations are based on the Eurographics 2016 star (adapted subsequently to SIGGRAPH Asia 2016/SIGGRAPH 2017 courses) on Directional Field Synthesis, Design, and Processing. Some visualization code is borrowed from the libhedra library.
Directional was called “libdirectional” until version 1.5. The name was shortened to avoid a clash with libDirectional.
Installation¶
Directional is a header-only library where each file generally includes one function. To use the library, simply add the include directory to your include path and make sure Directional and its prerequisites are set up properly. After that you can include any files you need normally, using for example #include <directional/index_prescription.h>.
To get the library, simply clone the repository using:
git clone --recursive https://github.com/avaxman/Directional.git
Features¶
The current version is 2.0, which represents a big paradigm shift from previous versions. Namely, the library uses polymorphic classes to represent abstract discrete tangent bundles, and contains their impelmentations of these interfaces by finite elements on meshes. The library further comprises the following features
- Visualization of fields using (sparsified) glyphs and streamline tracing.
- Principal and curl matching, and combing for N-directional fields.
- Computation of power fields of N-RoSy fields.
- PolyVector fields.
- Optimization for curl reduction.
- Conjugate fields.
- Prescription of singularity, generator, and boundary indices.
- Rotationally- and fully-seamless integration of branched N-functions.
- Meshing of the arrangement of N-functions isolines into polygonal meshes.
- Subdivision fields.
Directional is a header-only library. You do not need to compile anything to use,
just include directional headers (e.g. #include <directional/index_prescription.h>) and run. Each
header file contains a single function (e.g. igl/index_prescription.h contains
igl::index_prescription()). The library needs libigl as a prerequisite which is automatically downloaded. Furthermore, the meshing packages requires CGAL which is used through libigl.
Tutorial¶
A Tutorial that walks through the entire functionality of Directional is available. To compile it, go to the tutorial folder, open a shell and call:
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ../
make
cmake-gui .. and follow the instructions to create a compilable Visual Studio file.
How to Contribute¶
If you are interested in joining development, please fork the repository and submit a pull request with your changes.
License¶
Directional is primarily MPL2 licensed (FAQ). Some files contain third-party code under other licenses.
Attribution¶
If you use Directional in your academic projects, please cite the implemented papers directly, and/or the EG STAR 2016 when appropriate. To cite the library in general, you could use this BibTeX entry:
@misc{Directional,
author = {Amir Vaxman and others},
title = {Directional: A library for Directional Field Synthesis, Design, and Processing},
doi = {10.5281/zenodo.3338174},
url = {https://doi.org/10.5281/zenodo.3338174}
}
Contact¶
Directional is led by Amir Vaxman. Please contact me if you have questions or comments. For troubleshooting, please post an issue on github.
If you’re using Directional in your projects, quickly drop me a note. Tell me who you are and what you’re using it for. This helps justify spending time maintaining this library!
Copyright¶
2017 Amir Vaxman, Sam de Redelijkheid, Daniele Panozzo, Olga Diamanti, Olga Sorkine-Hornung, Bram Custers and others.
Please see individual files for appropriate copyright notices.