songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update table and categories

This commit is contained in:
Sébastien Loriot 2015-06-26 08:58:16 +02:00
parent c1aee7307e
commit bde6c708db
2 changed files with 35 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt
View File

@ -71,13 +71,15 @@ and provides a list of the parameters that are used in this package.
- `CGAL::Polygon_mesh_processing::compute_vertex_normals()`
- `CGAL::Polygon_mesh_processing::compute_normals()`
## Other Classes and Functions ##
- `CGAL::Polygon_mesh_slicer`
## Connected Components
- `CGAL::Polygon_mesh_processing::connected_component()`
- `CGAL::Polygon_mesh_processing::connected_components()`
- `CGAL::Polygon_mesh_processing::keep_largest_connected_components()`
- `CGAL::Polygon_mesh_processing::keep_connected_components()`
## Miscellaneous ##
- `CGAL::Polygon_mesh_slicer`
\todo make template parameter names uniform in other packages using BGL. Here we chose PolygonMesh as template parameter.
It can be made short to PM. And TriangleMesh (or TM) specifies when the parameter should be a triangle mesh.
\todo document `BGL/include/CGAL/boost/graph/selection.h`

63
Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt
View File

@ -418,7 +418,7 @@ the propagation of a connected component index to cross it.
\cgalExample{Polygon_mesh_processing/connected_components_example.cpp}
****************************************
\section PMPAll Requirements summary
\section PMPAll Requirements Summary
The table below recapitulates the basic requirements of each function of this package.
For each requirement, the table answers a question :
@ -426,37 +426,36 @@ For each requirement, the table answers a question :
- should the input mesh have the topology of a 2-manifold?
- should the input mesh be self-intersection free?
- should the input mesh be closed (with no boundary)?
Requirements | pure triangle | 2-manifold | self-intersection free| closed
------------------------------------- | -------------- | -----------|-----------------------|--------
`fair()` | no | ?? | ?? | no
`refine()` | no | ?? | ?? | no
`triangulate_faces()` | no | no | no | no
`triangulate_hole()` | no | no | no | no
`triangulate_and_refine_hole()` | no | no | no | no
`triangulate_refine_and_fair_hole()` | no | no | no | no
`triangulate_hole_polyline()` | no | no | no | no
`does_self_intersect()` | yes | no | no | no
`self_intersections()` | yes | no | no | no
`Side_of_triangle_mesh` | yes | yes? | yes | yes
`is_outward_oriented()` | no | yes | ?? | yes
`reverse_face_orientations()` | no | no | no | no
`stitch_borders()` | no | yes | no | no
`polygon_soup_to_polygon_mesh()` | no | no | no | no
`orient_polygon_soup()` | no | no | no | no
`remove_degenerate_faces()` | yes | yes | no | no
`compute_face_normal()` | no | no | no | no
`compute_face_normals()` | no | no | no | no
`compute_vertex_normal()` | no | yes? | no | no
`compute_vertex_normals()` | no | yes? | no | no
`compute_normals()` | no | yes? | no | no
`Polygon_mesh_slicer` | yes | no? | yes? | no
`connected_component()` | no | no | no | no
`connected_components()` | no | no | no | no
`keep_largest_connected_components()` | no | no | no | no
`keep_connected_components()` | no | no | no | no
<center>
Function or Class | Pure Triangle | 2-manifold | Self-Intersection Free | Closed
:------------------------------------ | :------------: | :--------: | :--------------------: | :-------:
`fair()` | no | no | no | no
`refine()` | no | no | no | no
`triangulate_faces()` | no | no | no | no
`triangulate_hole()` | no | no | no | no
`triangulate_and_refine_hole()` | no | no | no | no
`triangulate_refine_and_fair_hole()` | no | no | no | no
`triangulate_hole_polyline()` | no | no | no | no
`does_self_intersect()` | yes | no | no | no
`self_intersections()` | yes | no | no | no
`Side_of_triangle_mesh` | yes | no | yes | yes
`is_outward_oriented()` | no | yes | no | yes
`reverse_face_orientations()` | no | no | no | no
`stitch_borders()` | no | yes | no | no
`polygon_soup_to_polygon_mesh()` | no | no | no | no
`orient_polygon_soup()` | no | no | no | no
`remove_degenerate_faces()` | yes | yes | no | no
`compute_face_normal()` | no | no | no | no
`compute_face_normals()` | no | no | no | no
`compute_vertex_normal()` | no | yes? | no | no
`compute_vertex_normals()` | no | yes? | no | no
`compute_normals()` | no | yes? | no | no
`Polygon_mesh_slicer` | yes | yes | yes | no
`connected_component()` | no | no | no | no
`connected_components()` | no | no | no | no
`keep_largest_connected_components()` | no | no | no | no
`keep_connected_components()` | no | no | no | no
</center>
****************************************
\section PMPHistory Implementation History