Toolkit for CS749: Digital Geometry Processing (http://www.cse.iitb.ac.in/~cs749)
Author: Siddhartha Chaudhuri. Released under the BSD license (see LICENSE.txt)
If you find a bug, please let me know promptly. Thank you!
DGP's graphics module needs OpenGL. If you plan to use it, please ensure you have OpenGL 2.0 or later (GL and GLU) installed on your system. The guides at http://web.eecs.umich.edu/~sugih/courses/eecs487/glut-howto/ and http://cacs.usc.edu/education/cs596/OGL_Setup.pdf may be useful.
If you want to take full advantage of your fancy graphics card, you will need the latest drivers from the manufacturer. (This is not an option on OS X.) On Linux, if you're lucky, things will just work. Else, you can be stuck in some weird conflict between the default GL library (Mesa) and the manufacturer's optimized version (NVIDIA or AMD). Make sure libGL.so, wherever it is located on your system (e.g. /usr/lib/x86_64-linux-gnu/ on Ubuntu 14.04), is a link to the manufacturer-provided libGL.so (e.g. /usr/lib/nvidia-352/libGL.so).
If you're not going to use the graphics module, there are no external dependencies. Just omit the DGP/Graphics subdirectory from your build.
To check out the repository:
git clone https://github.com/sidch/DGP
There is no separate installation step. Just copy the DGP/DGP subfolder to your source folder.
Important: Don't modify the DGP code for an assignment. We will replace your copy of DGP with ours when testing your submission. It should run as expected with our copy of DGP.
Recommended:
- Keep a master copy of DGP on your system, which you update regularly via
git pull origin master. This copy will have the following directory structure:
Projects/DGP
|
+-- DGP
| |
| +-- Common.hpp
| +-- Common.cpp
| +-- Vector3.hpp
| +-- ...
|
+-- README.md
+-- ...
- For every assignment, copy the latest version of the DGP/DGP subfolder to your assignment source folder.
Assigments/HW1
|
+-- src
|
+-- DGP
| |
| +-- Common.hpp
| +-- Common.cpp
| +-- Vector3.hpp
| +-- ...
|
+-- Foo.hpp
+-- Foo.cpp
+-- ...
To generate HTML documentation for the API, run Doxygen (http://www.doxygen.org) in the root DGP folder. Then, open html/index.html in a browser.
This is probably the best place to start looking at the toolkit.
Note that many convenience types, such as Vector3 and Matrix4, are typedefs (for VectorN<3, Real> and MatrixMN<3, 3, Real> respectively) and don't show up in the Class Index. To see them, go to Namespaces --> Namespace Members --> Typedefs.
The toolkit is written in standard C++ and should compile with any modern, standards-compliant, C++11 compiler. The usual candidates are GCC, Clang and Visual C++. The syntax is actually C++98-compatible; only certain library features (such as unordered_set and type_traits) require C++11.
GCC/Clang-specific: You MUST compile with strict aliasing turned OFF. This is achieved with -fno-strict-aliasing. To support C++11, you need -std=c++11. I also recommend -Wall -g2 -O2 (all Warnings, debuGgable binaries, Optimize for speed). -O2 messes up the debugging a bit so turn it off temporarily if you can't track down your bug. The full command line is:
g++ -Wall -g2 -O2 -fno-strict-aliasing -std=c++11 <source-files>
When building your assignment, make sure the .cpp files in the src/DGP (and src/DGP/Graphics, if you're using the graphics module) subfolder are included in the build. If you're using a Makefile, use a wildcard pattern such as $(wildcard DGP/*.cpp). If you're using Visual Studio or other IDE, add the subfolder to the project. You might need to explicitly link the standard math library via -lm. On OS X, you will need to add -framework Carbon.
In your source files (such as Foo.cpp above), include the appropriate DGP headers as needed:
#include "DGP/Vector3.hpp"
#include "DGP/Ball3.hpp"
class Foo
{
private:
DGP::Vector3 position;
DGP::Ball3 bounding_sphere;
...
};