cgal/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt

43 lines
1.7 KiB
Plaintext

/// \defgroup PkgSkinSurface3Ref Reference Manual
/// \defgroup PkgSkinSurface3Concepts Concepts
/// \ingroup PkgSkinSurface3Ref
/*!
\addtogroup PkgSkinSurface3Ref
\cgalPkgDescriptionBegin{3D Skin Surface Meshing,PkgSkinSurface3}
\cgalPkgPicture{small.png}
\cgalPkgSummaryBegin
\cgalPkgAuthor{Nico Kruithof}
\cgalPkgDesc{This package allows to build a triangular mesh of a skin surface. Skin surfaces are used for modeling large molecules in biological computing. The surface is defined by a set of balls, representing the atoms of the molecule, and a shrink factor that determines the size of the smooth patches gluing the balls together. The construction of a triangular mesh of a smooth skin surface is often necessary for further analysis and for fast visualization. This package provides functions to construct a triangular mesh approximating the skin surface from a set of balls and a shrink factor. It also contains code to subdivide the mesh efficiently. }
\cgalPkgManuals{Chapter_3D_Skin_Surface_Meshing,PkgSkinSurface3Ref}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgTriangulation3 and \ref PkgPolyhedron}
\cgalPkgBib{cgal:k-ssm3}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
\cgalCRPSection{Concepts}
- `SkinSurface_3`
- `SkinSurfaceTraits_3`
\cgalCRPSection{Classes}
- `CGAL::Skin_surface_3<SkinSurfaceTraits_3>`
- `CGAL::Union_of_balls_3<SkinSurfaceTraits_3>`
- `CGAL::Skin_surface_traits_3<K>`
\cgalCRPSection{Functions}
- `CGAL::make_skin_surface_mesh_3<Polyhedron_3>()`
- `CGAL::mesh_skin_surface_3<SkinSurface_3, Polyhedron_3>()`
- `CGAL::subdivide_skin_surface_mesh_3<SkinSurface_3, Polyhedron_3>()`
*/