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

Undocument

This commit is contained in:
Maxime Gimeno 2020-01-28 12:42:06 +01:00
parent 3df376ed83
commit 0de28e84ff
3 changed files with 36 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_distance_placement.h
View File

@ -2,7 +2,7 @@
namespace CGAL { namespace CGAL {
namespace Surface_mesh_simplification { namespace Surface_mesh_simplification {
/*! /*
\ingroup PkgSurfaceMeshSimplificationRef \ingroup PkgSurfaceMeshSimplificationRef
The class `Bounded_distance_placement` is a model for the concept `GetPlacement`. The class `Bounded_distance_placement` is a model for the concept `GetPlacement`.
@ -28,27 +28,27 @@ class Bounded_distance_placement
: public BasePlacement : public BasePlacement
{ {
public: public:
/// //
typedef typename GeomTraits::FT FT; typedef typename GeomTraits::FT FT;
/// \name Creation // \name Creation
/// //
/// @{ // @{
/// The distance bound `d` is used to control that during simplification, // The distance bound `d` is used to control that during simplification,
/// no vertex has a distance to the input that would be greater than `d`. // no vertex has a distance to the input that would be greater than `d`.
Bounded_distance_placement(const FT d, const BasePlacement& base_placement = BasePlacement()); Bounded_distance_placement(const FT d, const BasePlacement& base_placement = BasePlacement());
/// @} // @}
/// \name Operations // \name Operations
/// @{ // @{
/// Returns the placement computed by `base_placement`, provided the distance between the input // Returns the placement computed by `base_placement`, provided the distance between the input
/// and this placement is smaller than `d`. Otherwise, nothing is returned. // and this placement is smaller than `d`. Otherwise, nothing is returned.
boost::optional<typename Edge_profile::Point> operator()(const Edge_profile& profile) const; boost::optional<typename Edge_profile::Point> operator()(const Edge_profile& profile) const;
/// @} // @}
}; };
} // namespace Surface_Mesh_Simplification } // namespace Surface_Mesh_Simplification

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

@ -1,28 +1,28 @@
/*! //!
\ingroup PkgSurfaceMeshSimplificationConcepts //!\ingroup PkgSurfaceMeshSimplificationConcepts
\cgalConcept //!\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>`
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>`
*/
class GetPlacement class GetPlacement
{ {
public: public:

1
Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt
View File

@ -43,7 +43,6 @@
- `CGAL::Surface_mesh_simplification::LindstromTurk_cost<TriangleMesh>` - `CGAL::Surface_mesh_simplification::LindstromTurk_cost<TriangleMesh>`
- `CGAL::Surface_mesh_simplification::LindstromTurk_placement<TriangleMesh>` - `CGAL::Surface_mesh_simplification::LindstromTurk_placement<TriangleMesh>`
- `CGAL::Surface_mesh_simplification::GarlandHeckbert_policies<TriangleMesh, GeomTraits>` - `CGAL::Surface_mesh_simplification::GarlandHeckbert_policies<TriangleMesh, GeomTraits>`
- `CGAL::Surface_mesh_simplification::Bounded_distance_placement<Placement, GeomTraits>`
- `CGAL::Surface_mesh_simplification::Bounded_normal_change_placement<Placement>` - `CGAL::Surface_mesh_simplification::Bounded_normal_change_placement<Placement>`
- `CGAL::Surface_mesh_simplification::Constrained_placement<Placement, TriangleMesh>` - `CGAL::Surface_mesh_simplification::Constrained_placement<Placement, TriangleMesh>`
*/ */