\( \newcommand{\E}{\mathrm{E}} \) \( \newcommand{\A}{\mathrm{A}} \) \( \newcommand{\R}{\mathrm{R}} \) \( \newcommand{\N}{\mathrm{N}} \) \( \newcommand{\Q}{\mathrm{Q}} \) \( \newcommand{\Z}{\mathrm{Z}} \) \( \def\ccSum #1#2#3{ \sum_{#1}^{#2}{#3} } \def\ccProd #1#2#3{ \sum_{#1}^{#2}{#3} }\)
CGAL 4.7 - 2D Apollonius Graphs (Delaunay Graphs of Disks)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
List of all members
ApolloniusGraphVertexBase_2 Concept Reference
2D Apollonius Graphs (Delaunay Graphs of Disks) Reference » Concepts

Definition

The concept ApolloniusGraphVertexBase_2 describes the requirements for the vertex base class of the ApolloniusGraphDataStructure_2 concept. A vertex stores an Apollonius site and provides access to one of its incident faces through a Face_handle. In addition, it maintains a container of sites. The container stores the hidden sites related to the vertex.

Has Models:
CGAL::Apollonius_graph_vertex_base_2<Gt,StoreHidden>
See also
ApolloniusGraphDataStructure_2
ApolloniusGraphTraits_2
CGAL::Apollonius_graph_vertex_base_2<Gt,StoreHidden>

Types

typedef unspecified_type Geom_traits
 A type for the geometric traits that defines the site stored. More...
 
typedef unspecified_type Store_hidden
 A Boolean that indicates if hidden sites are actually stored or not. More...
 
typedef unspecified_type Site_2
 A type for the site stored. More...
 
typedef unspecified_type Apollonius_graph_data_structure_2
 A type for the Apollonius graph data structure, to which the vertex belongs to. More...
 
typedef unspecified_type Vertex_handle
 A type for the vertex handle of the Apollonius graph data structure. More...
 
typedef unspecified_type Face_handle
 A type for the face handle of the Apollonius graph data structure. More...
 
typedef unspecified_type Hidden_sites_iterator
 An iterator that iterates over the hidden sites in the hidden sites container of the vertex. More...
 

Creation

 ApolloniusGraphVertexBase_2 ()
 Default constructor. More...
 
 ApolloniusGraphVertexBase_2 (Site_2 s)
 Constructs a vertex associated with the Apollonius site s and embedded at the center of s. More...
 
 ApolloniusGraphVertexBase_2 (Site_2 s, Face_handle f)
 Constructs a vertex associated with the site s, embedded at the center of s, and pointing to the face associated with the face handle f. More...
 

Access Functions

Site_2 site ()
 Returns the Apollonius site. More...
 
Face_handle face ()
 Returns a handle to an incident face. More...
 
unsigned int number_of_hidden_sites ()
 Returns the number of hidden sites in the hidden sites container. More...
 
Hidden_sites_iterator hidden_sites_begin ()
 Starts at an arbitrary hidden site. More...
 
Hidden_sites_iterator hidden_sites_end ()
 Past-the-end iterator. More...
 

Setting and unsetting

void set_site (Site_2 s)
 Sets the Apollonius site. More...
 
void set_face (Face_handle f)
 Sets the incident face. More...
 
void add_hidden_site (Site_2 s)
 Adds a hidden site to the container of hidden sites. More...
 
void clear_hidden_sites_container ()
 Clears the container of hidden sites. More...
 

Checking

bool is_valid (bool verbose, int level) const
 Performs any required tests on a vertex. More...
 

Member Typedef Documentation

typedef unspecified_type ApolloniusGraphVertexBase_2::Apollonius_graph_data_structure_2

A type for the Apollonius graph data structure, to which the vertex belongs to.

typedef unspecified_type ApolloniusGraphVertexBase_2::Face_handle

A type for the face handle of the Apollonius graph data structure.

typedef unspecified_type ApolloniusGraphVertexBase_2::Geom_traits

A type for the geometric traits that defines the site stored.

Precondition
The type Geom_traits must define the type Site_2.
typedef unspecified_type ApolloniusGraphVertexBase_2::Hidden_sites_iterator

An iterator that iterates over the hidden sites in the hidden sites container of the vertex.

Precondition
Must be a model of Iterator.
typedef unspecified_type ApolloniusGraphVertexBase_2::Site_2

A type for the site stored.

Precondition
This type must coincide with the type Geom_traits::Site_2.
typedef unspecified_type ApolloniusGraphVertexBase_2::Store_hidden

A Boolean that indicates if hidden sites are actually stored or not.

Its value is true if hidden sites are stored, false otherwise.

typedef unspecified_type ApolloniusGraphVertexBase_2::Vertex_handle

A type for the vertex handle of the Apollonius graph data structure.

Constructor & Destructor Documentation

ApolloniusGraphVertexBase_2::ApolloniusGraphVertexBase_2 ( )

Default constructor.

ApolloniusGraphVertexBase_2::ApolloniusGraphVertexBase_2 ( Site_2  s)

Constructs a vertex associated with the Apollonius site s and embedded at the center of s.

ApolloniusGraphVertexBase_2::ApolloniusGraphVertexBase_2 ( Site_2  s,
Face_handle  f 
)

Constructs a vertex associated with the site s, embedded at the center of s, and pointing to the face associated with the face handle f.

Member Function Documentation

void ApolloniusGraphVertexBase_2::add_hidden_site ( Site_2  s)

Adds a hidden site to the container of hidden sites.

void ApolloniusGraphVertexBase_2::clear_hidden_sites_container ( )

Clears the container of hidden sites.

Face_handle ApolloniusGraphVertexBase_2::face ( )

Returns a handle to an incident face.

Hidden_sites_iterator ApolloniusGraphVertexBase_2::hidden_sites_begin ( )

Starts at an arbitrary hidden site.

Hidden_sites_iterator ApolloniusGraphVertexBase_2::hidden_sites_end ( )

Past-the-end iterator.

bool ApolloniusGraphVertexBase_2::is_valid ( bool  verbose,
int  level 
) const

Performs any required tests on a vertex.

unsigned int ApolloniusGraphVertexBase_2::number_of_hidden_sites ( )

Returns the number of hidden sites in the hidden sites container.

void ApolloniusGraphVertexBase_2::set_face ( Face_handle  f)

Sets the incident face.

void ApolloniusGraphVertexBase_2::set_site ( Site_2  s)

Sets the Apollonius site.

Site_2 ApolloniusGraphVertexBase_2::site ( )

Returns the Apollonius site.