cgal/Triangulation_3/doc/TDS_3/CGAL/Triangulation_utils_3.h

57 lines
1.4 KiB
C++

namespace CGAL {
/*!
\ingroup PkgTDS3Classes
The class `Triangulation_utils_3` defines operations on the indices of vertices
and neighbors within a cell.
\anchor Triangulation3figutils
\image html utils.png "Operations on indices."
\image latex utils.png "Operations on indices."
*/
class Triangulation_utils_3 {
public:
/// \name Operations
/// @{
/*!
In dimension 3, index of the neighbor `n` that is next to the current cell,
when turning positively around an oriented edge whose endpoints are
indexed `i` and `j`. According to the usual numbering of
vertices and neighbors in a given cell, it is also the index of the vertex
opposite to this neighbor `n`. (see Figure \ref Triangulation3figutils).
\pre `( i < 4 ) && ( j < 4 ) && ( i != j )`.
*/
static unsigned int next_around_edge(unsigned int i, unsigned int j);
/*!
In dimension 3, index of the `j`'th vertex in counterclockwise order on the face opposite to vertex with `i` of the cell.
\pre `( i < 4 ) && ( j < 3 )`.
*/
static int vertex_triple_index(const int i, const int j);
/*!
Has a meaning only in dimension 2.
Computes the index of the vertex that is next to the vertex numbered
`i` in counterclockwise direction. (see
Figure \ref Triangulation3figutils).
\pre `i<3`.
*/
static unsigned int ccw(unsigned int i);
/*!
Same for clockwise.
*/
static unsigned int cw(unsigned int i);
/// @}
}; /* end Triangulation_utils_3 */
} /* end namespace CGAL */