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

Doc.

This commit is contained in:
Maxime Gimeno 2020-01-28 13:45:27 +01:00
parent 0de28e84ff
commit a8820c69a9
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h
View File

@ -1,26 +1,26 @@
//!
//!\ingroup PkgSurfaceMeshSimplificationConcepts
//!\cgalConcept
//!
//!The concept `GetPlacement` describes the requirements for the <I>policy
//!function object</I> which gets the <I>collapse placement</I> of an edge,
//!that is, the new position of the vertex that remains after a
//!halfedge-collapse operation.
//!
//!The placement returned is a `boost::optional` value (i.e., it can
//!be absent). An absent result indicates that the edge should not be collapsed.
//!This could be the result of a computational limitation (such as an overflow),
//!or can be intentionally returned to prevent the edge from being collapsed.
//!
//!\cgalRefines `DefaultConstructible`
//!\cgalRefines `CopyConstructible`
//!
//!\cgalHasModel `CGAL::Surface_mesh_simplification::Midpoint_placement<TriangleMesh>`
//!\cgalHasModel `CGAL::Surface_mesh_simplification::LindstromTurk_placement<TriangleMesh>`
//!\cgalHasModel `CGAL::Surface_mesh_simplification::GarlandHeckbert_policies<TriangleMesh, GeomTraits>`
//\cgalHasModel `CGAL::Surface_mesh_simplification::Bounded_distance_placement<Placement>`
//!\cgalHasModel `CGAL::Surface_mesh_simplification::Bounded_normal_change_placement<Placement>`
//!\cgalHasModel `CGAL::Surface_mesh_simplification::Constrained_placement<Placement>`
/*!
\ingroup PkgSurfaceMeshSimplificationConcepts
\cgalConcept
The concept `GetPlacement` describes the requirements for the <I>policy
function object</I> which gets the <I>collapse placement</I> of an edge,
that is, the new position of the vertex that remains after a
halfedge-collapse operation.
The placement returned is a `boost::optional` value (i.e., it can
be absent). An absent result indicates that the edge should not be collapsed.
This could be the result of a computational limitation (such as an overflow),
or can be intentionally returned to prevent the edge from being collapsed.
\cgalRefines `DefaultConstructible`
\cgalRefines `CopyConstructible`
\cgalHasModel `CGAL::Surface_mesh_simplification::Midpoint_placement<TriangleMesh>`
\cgalHasModel `CGAL::Surface_mesh_simplification::LindstromTurk_placement<TriangleMesh>`
\cgalHasModel `CGAL::Surface_mesh_simplification::GarlandHeckbert_policies<TriangleMesh, GeomTraits>`
\cgalHasModel `CGAL::Surface_mesh_simplification::Bounded_normal_change_placement<Placement>`
\cgalHasModel `CGAL::Surface_mesh_simplification::Constrained_placement<Placement>`
*/
class GetPlacement