CGAL 6.2 - Halfedge Data Structures: CGAL::HalfedgeDS_face_base< Refs > Class Template Reference

CGAL 6.2 - Halfedge Data Structures

Loading...
Searching...
No Matches
List of all members
CGAL::HalfedgeDS_face_base< Refs > Class Template Reference
Reference Manual » Vertices, Halfedges, Faces

`#include <CGAL/HalfedgeDS_face_base.h>`

## Definition

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

The class `HalfedgeDS_face_base` is a model of the `HalfedgeDSFace` concept.

`Refs` is an instantiation of a `HalfedgeDS`. The template declaration of `HalfedgeDS_face_base` has three parameters with some defaults that allow to select various flavors of faces. The declaration is best explained with the two following declarations, essentially hiding an implementation dependent default setting:

`template <class Refs, class T = CGAL::Tag_true>`

`class HalfedgeDS_face_base;`

`template <class Refs, class T, class Plane>`

`class HalfedgeDS_face_base;`

`HalfedgeDS_face_base` defines a face including a reference to an incident halfedge.

`CGAL::HalfedgeDS_face_base<Refs,CGAL::Tag_false>` is a face without a reference to an incident halfedge. It is empty besides the required type definitions. It can be used for deriving own faces. See also `CGAL::HalfedgeDS_face_min_base<Refs>`.

`CGAL::HalfedgeDS_face_base<Refs,CGAL::Tag_true,Plane>` is a face with a reference to an incident halfedge and it stores a plane equation of type `Plane`. It can be used as a face for a model of the `PolyhedronItems_3` concept.

`CGAL::HalfedgeDS_face_base<Refs,CGAL::Tag_false,Plane>` is a face without a reference to an incident halfedge and it stores a plane equation of type `Plane`. It can be used as a face for a model of the `PolyhedronItems_3` concept.

Is model of
  `HalfedgeDSFace`

See also
  `HalfedgeDS<Traits,Items,Alloc>`
  `HalfedgeDSItems`
  `PolyhedronItems_3`
  `CGAL::HalfedgeDS_items_2`
  `CGAL::HalfedgeDS_vertex_base<Refs>`
  `CGAL::HalfedgeDS_halfedge_base<Refs>`
  `CGAL::HalfedgeDS_face_min_base<Refs>`

Examples
  HalfedgeDS/hds_prog_color.cpp.

## Types
typedef unspecified_type | Plane
| plane type for three argument version.

## Creation
| HalfedgeDS_face_base ()
| default constructor.
| HalfedgeDS_face_base (const Plane &pln)
| initialized with plane `pln`.

## Operations
Plane & | plane ()
const Plane & | plane () const