cgal/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt

47 lines
2.0 KiB
Plaintext

/// \defgroup PkgMeanCurvatureSkeleton3 Triangulated Surface Mesh Skeletonization Reference
/// \defgroup PkgMeanCurvatureSkeleton3Concepts Concepts
/// \ingroup PkgMeanCurvatureSkeleton3
/*!
\addtogroup PkgMeanCurvatureSkeleton3
\cgalPkgDescriptionBegin{Triangulated Surface Mesh Skeletonization,PkgMeanCurvatureSkeleton3Summary}
\cgalPkgPicture{mcfskel-small.png}
\cgalPkgSummaryBegin
\cgalPkgAuthor{Xiang Gao, Sébastien Loriot and Andrea Tagliasacchi}
\cgalPkgDesc{This package provides a (1D) curve skeleton extraction algorithm for a triangulated polygonal mesh without borders based on the mean curvature flow.
The particularity of this skeleton is that it captures the topology of the input.
For each skeleton vertex one can obtain its location and its corresponding vertices from the input mesh.
The code is generic and works with any model of the `FaceListGraph`
concept.
}
\cgalPkgManuals{Chapter_3D_Surface_mesh_skeletonization,PkgMeanCurvatureSkeleton3}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{4.7}
\cgalPkgDependsOn{Sparse symmetric solver such as those from \ref thirdpartyEigen}
\cgalPkgBib{cgal:glt-tsms}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{See Polyhedral Surface,polyhedron_3.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
## Concepts ##
- `MeanCurvatureSkeletonizationTraits`
- `NormalEquationSparseLinearAlgebraTraits_d`
## Classes ##
- `CGAL::Mean_curvature_flow_skeletonization`
\todo code: implement the random sampling of surface using the work started by Alexandru during its gsoc to get a better approximation of poles
\todo code: expose in polygon mesh processing the function to compute the voronoi pole of a close triangle mesh
\todo code: expose in polygon mesh processing the function to remesh locally a triangle mesh with the angle and edge length parameters
\todo code: expose in polygon mesh processing the function compute the surface area of a polygon mesh
\todo code: avoid using EPEC for the triangulation
*/