misc.docu 6.41 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 51 52 53 54
</td></tr>

<tr><td> Windows </td><td> 
Microsoft Visual Studio 2008<br>
</td></tr>

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

</table>

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

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

\section build_systems Chosing build system

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

\section sec_compiling_unix Unix
77

78
\subsection linux_using_cmake Compiling %OpenMesh using CMake
79

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

CMake builds both shared and static under Linux.
99 100

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>.
101 102 103 104

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

Jan Möbius's avatar
Jan Möbius committed
108 109
\section sec_compiling_windows Windows

110
\subsection windows_using_cmake Compiling %OpenMesh using CMake
111 112 113

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>
114
(Note: This is not mandatory since there are already VS2008 solution files included in %OpenMesh).<br><br>
115 116 117 118
Install the OpenGL Extension Wrangler Library (GLEW) from <a href="http://glew.sourceforge.net" target="_blank">http://glew.sourceforge.net</a>.
<br>
<br>
<ul>
119
<li> Get Visual Studio 2008 </li>
120
<li> Extract %OpenMesh source code. </li>
121 122
<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>
123
<li> Start the cmake gui and open the %OpenMesh toplevel directory as source directory </li>
124 125 126 127
<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.
     Attention: Some build variables are only visible in advanced view mode. Select Visual Studio 9 2008 as
     generator. </li>
128
<li> Click generate to create the visual studio project files </li>
129
<li> You can now find a Visual Studio solution file (OpenMesh.sln) in the <b>build</b> directory you chose in cmake </li>
130
<li> Now you can build %OpenMesh from within Visual Studio using the newly created project file. </li>
131 132
</ul>

133
Note: Set the CMAKE_BUILD_TYPE variable to "Release" if you want %OpenMesh to be built as release.
134 135
In Visual Studio 2008 choose "Release" in the appropriate select box and build the solution afterwards.

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

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

141
Download and install required libraries as stated above.
142
Because some of the examples depend on the GLEW library, it's recommended to install glew via MacPorts portage system <a href="http://www.macports.org/" target="_blank">MacPorts</a>.<br>
143
If you have not installed it yet, follow the instructions given on their site in order to install it.<br>
144 145
Type
<tt>
146
sudo port -v install glew
147
</tt>
148
to install glew headers and libraries. ( MacPorts usually installs header files to \c /opt/local/include and libraries to \c /opt/local/lib. )<br>
149
<br>
150

151
\subsection mac_using_cmake Compiling %OpenMesh using CMake
152 153

If you're using cmake as preferred build system create a directory
154
named e.g. in %OpenMesh's root directory and change to it.
155 156 157 158 159 160 161 162
<br/><br/>
<tt>
cmake&nbsp;..&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;## Generates the appropriate Makefiles<br>
make&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;## Builds the project (use 'make debug' to build debug version)<br>
</tt><br>
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
163 164
CMake builds both shared and static under MacOS X.

Jan Möbius's avatar
Jan Möbius committed
165 166 167 168
**/


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