mirror of https://github.com/CGAL/cgal
Add the example to the user manual
This commit is contained in:
parent
7259e3d1e2
commit
e03c51efc3
|
|
@ -53,7 +53,9 @@ elements can be added and removed to the `Surface_mesh` through a
|
||||||
set of low-level functions which do not maintain connectivity. One
|
set of low-level functions which do not maintain connectivity. One
|
||||||
exception is `Surface_mesh::add_face()`, which tries to add a new
|
exception is `Surface_mesh::add_face()`, which tries to add a new
|
||||||
face to the mesh (defined by a sequence of vertices), and fails if the
|
face to the mesh (defined by a sequence of vertices), and fails if the
|
||||||
operation is not topologically valid.
|
operation is not topologically valid. In that case, the returned
|
||||||
|
`Face_index` is `Surface_mesh::null_face()`.
|
||||||
|
|
||||||
|
|
||||||
\code
|
\code
|
||||||
typedef Surface_mesh<Point> Mesh;
|
typedef Surface_mesh<Point> Mesh;
|
||||||
|
|
@ -73,6 +75,13 @@ do not have member functions to access connectivity or properties.
|
||||||
The functions of the `Surface_mesh` instance from which
|
The functions of the `Surface_mesh` instance from which
|
||||||
they were created must be used to obtain this information.
|
they were created must be used to obtain this information.
|
||||||
|
|
||||||
|
\subsection usage_example Example
|
||||||
|
|
||||||
|
The following example shows how to create a very simple `Surface_mesh`
|
||||||
|
by adding 2 faces, and how to check that a face is correctly added
|
||||||
|
to the mesh.
|
||||||
|
|
||||||
|
\cgalExample{Surface_mesh/sm_check_wrong_orientation.cpp}
|
||||||
\section sectionSurfaceMeshConnectivity Connectivity
|
\section sectionSurfaceMeshConnectivity Connectivity
|
||||||
|
|
||||||
A surface mesh is an edge-centered data structure capable of
|
A surface mesh is an edge-centered data structure capable of
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
/*!
|
/*!
|
||||||
|
\example Surface_mesh/sm_check_wrong_orientation.cpp
|
||||||
\example Surface_mesh/sm_iterators.cpp
|
\example Surface_mesh/sm_iterators.cpp
|
||||||
\example Surface_mesh/sm_circulators.cpp
|
\example Surface_mesh/sm_circulators.cpp
|
||||||
\example Surface_mesh/sm_properties.cpp
|
\example Surface_mesh/sm_properties.cpp
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,3 @@
|
||||||
#include <vector>
|
|
||||||
|
|
||||||
|
|
||||||
#include <CGAL/Simple_cartesian.h>
|
#include <CGAL/Simple_cartesian.h>
|
||||||
#include <CGAL/Surface_mesh.h>
|
#include <CGAL/Surface_mesh.h>
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue