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

polish Ridges

This commit is contained in:
Andreas Fabri 2012-12-28 19:01:38 +01:00
parent b71421e326
commit cd838d1ccf
2 changed files with 25 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
Ridges_3/doc/Ridges_3/CGAL/Ridges.h
View File

@ -25,14 +25,13 @@ enum Ridge_type {
/*!
\ingroup PkgRidges_3Functions
The function `compute_crest_ridges` is a shortcut to the method of the same name
The function `compute_crest_ridges()` is a shortcut to the method of the same name
of the class `Ridge_approximation`.
The operator `<<` is overloaded for this class and returns the
line type, strength, sharpness and coordinates of the points of the
polyline.
\sa `Ridge_approximation`
*/
template < class TriangulatedSurfaceMesh,
@ -58,11 +57,9 @@ namespace CGAL {
/*!
\ingroup PkgRidges_3Functions
The function `compute_max_ridges` is a shortcut to the method of the same name
The function `compute_max_ridges()` is a shortcut to the method of the same name
of the class `Ridge_approximation`.
\sa `Ridge_approximation`
*/
template < class TriangulatedSurfaceMesh,
class Vertex2FTPropertyMap,
@ -124,14 +121,14 @@ ridges of a triangular polyhedral surface.
\tparam Vertex2FTPropertyMap, Vertex2VectorPropertyMap provide the differential properties of
the surface associated to its vertices.
Requirements (checked at compile time): the types
`TriangulatedSurfaceMesh::Traits::FT` and
`Vertex2FTPropertyMap::value_type` must coincide; the types
`TriangulatedSurfaceMesh::Traits::Vector_3` and
`Vertex2VectorPropertyMap::value_type` must coincide; the types
`TriangulatedSurfaceMesh::Vertex_handle`,
`Vertex2FTPropertyMap::key_type` and
`Vertex2VectorPropertyMap::key_type` must coincide;
Requirements (checked at compile time):
- the types `TriangulatedSurfaceMesh::Traits::FT` and
`Vertex2FTPropertyMap::value_type` must coincide;
- the types `TriangulatedSurfaceMesh::Traits::Vector_3` and
`Vertex2VectorPropertyMap::value_type` must coincide;
- the types `TriangulatedSurfaceMesh::Vertex_handle`,
`Vertex2FTPropertyMap::key_type` and
`Vertex2VectorPropertyMap::key_type` must coincide;
\sa `Ridge_line`
@ -254,22 +251,22 @@ Ridge_line();
/*!
*/
const Ridge_type line_type();
Ridge_type line_type() const;
/*!
*/
const FT strength();
FT strength() const;
/*!
*/
const FT sharpness();
FT sharpness() const;
/*!
*/
const std::list<Ridge_halfhedge>* line();
const std::list<Ridge_halfhedge>* line() const;
/*!
Writes the line type, strength, sharpness and coordinates of the

23
Ridges_3/doc/Ridges_3/CGAL/Umbilics.h
View File

@ -14,7 +14,6 @@ enum Umbilic_type { NON_GENERIC_UMBILIC, ELLIPTIC_UMBILIC, HYPERBOLIC_UMBILIC };
The function `compute_umbilics` is a shortcut to the method `compute` of
the class `Umbilic_approximation`.
\sa `Umbilic_approximation`
*/
template < class TriangulatedSurfaceMesh,
@ -44,14 +43,14 @@ umbilics on a triangular polyhedral surface.
\tparam Vertex2FTPropertyMap, Vertex2VectorPropertyMap provide
the differential properties of the surface associated to its vertices.
Requirements (checked at compile time) : the types
`TriangulatedSurfaceMesh::Traits::FT` and
`Vertex2FTPropertyMap::value_type` must coincide; the types
`TriangulatedSurfaceMesh::Traits::Vector_3` and
`Vertex2VectorPropertyMap::value_type` must coincide; the types
`TriangulatedSurfaceMesh::Vertex_handle`,
`Vertex2FTPropertyMap::key_type` and
`Vertex2VectorPropertyMap::key_type` must coincide;
Requirements (checked at compile time) :
- the types `TriangulatedSurfaceMesh::Traits::FT` and
`Vertex2FTPropertyMap::value_type` must coincide;
- the types `TriangulatedSurfaceMesh::Traits::Vector_3` and
`Vertex2VectorPropertyMap::value_type` must coincide;
- the types `TriangulatedSurfaceMesh::Vertex_handle`,
`Vertex2FTPropertyMap::key_type` and
`Vertex2VectorPropertyMap::key_type` must coincide;
\sa `Umbilic`
\sa `TriangulatedSurfaceMesh`
@ -142,17 +141,17 @@ typedef typename TriangulatedSurfaceMesh::Halfedge_handle Halfedge_handle;
/*!
*/
const Vertex_handle vertex();
Vertex_handle vertex() const;
/*!
*/
const Umbilic_type umbilic_type();
Umbilic_type umbilic_type() const;
/*!
*/
const std::list<Halfedge_handle>& contour_list() ;
const std::list<Halfedge_handle>& contour_list()const;
/// @}