mainpage.docu 1.47 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1
2
/** \mainpage OpenMesh Documentation

3
4
5
Welcome to the %OpenMesh documentation. %OpenMesh is a generic and efficient library
that offers data structures for representing and manipulating polygonal meshes.
Here you can find information on how to build projects using the %OpenMesh library
Jan Möbius's avatar
Jan Möbius committed
6
as well as further information on mesh handling in %OpenMesh.
7
8
9
10
11
12
13
14
The tutorials explain how to use %OpenMesh by demonstrating real code examples.

\section iov Introduction
In this section all necessary information on how to build projects using %OpenMesh
is given. Additionally you can read about the internal naming conventions
to facilitate understanding the %OpenMesh source code. Changes to %OpenMesh are
logged in the Version history.

Jan Möbius's avatar
Jan Möbius committed
15
16
17
\li \ref compiling
\li \ref naming_conventions
\li \ref history
18
19

\section mesh_docu Using and understanding OpenMesh
Jan Möbius's avatar
Jan Möbius committed
20
21
22
We provide a short overview over the functionality of the %OpenMesh
library and some additional concepts in \ref tutorial. Additionally we explain the 
most important topics of %OpenMesh in the following sections:
23
24
25
26
27
28
29
30
31
32
33
34
35
36

\li \ref mesh_first_to_read
\li \ref mesh_features
\li \ref mesh_cpp
\li \ref mesh_hds
\li \ref mesh_iterators
\li \ref mesh_io
\li \ref mesh_type
\li \ref mesh_hierarchy
\li \ref mesh_members

The %OpenMeshTools library that contains some useful tools
for i.e. mesh processing:

Jan Möbius's avatar
Jan Möbius committed
37
38
\li \ref tools_docu

39
40
41
42
43
44
\section tov Tutorials
This section offers some useful code examples in order to show
how to use the provided mesh structures.

\li \ref tutorial

Jan Möbius's avatar
Jan Möbius committed
45
**/