CGAL 6.2 - Shape Detection

Loading...
Searching...
No Matches
List of all members
CGAL::Shape_detection::Polygon_mesh::Face_area_sorting< GeomTraits, PolygonMesh, VertexToPointMap > Class Template Reference
Reference Manual » Region Growing » Polygon Mesh

`#include <CGAL/Shape_detection/Region_growing/Polygon_mesh/Face_area_sorting.h>`

## Definition

template<typename GeomTraits, typename PolygonMesh, typename VertexToPointMap = typename boost::property_map<PolygonMesh, CGAL::vertex_point_t>::const_type>
class CGAL::Shape_detection::Polygon_mesh::Face_area_sorting< GeomTraits, PolygonMesh, VertexToPointMap >

Sorting of polygon mesh faces with respect to their area.

`Items` of faces in a polygon mesh are sorted in decreasing area.

Template Parameters

  GeomTraits | a model of `Kernel`
  PolygonMesh | a model of `FaceListGraph`
  VertexToPointMap | a model of `ReadablePropertyMap` whose key type is the vertex type of a polygon mesh (`boost::graph_traits<PolygonMesh>::vertex_descriptor`) and value type is `GeomTraits::Point_3`

Examples
  Shape_detection/region_growing_lines_on_segment_set.cpp, and Shape_detection/region_growing_planes_on_polygon_mesh.cpp.

## Types
using | Item = typename boost::graph_traits< PolygonMesh >::face_descriptor
| Item type.
using | Seed_range = std::vector< Item >
| Seed range.

## Initialization
template<typename NamedParameters = CGAL::parameters::Default_named_parameters>
| Face_area_sorting (const PolygonMesh &pmesh, const NamedParameters &np=parameters::default_values())
| initializes all internal data structures.
template<typename Dummy , typename NamedParameters = CGAL::parameters::Default_named_parameters>
| Face_area_sorting (const PolygonMesh &pmesh, const Dummy &, const NamedParameters &np=parameters::default_values())
| initializes all internal data structures.

## Sorting
void | sort ()
| sorts `Items` of input faces.

## Access
const Seed_range & | ordered ()
| returns an instance of `Seed_range` to access the ordered `Items` of input faces.

## Constructor & Destructor Documentation

## ◆ Face_area_sorting() [1/2]

template<typename GeomTraits , typename PolygonMesh , typename VertexToPointMap = typename boost::property_map<PolygonMesh, CGAL::vertex_point_t>::const_type>
template<typename NamedParameters = CGAL::parameters::Default_named_parameters>

CGAL::Shape_detection::Polygon_mesh::Face_area_sorting< GeomTraits, PolygonMesh, VertexToPointMap >::Face_area_sorting | ( | const PolygonMesh & | pmesh,
|  | const NamedParameters & | np = `parameters::default_values()`
| ) |  |

initializes all internal data structures.

Template Parameters

  NamedParameters | a sequence of Named Parameters

Parameters

  pmesh | an instance of `PolygonMesh` that represents a polygon mesh
  np | a sequence of Named Parameters among the ones listed below

Optional Named Parameters

  an instance of `VertexToPointMap` that maps a polygon mesh vertex (`boost::graph_traits<PolygonMesh>::vertex_descriptor`) to `GeomTraits::Point_3` Default: `boost::get(CGAL::vertex_point, pmesh)` |
  an instance of `GeomTraits` Default: `GeomTraits()` |

Precondition
  `faces(pmesh).size() > 0`

## ◆ Face_area_sorting() [2/2]

template<typename GeomTraits , typename PolygonMesh , typename VertexToPointMap = typename boost::property_map<PolygonMesh, CGAL::vertex_point_t>::const_type>
template<typename Dummy , typename NamedParameters = CGAL::parameters::Default_named_parameters>

CGAL::Shape_detection::Polygon_mesh::Face_area_sorting< GeomTraits, PolygonMesh, VertexToPointMap >::Face_area_sorting | ( | const PolygonMesh & | pmesh,
|  | const Dummy & | ,
|  | const NamedParameters & | np = `parameters::default_values()`
| ) |  |

initializes all internal data structures.

Three-parameter constructor with a dummy parameter provided for compatibility with other sorting types.

Template Parameters

  Dummy | Dummy parameter, not used.
  NamedParameters | a sequence of Named Parameters

Parameters

  pmesh | an instance of `PolygonMesh` that represents a polygon mesh
  np | a sequence of Named Parameters among the ones listed below

Optional Named Parameters

  an instance of `VertexToPointMap` that maps a polygon mesh vertex (`boost::graph_traits<PolygonMesh>::vertex_descriptor`) to `GeomTraits::Point_3` Default: `boost::get(CGAL::vertex_point, pmesh)` |
  an instance of `GeomTraits` Default: `GeomTraits()` |

Precondition
  `faces(pmesh).size() > 0`