misc.docu 4.75 KB
 Jan Möbius committed Feb 06, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 ``````//----------------------------------------------------------------------------- /** \page naming_conventions Naming Conventions The following naming conventions are used for the OpenMesh code: Files: \li \c MyClass.cc for C++-Implementation of class \c MyClass \li \c MyClass.hh for C++-Header of class \c MyClass Classes: \li Class names start with a capital letter: \c MyClass \li Class templates end with \c T: \c MyClassTemplateT Variables: \li One leading underscore for parameters in function-calls: \c _var \li One trailing underscore for member-variables: \c var_ \li Two trailing underscores for static member-variables: \c var__ Functions: \li Words are separated by underscores: \c my_function() Accessing members: \li To get the member \c xxx_ use const& xxx() const \li To set the member \c xxx_ use void set_xxx(arg) **/ //----------------------------------------------------------------------------- /** \page compiling Compiling OpenMesh \section compilers Tested compilers %OpenMesh has been tested sucessfully for the following operating systems / compilers:
Linux gcc 4.0.x
gcc 4.1.x
gcc 4.2.x
gcc 4.3.x
Windows Microsoft Visual Studio 2008
MacOS X
(Panther and Tiger)
gcc 4.0
\section sec_compiling_unix Unix `````` Mike Kremer committed Feb 09, 2009 63 64 65 66 67 68 ``````Install the following external libraries / frameworks:

OpenGLhttp://www.opengl.org
GLEWhttp://glew.sourceforge.net/

`````` Jan Möbius committed Feb 06, 2009 69 70 71 72 ``````In order to compile and install OpenMesh, enter following commands in OpenMesh's root directory:

qmake             ## Generates the appropriate Makefiles
make              ## Builds the project (use 'make debug' to build debug version)
`````` Mike Kremer committed Feb 09, 2009 73 ``````

`````` Jan Möbius committed Feb 06, 2009 74 75 76 77 78 ``````When using the \c qmake command, make sure to use Qt version 4 (some linux distributions
use the link \c qmake-qt4 against the executable). \section sec_compiling_windows Windows `````` Mike Kremer committed Feb 09, 2009 79 ``````Prerequisites:

`````` Mike Kremer committed Feb 09, 2009 80 81 82 ``````If you want to use qmake to build your Visual Studio 2008 solution file,
(Note: This is not mandatory since there are already VS2008 solution files included in OpenMesh).

`````` Mike Kremer committed Feb 09, 2009 83 ``````Install the OpenGL Extension Wrangler Library (GLEW) from http://glew.sourceforge.net. `````` Mike Kremer committed Feb 09, 2009 84 85 86 87 88 89 ``````

Open \c OpenMesh\qmake\packages\packages.Windows in a text editor and change the include and library paths
for GLEW and GLUT such that they match the installed ones (see comments to find the right path entries).
• In Microsoft Visual Studio 2008 open Tools->Visual Studio command prompt
• `````` Jan Möbius committed Apr 30, 2009 90 ``````
• Go to the folder of your application and call \c C:\\qt4\\bin\\qmake.exe -r
• `````` Mike Kremer committed Feb 09, 2009 91 92 93 94 ``````
• Open the resulting visual studio solution ( *.sln )
• Choose which build target to use ( Debug/Release )
• Choose \c Build \c solution from the build menu
`````` Jan Möbius committed Feb 06, 2009 95 96 97 `````` \section sec_compiling_macosx MacOSX `````` Mike Kremer committed Feb 09, 2009 98 ``````Download and install the Qt4 framework from Trolltech.
`````` Mike Kremer committed Feb 09, 2009 99 ``````Because some of the examples depend on the GLEW library, it's recommended to install glew via the darwin portage `````` Mike Kremer committed Feb 09, 2009 100 101 102 103 104 105 ``````system fink.
If you have not installed fink yet, follow the instructions given on their site in order to install it.
Type sudo fink install glew `````` Mike Kremer committed Feb 09, 2009 106 ``````to install glew headers and libraries. ( Fink usually installs header files to \c /sw/include and libraries to \c /sw/lib. )
`````` Mike Kremer committed Feb 09, 2009 107 ``````
`````` Mike Kremer committed Feb 09, 2009 108 109 110 ``````( If you don't want to use fink and install the libraries manually instead -or via darwin ports-, make sure that
the right paths are specified in \c OpenMesh/qmake/packages/packages.Darwin )

`````` Jan Möbius committed Feb 06, 2009 111 112 ``````In order to compile and install OpenMesh, open a Terminal window and enter following commands in OpenMesh's root directory:

`````` Jan Möbius committed Apr 30, 2009 113 ``````qmake -spec macx-g++       ## Generates the appropriate Makefiles
`````` Jan Möbius committed Feb 06, 2009 114 115 116 117 118 119 120 121 ``````make release      ## Builds the project (use 'make debug' to build debug version)
**/ //-----------------------------------------------------------------------------``````