misc.docu 6.94 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3 4 5
//-----------------------------------------------------------------------------


/** \page naming_conventions Naming Conventions

6
The following naming conventions are used for the %OpenMesh code:
Jan Möbius's avatar
Jan Möbius committed
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

<b>Files:</b>
  \li \c MyClass.cc for C++-Implementation of class \c MyClass
  \li \c MyClass.hh for C++-Header of class \c MyClass

<b>Classes:</b>
  \li Class names start with a capital letter: \c MyClass
  \li Class templates end with \c T: \c MyClassTemplateT

<b>Variables:</b>
  \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__

<b>Functions:</b>
  \li Words are separated by underscores: \c my_function()
		 
<b>Accessing members:</b>
  \li To get the member \c xxx_ use <tt> const& xxx() const </tt>
  \li To set the member \c xxx_ use <tt> void set_xxx(arg)  </tt>
  
**/


//-----------------------------------------------------------------------------


34
/** \page compiling Compiling OpenMesh
Jan Möbius's avatar
Jan Möbius committed
35 36 37

\section compilers Tested compilers

38
%OpenMesh has been successfully tested for the following operating
Jan Möbius's avatar
Jan Möbius committed
39 40 41 42 43 44 45 46 47
systems / compilers:

<table>

<tr><td> Linux </td><td>
gcc 4.0.x<br>
gcc 4.1.x<br>
gcc 4.2.x<br>
gcc 4.3.x<br>
Jan Möbius's avatar
Jan Möbius committed
48
gcc 4.4.x<br>
Jan Möbius's avatar
Jan Möbius committed
49 50
gcc 4.5.x<br>
gcc 4.6.x<br>
Jan Möbius's avatar
Jan Möbius committed
51 52 53 54
</td></tr>

<tr><td> Windows </td><td> 
Microsoft Visual Studio 2008<br>
Jan Möbius's avatar
Jan Möbius committed
55
Microsoft Visual Studio 2010<br>
Jan Möbius's avatar
Jan Möbius committed
56 57
</td></tr>

Jan Möbius's avatar
Jan Möbius committed
58
<tr><td> MacOS X <br>(Panther,Tiger,Leopard,Snow Leopard)</td><td> 
Jan Möbius's avatar
Jan Möbius committed
59
gcc 4.0 <br>
60
gcc 4.2 <br>
Jan Möbius's avatar
Jan Möbius committed
61 62 63 64
</td></tr>

</table>

Jan Möbius's avatar
Jan Möbius committed
65
\section req_libs Required libraries (Only for included Apps)
Jan Möbius's avatar
Jan Möbius committed
66

Jan Möbius's avatar
Jan Möbius committed
67
Install the following external libraries / frameworks if you want to use the included Applications:<br><br>
68 69
<table>
<tr><td>Qt4</td><td><a href="http://www.qtsoftware.com/downloads" target="_blank">http://www.qtsoftware.com/downloads</a></td></tr>
70
</table><br>
71 72 73

\section build_systems Chosing build system

74
%OpenMesh can be built using the <b>cmake</b> build system.
Jan Möbius's avatar
Jan Möbius committed
75 76
<br>
<br>
77 78

\section sec_compiling_unix Unix
79

80
\subsection linux_using_cmake Compiling OpenMesh using CMake
81

82
In order to compile %OpenMesh, create a directory named e.g. "build" in
83
OpenMesh's root directory. <b>Change to the newly created directory</b> and type
84 85 86
<br/><br/>
<tt>
cmake&nbsp;..&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;## Generates the appropriate Makefiles<br>
87
make&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;## Builds the project<br>
88
</tt><br>
89 90 91 92
You can choose the build type by using cmake with the flag<br>
<b>-DCMAKE_BUILD_TYPE=(Debug|Release)</b><br>
The default is: Debug
<br>
Mike Kremer's avatar
Mike Kremer committed
93 94
Other flags are:<br/>
<b>-DBUILD_APPS=OFF</b> to disable build of applications and<br/>
95
<b>-DCMAKE_INSTALL_PREFIX=&lt;path&gt;</b> to specify the install path.
Mike Kremer's avatar
Mike Kremer committed
96
<br/>
97
When calling <b>make install</b> cmake will install %OpenMesh into this
Mike Kremer's avatar
Mike Kremer committed
98 99 100
directory using the subdirectories lib/include/bin.

CMake builds both shared and static under Linux.
101 102

Everything will then be build in the <b>Build</b> subdirectory containing the libraries in <b>lib</b> and the binaries in <b>bin</b>.
103 104 105 106

There are some additional targets:<br>
<b>doc</b>: Builds the Documentation<br>
<b>doc-install</b>: Builds the Documentation and installs it<br>
107 108
<br>
<br>
109

Jan Möbius's avatar
Jan Möbius committed
110 111
\section sec_compiling_windows Windows

112
\subsection windows_using_cmake Compiling OpenMesh using CMake
113 114 115

If you want to use cmake to build your Visual Studio 2008 solution file,<br>
download and install CMake from <a href="http://www.cmake.org/cmake/resources/software.html">www.cmake.org</a>.<br>
116
(Note: This is not mandatory since there are already VS2008 solution files included in %OpenMesh).<br><br>
117 118 119
<br>
<br>
<ul>
Jan Möbius's avatar
Jan Möbius committed
120
<li> Get Visual Studio 2008 or 2010 </li>
121
<li> Extract %OpenMesh source code. </li>
122 123
<li> Get all required libraries and install them ( including headers! ).</li>
<li> Get cmake for windows from http://www.cmake.org/cmake/resources/software.html <li>
124
<li> Start the cmake gui and open the %OpenMesh toplevel directory as source directory </li>
125 126
<li> Choose a build directory (e.g. create a directory called "build" in OpenMesh's root folder) </li>
<li> Click on configure .... If any libraries are left unconfigured, you can adjust the path manually. Rerun configure until everything is configured correctly.
Jan Möbius's avatar
Jan Möbius committed
127
     Attention: Some build variables are only visible in advanced view mode. Select Visual Studio 9 2008 or Visual Studio 10 (Depending on your version) as
128
     generator. </li>
129
<li> Click generate to create the visual studio project files </li>
130
<li> You can now find a Visual Studio solution file (OpenMesh.sln) in the <b>build</b> directory you chose in cmake </li>
131
<li> Now you can build %OpenMesh from within Visual Studio using the newly created project file. </li>
132 133
</ul>

134
Note: Set the CMAKE_BUILD_TYPE variable to "Release" if you want %OpenMesh to be built as release.
Jan Möbius's avatar
Jan Möbius committed
135
In Visual Studio choose "Release" in the appropriate select box and build the solution afterwards.
136

Jan Möbius's avatar
Jan Möbius committed
137 138 139
<br>
<br>

140
\section sec_compiling_macosx MacOS X
Jan Möbius's avatar
Jan Möbius committed
141

142
Download and install required libraries as stated above.
143 144 145 146 147 148
You can download %OpenMesh's sources from <tt>www.openmesh.org</tt> or check out the latest repository via SVN:<br/>
<tt>svn co http://www.openmesh.org/svnrepo/OpenMesh/trunk %OpenMesh</tt>.<br/><br/>

\subsection mac_using_cmake Compiling OpenMesh using CMake

We recommend you to use CMake >= 2.8 as build system. This can also easily be installed
Jan Möbius's avatar
Jan Möbius committed
149
via MacPorts as well as the Qt >= 4.7 library which is used for some example applications
150 151 152 153 154
in %OpenMesh.<br/>
Once installed, change to %OpenMesh's root directory and create a directory
named e.g. "buildDebug" (assuming you want to build with debug symbols).<br/>
Then type in the following command to initially set up the build environment:
<br/><br/>
155
<tt>
156
cmake&nbsp;..&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;## Generates the appropriate Makefiles<br>
157
</tt>
158 159 160 161
<br/>
Note: If the build directory is not a subdirectory of %OpenMesh's root folder, replace ".." with %OpenMesh's
absolute (or relative) path.
In order to manually set specific build variables, just type:
162 163
<br/><br/>
<tt>
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
ccmake&nbsp;.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;## Configure build environment<br>
</tt>
<br/>
This opens the CMake configure tool. Change the CMAKE_BUILD_TYPE variable to "Release" in order to prepare build
for release configuration. Now, when everything is set up, just type:
<br/><br/>
<tt>
make&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;## Build %OpenMesh<br>
</tt>
<br/>
And optionally:
<br/><br/>
<tt>
make&nbsp;doc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;## Build %OpenMesh's documentation<br>
</tt>
<br>
180 181 182
The mac application bundle will be found under "Build" in the recently created build folder. 
It automatically contains all needed shared objects (libs, fonts, textures, etc.).

Mike Kremer's avatar
Mike Kremer committed
183 184
CMake builds both shared and static under MacOS X.

Jan Möbius's avatar
Jan Möbius committed
185 186 187 188
**/


//-----------------------------------------------------------------------------