CGSee
Free open source viewer/explorer for computer graphics related data, intended to become a Deep Exploration (product development discontinued) replacement.
The source code is licenced under the MIT license.
Development Notes
If you are contributing to this project, please keep the following notes in mind:
- Add your name and email to the AUTHORS file.
- Follow coding conventions according to google's C++ Style Guide.
- Commits should provide a meaningful message, which uses the imperative, present tense: "change", not "changed" nor "changes", AND start with a capital letter.
- Commits should always refer to an issue: use
#xxx
,fix #xxx
, orclose #xxx
. - Pull Requests are reviewed by at least one other developer on another platform.
- Use lazy initialization as often as possible for time consuming tasks.
- Member Variables always start with m_ (e.g.,
m_variable
). - Interface or abstract class names always start with Abstract (e.g.,
AbstractPainter
). - Enforce strict include sequence: own-header, gl, glew, std, glm, qt, other-3rdp, inhouse-party, cgsee (there might be few exceptions, e.g., gpuquery).
Build Notes
CGSee is actively developed on all major platforms (Windows, Mac, Linux).
Dependencies
The following dev-libraries and programs need to be provided for correct CMake configuration:
- C++11 compatible compiler
- Qt5: http://qt-project.org/
- CMake 2.8.11: http://www.cmake.org/
- OpenGL Extension Wrangler (GLEW): http://glew.sourceforge.net/
- OpenGL Mathematics >= 0.9.5 (GLM): http://glm.g-truc.net/
- Assimp 3.0: http://assimp.sourceforge.net
- libzeug: https://github.com/hpicgs/libzeug
- glbinding 0.2: https://github.com/hpicgs/glbinding
- glow 0.3.2: https://github.com/hpicgs/glow