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

Minor doc improvements

This commit is contained in:
Mael Rouxel-Labbé 2018-01-29 21:53:45 +01:00
parent e803d7d5d0
commit bf21e2bd4b
3 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Orbifold_Tutte_parameterizer_3.h
View File

@ -202,8 +202,8 @@ Error_code read_cones(const TriangleMesh& pm, const char* filename, ConeOutputIn
/// parameters of the class CGAL::Seam_mesh).
/// \tparam ConeInputBidirectionalIterator must be a model of `BidirectionalIterator`
/// with value type `boost::graph_traits<SeamMesh::TriangleMesh>::%vertex_descriptor`.
/// \tparam ConeMap must be a model of `AssociativeContainer` with
/// `boost::graph_traits<SeamMesh>::%vertex_descriptor` as key type and
/// \tparam ConeMap must be a model of <a href="http://en.cppreference.com/w/cpp/concept/AssociativeContainer"><tt>AssociativeContainer</tt></a>
/// with `boost::graph_traits<SeamMesh>::%vertex_descriptor` as key type and
/// \link PkgSurfaceParameterizationEnums Cone_type \endlink as value type.
///
/// \param mesh the seam mesh
@ -893,9 +893,9 @@ public:
/// The mapping is piecewise linear (linear in each triangle).
/// The result is the (u,v) pair image of each vertex of the 3D surface.
///
/// \tparam ConeMap must be a model of `AssociativeContainer` with key type
/// `boost::graph_traits<Seam_mesh>::%vertex_descriptor` and
/// \link PkgSurfaceParameterizationEnums Cone_type \endlink as value type.
/// \tparam ConeMap must be a model of <a href="http://en.cppreference.com/w/cpp/concept/AssociativeContainer"><tt>AssociativeContainer</tt></a>
/// with key type `boost::graph_traits<Seam_mesh>::%vertex_descriptor` and
/// \link PkgSurfaceParameterizationEnums Cone_type \endlink as value type.
/// \tparam VertexUVmap must be a model of `ReadWritePropertyMap` with
/// `boost::graph_traits<Seam_mesh>::%vertex_descriptor` as key type and
/// %Point_2 (type deduced from `Seam_mesh` using `Kernel_traits`)

6
Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_enums.h
View File

@ -45,9 +45,9 @@ enum Weight_type
/// A classification type for the cones used in Orbifold Tutte parameterization.
enum Cone_type
{
First_unique_cone = 0, ///< marker for the cone found at the beginning of the seam.
Second_unique_cone, ///< marker for the cone found at the end of the seam.
Duplicated_cone ///< marker for all the other cones. Cones are duplicated in the sense
First_unique_cone = 0, ///< Marker for the cone found at the beginning of the seam.
Second_unique_cone, ///< Marker for the cone found at the end of the seam.
Duplicated_cone ///< Marker for all the other cones. Cones are duplicated in the sense
/// that when the seam is "opened", the cone appears
/// at two different positions.
};

19
Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_shortest_path.h
View File

@ -106,18 +106,19 @@ public:
/// \ingroup PkgSurfaceParameterizationOrbifoldHelperFunctions
///
/// Compute the shortest path between `source` and `target` over `mesh`, using
/// a Dijkstra algorithm.
/// <a href="http://www.boost.org/doc/libs/1_55_0/libs/graph/doc/dijkstra_shortest_paths.html">
/// boost::dijkstra_shortest_paths()</a>.
///
/// \tparam TriangleMesh A triangle mesh, model of `FaceListGraph` and `HalfedgeListGraph`.
/// \tparam EdgeOutputIterator A model of `OutputIterator` with value type
/// `boost::graph_traits<TriangleMesh>::edge_descriptor`.
/// `boost::graph_traits<TriangleMesh>::%edge_descriptor`.
///
/// \param tm the triangular mesh to be parameterized
/// \param mesh the triangular mesh to be parameterized
/// \param source, target the extremities of the path to be computed
/// \param oi the output iterator
///
/// \pre `source` and `target` are vertices of `mesh`.
/// \pre `source != target`.
/// \pre `source != target`
template<typename TriangleMesh, typename EdgeOutputIterator>
void compute_shortest_paths_between_two_cones(const TriangleMesh& mesh,
typename boost::graph_traits<TriangleMesh>::vertex_descriptor source,
@ -169,15 +170,15 @@ void compute_shortest_paths_between_two_cones(const TriangleMesh& mesh,
///
/// \tparam TriangleMesh A triangle mesh, model of `FaceListGraph` and `HalfedgeListGraph`.
/// \tparam InputConesForwardIterator A model of `ForwardIterator` with value type
/// `boost::graph_traits<TriangleMesh>::vertex_descriptor`.
/// \tparam SeamContainer A model of `SequenceContainer` with value type `boost::graph_traits<TriangleMesh>::edge_descriptor`.
/// `boost::graph_traits<TriangleMesh>::%vertex_descriptor`.
/// \tparam SeamContainer A model of <a href="http://en.cppreference.com/w/cpp/concept/SequenceContainer"><tt>SequenceContainer</tt></a>
/// with value type `boost::graph_traits<TriangleMesh>::%edge_descriptor`.
///
/// \param mesh the triangular mesh on which paths are computed
/// \param first, beyond the cones, which form the extremities of the path
/// \param first, beyond a range of cones
/// \param seams a container that will store the paths, as a sequence of edges of the mesh.
///
/// \pre `source` and `target` are vertices of `mesh`.
/// \pre `source != target`.
/// \pre `std::distance(first,beyond) > 1`
template<typename TriangleMesh, typename InputConesForwardIterator, typename SeamContainer>
void compute_shortest_paths_between_cones(const TriangleMesh& mesh,
InputConesForwardIterator first, InputConesForwardIterator beyond,