misc.docu 2.99 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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 ``````//----------------------------------------------------------------------------- /** \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 3.3
gcc 4.0
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)
sudo make install ## Install OpenMesh (as root)

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 For Microsoft Visual Studio 2008, you can use the predefined solution file Core/OpenMesh_Core.vcproj and Tools/OpenMesh_Tools.vcproj \section sec_compiling_macosx MacOSX Download and install the Qt4 framework from Trolltech.
In order to compile and install OpenMesh, open a Terminal window and enter following commands in OpenMesh's root directory:

qmake -macx       ## Generates the appropriate Makefiles
make release      ## Builds the project (use 'make debug' to build debug version)
sudo make install ## Install OpenMesh (as root)
**/ //-----------------------------------------------------------------------------``````