mainpage.docu 3.68 KB
Newer Older
1 2 3 4 5 6 7 8 9
/** 


\if OPENMESH_INTERNAL_DOC
\mainpage OpenMesh Documentation
\else
\page OpenMeshDoc OpenMesh Documentation
\endif

Jan Möbius's avatar
Jan Möbius committed
10
\image html OpenMesh_text_128.png
Jan Möbius's avatar
Jan Möbius committed
11

12 13
Welcome to the %OpenMesh documentation. %OpenMesh is a generic and efficient library
that offers data structures for representing and manipulating polygonal meshes.
14 15 16 17 18 19 20 21 22
It is a powerful tool for handling polygonal
meshes. Due to its inherent generative structure it allows the user to
create mesh types which are custom tailored to the specific needs of
the application. The user can either supply his own data structures
for representing vertices, edges and faces or he can conveniently use
the predefined structures of %OpenMesh.
Additionally %OpenMesh offers dynamic properties allowing the user to attach
and detach data to the mesh during runtime.
    
23
Here you can find information on how to build projects using the %OpenMesh library
Jan Möbius's avatar
Jan Möbius committed
24
as well as further information on mesh handling in %OpenMesh.
25 26
The tutorials explain how to use %OpenMesh by demonstrating real code examples.

27 28 29 30
\section openmesh-python OpenMesh Python Bindings
We also provide python bindings for %OpenMesh. You can find them here:<br/>
<tt>https://www.graphics.rwth-aachen.de:9000/OpenMesh/openmesh-python</tt>

31
\section iov Building OpenMesh
32
In this section all necessary information on how to build projects using %OpenMesh
33
is given.
34

35
\li \subpage compiling
36

Mike Kremer's avatar
Mike Kremer committed
37
<br /><br />
Jan Möbius's avatar
Jan Möbius committed
38 39

\subpage mesh_docu
Mike Kremer's avatar
Mike Kremer committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

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:

\li \ref mesh_features
\li \ref mesh_hds
\li \ref mesh_iterators
\li \ref mesh_navigation
\li \ref mesh_io
\li \ref mesh_operations
\li \ref mesh_hierarchy

The %OpenMeshTools library that contains some useful tools
for i.e. mesh processing:
    
56
\li \subpage tools_docu
Mike Kremer's avatar
Mike Kremer committed
57 58
    
<br /><br />
Jan Möbius's avatar
Jan Möbius committed
59
\subpage tutorial
60 61 62

This section is supposed to introduce the basic concepts of
%OpenMesh. <!--For detailed information, consult the online documentation
Jan Möbius's avatar
Jan Möbius committed
63
(\subpage mesh_docu ).-->
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

<!--In this tutorial we will introduce the %OpenMesh library by means of
simple examples. The first one just builds a polygonal mesh
representing a cube and writes the result to standard output. The
following examples develop a simple mesh smoother: Recall that the
immediate neighbors of a vertex are called the 1-ring of this
vertex. It is well known that a polygonal mesh can be smoothed by
repeatedly replacing each vertex' position by the center of gravity
(cog) of its 1-ring. The basic smoother will

\li read a polygonal mesh from standard input,
\li compute the cog of the 1-ring of each vertex,
\li replace each vertex' position by its cog and finally,
\li write the mesh to standard output.-->

\li \ref mesh_type
\li \ref tutorial_01
\li \ref tutorial_build
\li \ref tutorial_02
\li \ref tutorial_03
\li \ref tutorial_04
\li \ref tutorial_05
\li \ref tutorial_06
\li \ref tutorial_07
\li \ref tutorial_07b
\li \ref tutorial_08
\li \ref tutorial_09
91

Mike Kremer's avatar
Mike Kremer committed
92
<br /><br />
Jan Möbius's avatar
Jan Möbius committed
93

Jan Möbius's avatar
Jan Möbius committed
94
\subpage additional_information
95 96 97

\li \ref mesh_first_to_read
\li \ref mesh_cpp
98 99
\li \ref mesh_members
\li \ref naming_conventions
100
\li \ref mesh_speedup
Jan Möbius's avatar
Jan Möbius committed
101
\li \ref om_changelog
102

Jan Möbius's avatar
Jan Möbius committed
103 104 105 106 107 108 109 110 111
\page mesh_docu Using and understanding OpenMesh
\li \subpage mesh_features
\li \subpage mesh_hds
\li \subpage mesh_iterators
\li \subpage mesh_navigation
\li \subpage mesh_io
\li \subpage mesh_operations
\li \subpage mesh_hierarchy
\li \subpage mesh_type
112
\li \subpage mesh_eigen
Jan Möbius's avatar
Jan Möbius committed
113

Jan Möbius's avatar
Jan Möbius committed
114

Jan Möbius's avatar
Jan Möbius committed
115 116 117 118 119
\page additional_information Additional Information on OpenMesh
\li \subpage mesh_first_to_read
\li \subpage mesh_cpp
\li \subpage mesh_members
\li \subpage naming_conventions
120
\li \subpage mesh_speedup
Jan Möbius's avatar
Jan Möbius committed
121
\li \subpage om_changelog
Jan Möbius's avatar
Jan Möbius committed
122

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