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

add info about mandatory internal property map

This commit is contained in:
Jane Tournois 2015-04-01 18:01:33 +02:00
parent 0f2ea23737
commit 49e14815d4
8 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/compute_normal.h
View File

@ -61,7 +61,7 @@ void sum_normals(const PM& pmesh,
/**
* \ingroup PkgPolygonMeshProcessing
* computes the outward unit vector normal to face `f`.
* @tparam PolygonMesh a model of `FaceGraph` that has a property map
* @tparam PolygonMesh a model of `FaceGraph` that has an internal property map
* for `CGAL::vertex_point_t`
* @tparam NamedParameters a sequence of \ref namedparameters
*
@ -108,7 +108,7 @@ compute_face_normal(typename boost::graph_traits<PolygonMesh>::face_descriptor f
/**
* \ingroup PkgPolygonMeshProcessing
* computes the outward unit vector normal for all faces of the polygon mesh.
* @tparam PolygonMesh a model of `FaceGraph` that has a property map
* @tparam PolygonMesh a model of `FaceGraph` that has an internal property map
* for `CGAL::vertex_point_t`
* @tparam FaceNormalMap a model of `WritablePropertyMap` with
`boost::graph_traits<PolygonMesh>::%face_descriptor` as key type and
@ -145,7 +145,7 @@ compute_face_normals(const PolygonMesh& pmesh
/**
* \ingroup PkgPolygonMeshProcessing
* computes the unit normal at vertex `v` as the average of the normals of incident faces.
* @tparam PolygonMesh a model of `FaceGraph` that has a property map
* @tparam PolygonMesh a model of `FaceGraph` that has an internal property map
* for `CGAL::vertex_point_t`
*
* @param v the vertex at which the normal is computed
@ -198,7 +198,7 @@ compute_vertex_normal(typename boost::graph_traits<PolygonMesh>::vertex_descript
/**
* \ingroup PkgPolygonMeshProcessing
* computes the outward unit vector normal for all vertices of the polygon mesh.
* @tparam PolygonMesh a model of `FaceListGraph` that has a property map
* @tparam PolygonMesh a model of `FaceListGraph` that has an internal property map
* for `CGAL::vertex_point_t`
* @tparam VertexNormalMap a model of `WritablePropertyMap` with
`boost::graph_traits<PolygonMesh>::%vertex_descriptor` as key type and
@ -238,7 +238,7 @@ compute_vertex_normals(const PolygonMesh& pmesh
/**
* \ingroup PkgPolygonMeshProcessing
* computes the outward unit vector normal for all vertices and faces of the polygon mesh.
* @tparam PolygonMesh a model of `FaceListGraph` that has a property map
* @tparam PolygonMesh a model of `FaceListGraph` that has an internal property map
* for `CGAL::vertex_point_t`
* @tparam VertexNormalMap a model of `WritablePropertyMap` with
`boost::graph_traits<PolygonMesh>::%vertex_descriptor` as key type and

1
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/fair.h
View File

@ -68,6 +68,7 @@ namespace internal {
Fairing might fail if fixed vertices, which are used as boundary conditions, do not suffice to solve constructed linear system.
@tparam PolygonMesh a model of `FaceGraph`
that has an internal property map for `CGAL::vertex_point_t`
@tparam VertexRange a range of vertex descriptors of `PolygonMesh`, model of `SinglePassRange`
@tparam NamedParameters a sequence of \ref namedparameters

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

@ -67,7 +67,7 @@ namespace internal{
* that is the answer to this predicate would be the same if called on each
* isolated connected component.
*
* @tparam PolygonMesh a model of `FaceListGraph` that has a property map
* @tparam PolygonMesh a model of `FaceListGraph` that has an internal property map
* for `boost::vertex_point_t`
* @tparam NamedParameters a sequence of \ref namedparameters
*

1
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/refine.h
View File

@ -35,6 +35,7 @@ namespace Polygon_mesh_processing {
@brief refines a region of a polygon mesh
@tparam PolygonMesh model of `MutableFaceGraph`
that has an internal property map for `CGAL::vertex_point_t`
@tparam FaceRange range of face descriptors, model of `SinglePassRange`
@tparam FaceOutputIterator model of `OutputIterator`
holding `boost::graph_traits<PolygonMesh>::%face_descriptor` for patch faces

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

@ -238,7 +238,7 @@ namespace internal {
/// @pre `CGAL::is_pure_triangle(tmesh)`
///
/// @tparam TriangleMesh a model of `FaceListGraph` and `MutableFaceGraph`
/// that has a property map for `boost::vertex_point_t`
/// 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

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

@ -207,7 +207,7 @@ self_intersections( const FaceRange& face_range,
* This function depends on the package \ref PkgBoxIntersectionDSummary
* @pre `CGAL::is_pure_triangle(tmesh)`
*
* @tparam TriangleMesh a model of `FaceListGraph` that has a property map
* @tparam TriangleMesh a model of `FaceListGraph` that has an internal property map
* for `CGAL::vertex_point_t`
* @tparam OutputIterator a model of `OutputIterator` holding objects of type
* `std::pair<boost::graph_traits<TriangleMesh>::%face_descriptor, boost::graph_traits<TriangleMesh>::%face_descriptor>`
@ -340,7 +340,7 @@ OutputIterator self_intersections(const FaceRange& face_range,
* This function depends on the package \ref PkgBoxIntersectionDSummary
* @pre `CGAL::is_pure_triangle(tmesh)`
*
* @tparam TriangleMesh a model of `FaceListGraph` that has a property map
* @tparam TriangleMesh a model of `FaceListGraph` that has an internal property map
* for `CGAL::vertex_point_t`
* @tparam OutputIterator a model of `OutputIterator` holding objects of type
* `std::pair<boost::graph_traits<TriangleMesh>::%face_descriptor, boost::graph_traits<TriangleMesh>::%face_descriptor>`

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

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

3
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_hole.h
View File

@ -43,6 +43,7 @@ namespace Polygon_mesh_processing {
If a hole cannot be triangulated, `pmesh` is not modified and nothing is put in `out`.
@tparam PolygonMesh a model of `MutableFaceGraph`
that has an internal property map for `CGAL::vertex_point_t`
@tparam OutputIterator a model of `OutputIterator`
holding `boost::graph_traits<PolygonMesh>::%face_descriptor` for patch faces.
@tparam NamedParameters a sequence of \ref namedparameters
@ -114,6 +115,7 @@ namespace Polygon_mesh_processing {
@brief triangulates and refines a hole in a polygon mesh.
@tparam PolygonMesh must be model of `MutableFaceGraph`
that has an internal property map for `CGAL::vertex_point_t`
@tparam FacetOutputIterator model of `OutputIterator`
holding `boost::graph_traits<PolygonMesh>::%face_descriptor` for patch faces.
@tparam VertexOutputIterator model of `OutputIterator`
@ -179,6 +181,7 @@ namespace Polygon_mesh_processing {
@brief triangulates, refines and fairs a hole in a polygon mesh.
@tparam PolygonMesh a model of `MutableFaceGraph`
that has an internal property map for `CGAL::vertex_point_t`
@tparam FaceOutputIterator model of `OutputIterator`
holding `boost::graph_traits<PolygonMesh>::%face_descriptor` for patch faces
@tparam VertexOutputIterator model of `OutputIterator`