CGAL 5.1 - 2D Segment Delaunay Graphs
SegmentDelaunayGraphVertexBase_2 Class Reference

#include <Concepts/SegmentDelaunayGraphVertexBase_2.h>

Definition

Types

typedef unspecified_type Geom_traits
 A type for the geometric traits that defines the site. More...
 
typedef unspecified_type Site_2
 A type for the site. More...
 
typedef unspecified_type Storage_site_tag
 A type that indicates what kind of storage type to use. More...
 
typedef unspecified_type Storage_site_2
 A type for the internal representation of sites. More...
 
typedef unspecified_type Data_structure
 A type for the underlying data structure, to which the vertex belongs to. More...
 
typedef unspecified_type Vertex_handle
 A type for the vertex handle of the segment Delaunay graph data structure. More...
 
typedef unspecified_type Face_handle
 A type for the face handle of the segment Delaunay graph data structure. More...
 

Creation

In addition to the default and copy constructors and following constructors are required:

 SegmentDelaunayGraphVertexBase_2 (Storage_site_2 ss)
 Constructs a vertex associated with the site represented by the storage site ss. More...
 
 SegmentDelaunayGraphVertexBase_2 (Storage_site_2 ss, Face_handle f)
 Constructs a vertex associated with the site represented by the storage site ss, and pointing to the face associated with the face handle f. More...
 

Access Functions

Storage_site_2 storage_site ()
 Returns the storage site representing the site. More...
 
Site_2 site ()
 Returns the site. More...
 
Face_handle face ()
 Returns a handle to an incident face. More...
 

Setting

void set_site (Storage_site_2 ss)
 Sets the storage site. More...
 
void set_face (Face_handle f)
 Sets the incident face. More...
 

Checking

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

Member Typedef Documentation

◆ Data_structure

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

◆ Face_handle

A type for the face handle of the segment Delaunay graph data structure.

◆ Geom_traits

A type for the geometric traits that defines the site.

Precondition
The type Geom_traits must define the type Site_2.

◆ Site_2

A type for the site.

This type must coincide with the type Geom_traits::Site_2.

◆ Storage_site_2

A type for the internal representation of sites.

This type must satisfy the requirements of the concept SegmentDelaunayGraphStorageSite_2.

◆ Storage_site_tag

A type that indicates what kind of storage type to use.

Storage_site_tag must either be CGAL::Tag_true or CGAL::Tag_false.

◆ Vertex_handle

A type for the vertex handle of the segment Delaunay graph data structure.

Constructor & Destructor Documentation

◆ SegmentDelaunayGraphVertexBase_2() [1/2]

SegmentDelaunayGraphVertexBase_2::SegmentDelaunayGraphVertexBase_2 ( Storage_site_2  ss)

Constructs a vertex associated with the site represented by the storage site ss.

◆ SegmentDelaunayGraphVertexBase_2() [2/2]

SegmentDelaunayGraphVertexBase_2::SegmentDelaunayGraphVertexBase_2 ( Storage_site_2  ss,
Face_handle  f 
)

Constructs a vertex associated with the site represented by the storage site ss, and pointing to the face associated with the face handle f.

Member Function Documentation

◆ face()

Face_handle SegmentDelaunayGraphVertexBase_2::face ( )

Returns a handle to an incident face.

◆ is_valid()

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

Performs any required tests on a vertex.

◆ set_face()

void SegmentDelaunayGraphVertexBase_2::set_face ( Face_handle  f)

Sets the incident face.

◆ set_site()

void SegmentDelaunayGraphVertexBase_2::set_site ( Storage_site_2  ss)

Sets the storage site.

◆ site()

Site_2 SegmentDelaunayGraphVertexBase_2::site ( )

Returns the site.

◆ storage_site()

Storage_site_2 SegmentDelaunayGraphVertexBase_2::storage_site ( )

Returns the storage site representing the site.