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

documentation : TriangleMesh is a "triangulated surface mesh"

This commit is contained in:
Jane Tournois 2015-04-03 14:53:18 +02:00
parent 01d32e4101
commit 2e038ca831
5 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Polygon_mesh_processing/include/CGAL/Point_inside_polygon_mesh.h
View File

@ -39,8 +39,8 @@ namespace CGAL {
* if an odd number of surfaces is crossed when walking from the point to infinity.
*
* This class depends on the package \ref PkgAABB_treeSummary.
* @tparam TriangleMesh a triangulated polyhedral surface, a model of `FaceListGraph`
*
* @tparam TriangleMesh a triangulated surface mesh, model of `FaceListGraph`
* @tparam GeomTraits a geometric traits class, model of `Kernel`
* @tparam VertexPointMap a model of `ReadablePropertyMap` with
`boost::graph_traits<TriangleMesh>::%vertex_descriptor` as key type and
@ -71,8 +71,8 @@ class Point_inside_polygon_mesh
public:
/**
* Constructor with one surface triangle mesh.
* @param tmesh the triangle mesh bounding the domain to be tested
* Constructor with one triangulated surface mesh.
* @param tmesh the triangulated surface mesh bounding the domain to be tested
* @param vpmap the property map with the points associated to the vertices of `tmesh`
* @param gt an instance of the geometric traits class
*
@ -96,7 +96,7 @@ public:
/**
* Constructor with one surface triangle mesh, using `get(boost::vertex_point, tmesh)` as
* vertex point property map.
* @param tmesh the triangle mesh bounding the domain to be tested
* @param tmesh the triangulated surface mesh bounding the domain to be tested
* @param gt an instance of the geometric traits class
*
* @pre `CGAL::is_closed(tmesh) && CGAL::is_pure_triangle(tmesh)`
@ -117,7 +117,7 @@ public:
/**
* Constructor that takes a pre-built \cgal `AABB_tree`
* of the triangle mesh primitives.
* of the triangulated surface mesh primitives.
*
* @param tree a \cgal `AABB_tree` with `AABB_face_graph_triangle_primitive` as `Primitive` type
* @param gt an instance of the geometric traits class

4
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/repair.h
View File

@ -233,7 +233,7 @@ namespace internal {
} // end of namespace internal
/// \ingroup PkgPolygonMeshProcessing
/// removes the degenerate faces from a triangle mesh.
/// removes the degenerate faces from a triangulated surface mesh.
///
/// @pre `CGAL::is_pure_triangle(tmesh)`
///
@ -241,7 +241,7 @@ namespace internal {
/// that has an internal property map for `boost::vertex_point_t`
/// @tparam NamedParameters a sequence of \ref namedparameters
///
/// @param tmesh the triangle mesh to be repaired
/// @param tmesh the triangulated surface mesh to be repaired
/// @param np optional \ref namedparameters described below
///
/// \cgalNamedParamsBegin

4
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/self_intersections.h
View File

@ -214,7 +214,7 @@ self_intersections( const FaceRange& face_range,
* `std::pair<boost::graph_traits<TriangleMesh>::%face_descriptor, boost::graph_traits<TriangleMesh>::%face_descriptor>`
* @tparam NamedParameters a sequence of \ref namedparameters
*
* @param tmesh triangle mesh to be checked
* @param tmesh the triangulated surface mesh to be checked
* @param out output iterator to be filled with all pairs of non-adjacent faces that intersect
* @param np optional sequence of \ref namedparameters among the ones listed below
*
@ -344,7 +344,7 @@ OutputIterator self_intersections(const FaceRange& face_range,
* `std::pair<boost::graph_traits<TriangleMesh>::%face_descriptor, boost::graph_traits<TriangleMesh>::%face_descriptor>`
* @tparam NamedParameters a sequence of \ref namedparameters
*
* @param tmesh triangle mesh to be tested
* @param tmesh the triangulated surface mesh to be tested
* @param np optional sequence of \ref namedparameters among the ones listed below
*
* \cgalNamedParamsBegin

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h
View File

@ -225,7 +225,7 @@ public:
/**
* \ingroup PkgPolygonMeshProcessing
* triangulates faces of the polygon mesh `pmesh`. This function depends on the package \ref PkgTriangulation2Summary
* triangulates faces of a polygon mesh. This function depends on the package \ref PkgTriangulation2Summary
* @tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* that has an internal property map for `boost::vertex_point_t`
* @tparam NamedParameters a sequence of \ref namedparameters

6
Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h
View File

@ -44,9 +44,9 @@ namespace CGAL {
/// Function object that can compute the intersection of planes with
/// a triangulated surface mesh.
///
/// \tparam TriangleMesh triangulated surface mesh. It must be a model of `FaceGraph` and `HalfedgeListGraph`
/// \tparam Traits must be a model of `AABBGeomTraits`
/// \tparam VertexPointMap is a model of `ReadablePropertyMap` with
/// \tparam TriangleMesh a triangulated surface mesh, model of `FaceGraph` and `HalfedgeListGraph`
/// \tparam Traits a model of `AABBGeomTraits`
/// \tparam VertexPointMap a model of `ReadablePropertyMap` with
/// `boost::graph_traits<TriangleMesh>::%vertex_descriptor` as key and
/// `Traits::Point_3` as value type.
/// The default is `typename boost::property_map< TriangleMesh, vertex_point_t>::%type`.