CGAL 5.1 - 2D Regularized Boolean Set-Operations
GeneralPolygonSetDcelFace Class Reference

#include <Concepts/GeneralPolygonSetDcelFace.h>

Definition

A face record in a Dcel data structure used by the General_polygon_set_2 and Polygon_set_2 template classes to represent the underlying internal Arrangement_2 data structure.

Refines:
ArrangementDcelFace
Has Models:
CGAL::Gps_face_base
See also
ArrangementDcel
ArrangementDcelVertex
GeneralPolygonSetDcelHalfedge

Access Functions

bool contained () const
 returns true if the face is contained in the general-polygon set, and false otherwise. More...
 
bool visited ()
 returns true if the face has been visited, and false otherwise. More...
 
std::size_t id () const
 returns an id associated to the face using set_id(); If no call to set_id() was done or if reset_id() was called, the returned value is not specified and id_not_set() must return true. More...
 
bool id_not_set () const
 returns true if set_id() was not called or if reset_id() was called, amd false otherwise. More...
 

Modifiers

void set_contained (bool flag)
 marks the face as contained (if flag is true), or as a hole (if it is false). More...
 
void reset_id ()
 marks the face as visited (if flag is true), or as not visited (if it is false). More...
 
void set_id (std::size_t i)
 sets the id associated to the face. More...
 

Member Function Documentation

◆ contained()

bool GeneralPolygonSetDcelFace::contained ( ) const

returns true if the face is contained in the general-polygon set, and false otherwise.

◆ id()

std::size_t GeneralPolygonSetDcelFace::id ( ) const

returns an id associated to the face using set_id(); If no call to set_id() was done or if reset_id() was called, the returned value is not specified and id_not_set() must return true.

◆ id_not_set()

bool GeneralPolygonSetDcelFace::id_not_set ( ) const

returns true if set_id() was not called or if reset_id() was called, amd false otherwise.

◆ reset_id()

void GeneralPolygonSetDcelFace::reset_id ( )

marks the face as visited (if flag is true), or as not visited (if it is false).

This is used internally by the some of the operations of the General_polygon_set_2 class that traverse the arrangement faces.

resets the id associated to the face.

◆ set_contained()

void GeneralPolygonSetDcelFace::set_contained ( bool  flag)

marks the face as contained (if flag is true), or as a hole (if it is false).

◆ set_id()

void GeneralPolygonSetDcelFace::set_id ( std::size_t  i)

sets the id associated to the face.

i should be different from the largest possible value that std::size_t can store.

◆ visited()

bool GeneralPolygonSetDcelFace::visited ( )

returns true if the face has been visited, and false otherwise.

This is used internally by the some of the operations of the General_polygon_set_2 class that traverse the arrangement faces.