Geogram  Version 1.9.1-rc
A programming library of geometric algorithms
GEO::Cavity Class Reference

Represents the set of tetrahedra on the boundary of the cavity in a 3D Delaunay triangulation. More...

#include <geogram/delaunay/cavity.h>

Public Types

typedef Numeric::uint8 local_index_t
 Type used for local indices.
 

Public Member Functions

 Cavity ()
 Cavity constructor.
 
void clear ()
 Clears this cavity.
 
bool OK () const
 Tests whether this Cavity is valid. More...
 
void new_facet (index_t tglobal, index_t boundary_f, signed_index_t v0, signed_index_t v1, signed_index_t v2)
 Inserts a new boundary facet in the structure. More...
 
index_t nb_facets () const
 Gets the number of facets. More...
 
index_t facet_tet (index_t f) const
 Gets the tetrahedron associated with a facet. More...
 
void set_facet_tet (index_t f, index_t t)
 Sets the tetrahedron associated with a facet. More...
 
index_t facet_facet (index_t f) const
 Gets the local tetrahedron facet that corresponds to a facet. More...
 
signed_index_t facet_vertex (index_t f, index_t lv) const
 Gets the vertex of a facet. More...
 
void get_facet_neighbor_tets (index_t f, index_t &t0, index_t &t1, index_t &t2) const
 Gets the neighbors of a facet. More...
 

Detailed Description

Represents the set of tetrahedra on the boundary of the cavity in a 3D Delaunay triangulation.

Definition at line 69 of file cavity.h.

Member Function Documentation

◆ facet_facet()

index_t GEO::Cavity::facet_facet ( index_t  f) const
inline

Gets the local tetrahedron facet that corresponds to a facet.

Parameters
[in]fthe facet.
Returns
the local index of the tetrahedron facet associated with f, in 0..3

Definition at line 194 of file cavity.h.

◆ facet_tet()

index_t GEO::Cavity::facet_tet ( index_t  f) const
inline

Gets the tetrahedron associated with a facet.

Parameters
[in]fthe facet
Returns
the tetrahedron associated with f.

Definition at line 172 of file cavity.h.

◆ facet_vertex()

signed_index_t GEO::Cavity::facet_vertex ( index_t  f,
index_t  lv 
) const
inline

Gets the vertex of a facet.

Parameters
[in]fa facet.
[in]lvlocal index of the vertex, in 0..2.
Returns
the global vertex index.

Definition at line 205 of file cavity.h.

◆ get_facet_neighbor_tets()

void GEO::Cavity::get_facet_neighbor_tets ( index_t  f,
index_t t0,
index_t t1,
index_t t2 
) const
inline

Gets the neighbors of a facet.

Parameters
[in]fa facet
[out]t0,t1,t2the global tetrahedron indices that correspond to the neighbors of f.

Definition at line 217 of file cavity.h.

◆ nb_facets()

index_t GEO::Cavity::nb_facets ( ) const
inline

Gets the number of facets.

Returns
the number of facets.

Definition at line 163 of file cavity.h.

◆ new_facet()

void GEO::Cavity::new_facet ( index_t  tglobal,
index_t  boundary_f,
signed_index_t  v0,
signed_index_t  v1,
signed_index_t  v2 
)
inline

Inserts a new boundary facet in the structure.

Parameters
[in]tglobalglobal tetrahedron index
[in]boundary_findex of the facet that is on the boundary
[in]v0,v1,v2the three vertices of the facet that is on the boundary

Definition at line 124 of file cavity.h.

◆ OK()

bool GEO::Cavity::OK ( ) const
inline

Tests whether this Cavity is valid.

Return values
trueif this Cavity is valid.
falseotherwise. A Cavity is not valid when there was overflow.

Definition at line 113 of file cavity.h.

◆ set_facet_tet()

void GEO::Cavity::set_facet_tet ( index_t  f,
index_t  t 
)
inline

Sets the tetrahedron associated with a facet.

Parameters
[in]fthe facet.
[in]tthe tetrahedron to be associated with f.

Definition at line 182 of file cavity.h.


The documentation for this class was generated from the following file: