CGAL 5.1 - CGAL and the Boost Graph Library
CGAL::HalfedgeDS_face_max_base_with_id< Refs > Class Template Reference

#include <CGAL/HalfedgeDS_face_max_base_with_id.h>

Definition

template<typename Refs>
class CGAL::HalfedgeDS_face_max_base_with_id< Refs >

The class HalfedgeDS_face_max_base_with_id is a model of the HalfedgeDSFace concept.

It is equivalent to HalfedgeDS_face_base< Refs, Tag_true> with an added integer field which can be used to index faces in Bgl algorithms. The class contains support for the incident halfedge pointer and the required type definitions. It can be used for deriving own faces.

Note that the user is in charge to set the index correctly before running a graph algorithm.

Template Parameters
Refsmust be an instantiation of a HalfedgeDS.
Is Model Of:
HalfedgeDSFace
See also
HalfedgeDS<Traits,Items,Alloc>
HalfedgeDSItems
PolyhedronItems_3
CGAL::HalfedgeDS_min_items
CGAL::HalfedgeDS_vertex_min_base<Refs>
CGAL::HalfedgeDS_halfedge_min_base<Refs>
CGAL::HalfedgeDS_face_base<Refs>
CGAL::HalfedgeDS_vertex_max_base_with_id<Refs>
CGAL::HalfedgeDS_halfedge_max_base_with_id<Refs>
CGAL::Polyhedron_items_with_id_3

Creation

 HalfedgeDS_face_max_base_with_id ()
 Default constructor.
 
int id () const
 Returns the index.
 
int & id ()
 Returns a reference to the index stored in the face.