do not publish remove_degenerate_faces that is not yet ready

This commit is contained in:
Sébastien Loriot 2015-08-27 11:22:42 +02:00
parent bfe03f16eb
commit 9514bcc8fe
5 changed files with 12 additions and 6 deletions

View File

@ -68,8 +68,9 @@ and provides a list of the parameters that are used in this package.
- \link stitching_grp `CGAL::Polygon_mesh_processing::stitch_borders()` \endlink - \link stitching_grp `CGAL::Polygon_mesh_processing::stitch_borders()` \endlink
- `CGAL::Polygon_mesh_processing::polygon_soup_to_polygon_mesh()` - `CGAL::Polygon_mesh_processing::polygon_soup_to_polygon_mesh()`
- `CGAL::Polygon_mesh_processing::orient_polygon_soup()` - `CGAL::Polygon_mesh_processing::orient_polygon_soup()`
<!---
- \link reverse_face_orientations_grp `CGAL::Polygon_mesh_processing::remove_degenerate_faces()` \endlink - \link reverse_face_orientations_grp `CGAL::Polygon_mesh_processing::remove_degenerate_faces()` \endlink
--->
## Normal Computation Functions ## ## Normal Computation Functions ##
- `CGAL::Polygon_mesh_processing::compute_face_normal()` - `CGAL::Polygon_mesh_processing::compute_face_normal()`
- `CGAL::Polygon_mesh_processing::compute_face_normals()` - `CGAL::Polygon_mesh_processing::compute_face_normals()`
@ -93,4 +94,5 @@ It can be made short to PM. And TriangleMesh (or TM) specifies when the paramete
\todo document `BGL/include/CGAL/boost/graph/split_graph_into_polylines.h` \todo document `BGL/include/CGAL/boost/graph/split_graph_into_polylines.h`
\todo add in BGL `clear(pmesh)` and use it in `keep_largest_connected_components(pmesh, 0);` \todo add in BGL `clear(pmesh)` and use it in `keep_largest_connected_components(pmesh, 0);`
\todo document BGL/include/CGAL/boost/graph/Dual.h and remove the example from dont_submit \todo document BGL/include/CGAL/boost/graph/Dual.h and remove the example from dont_submit
\todo fix and restore remove_degenerate_faces in the user and the reference manual
*/ */

View File

@ -260,6 +260,7 @@ with duplicated border edges.
\cgalExample{Polygon_mesh_processing/stitch_borders_example.cpp} \cgalExample{Polygon_mesh_processing/stitch_borders_example.cpp}
******************* *******************
<!---
\subsection DegenerateFaces Removing Degenerate Faces \subsection DegenerateFaces Removing Degenerate Faces
Some degenerate faces may be part of a given triangle mesh. Some degenerate faces may be part of a given triangle mesh.
@ -277,7 +278,7 @@ are removed, the connectivity is fixed, and the number of removed faces
is output. is output.
\cgalExample{Polygon_mesh_processing/remove_degeneracies_example.cpp} \cgalExample{Polygon_mesh_processing/remove_degeneracies_example.cpp}
--->
******************* *******************
\subsection PolygonSoups Polygon Soups \subsection PolygonSoups Polygon Soups
@ -445,7 +446,6 @@ Function or Class | Pure Triangle | Self-Intersection Free
`stitch_borders()` | no | no | no `stitch_borders()` | no | no | no
`polygon_soup_to_polygon_mesh()` | no | no | no `polygon_soup_to_polygon_mesh()` | no | no | no
`orient_polygon_soup()` | no | no | no `orient_polygon_soup()` | no | no | no
`remove_degenerate_faces()` | yes | no | no
`compute_face_normal()` | no | no | no `compute_face_normal()` | no | no | no
`compute_face_normals()` | no | no | no `compute_face_normals()` | no | no | no
`compute_vertex_normal()` | no | no | no `compute_vertex_normal()` | no | no | no
@ -458,6 +458,9 @@ Function or Class | Pure Triangle | Self-Intersection Free
`keep_connected_components()` | no | no | no `keep_connected_components()` | no | no | no
`remove_connected_components()` | no | no | no `remove_connected_components()` | no | no | no
</center> </center>
<!---
`remove_degenerate_faces()` | yes | no | no
--->
**************************************** ****************************************
\section PMPHistory Implementation History \section PMPHistory Implementation History

View File

@ -11,6 +11,5 @@
\example Polygon_mesh_processing/triangulate_polyline_example.cpp \example Polygon_mesh_processing/triangulate_polyline_example.cpp
\example Polygon_mesh_processing/refine_fair_example.cpp \example Polygon_mesh_processing/refine_fair_example.cpp
\example Polygon_mesh_processing/mesh_slicer_example.cpp \example Polygon_mesh_processing/mesh_slicer_example.cpp
\example Polygon_mesh_processing/remove_degeneracies_example.cpp
*/ */

View File

@ -0,0 +1,2 @@
examples/Polygon_mesh_processing/remove_degeneracies_example.cpp
examples/Polygon_mesh_processing/remove_degeneracies_example_OM.cpp

View File

@ -140,7 +140,7 @@ bool is_degenerated(
return is_degenerated(halfedge(fd,tmesh), tmesh, vpmap, traits); return is_degenerated(halfedge(fd,tmesh), tmesh, vpmap, traits);
} }
///\cond SKIP_IN_MANUAL
template <class EdgeRange, class TriangleMesh, class NamedParameters> template <class EdgeRange, class TriangleMesh, class NamedParameters>
std::size_t remove_null_edges( std::size_t remove_null_edges(
const EdgeRange& edge_range, const EdgeRange& edge_range,
@ -464,7 +464,7 @@ std::size_t remove_null_edges(
/// \cgalNamedParamsEnd /// \cgalNamedParamsEnd
/// ///
/// \return number of removed degenerate faces /// \return number of removed degenerate faces
/// /// \endcond
template <class TriangleMesh, class NamedParameters> template <class TriangleMesh, class NamedParameters>
std::size_t remove_degenerate_faces(TriangleMesh& tmesh, std::size_t remove_degenerate_faces(TriangleMesh& tmesh,
const NamedParameters& np) const NamedParameters& np)