Skip to content

Commit

Permalink
Improve documentation: note that repeated edges in 'insertEdges' mean…
Browse files Browse the repository at this point in the history
…s overlapping boundaries
  • Loading branch information
artem-ogre committed Sep 16, 2021
1 parent c259251 commit 0f4b4fc
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CDT/include/CDT.h
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,10 @@ class CDT_EXPORT Triangulation
void insertVertices(const std::vector<V2d<T> >& vertices);
/**
* Insert constraints (custom-type fixed edges) into triangulation
* @note If some edge appears more than once in @ref insertEdges input this
* means that multiple boundaries overlap at the edge and impacts
* how hole detection algorithm of @ref eraseOuterTrianglesAndHoles works.
* <b>Make sure there are no erroneous duplicates.</b>
* @tparam TEdgeIter iterator that dereferences to custom edge type
* @tparam TGetEdgeVertexStart function object getting start vertex index
* from an edge.
Expand All @@ -140,7 +144,13 @@ class CDT_EXPORT Triangulation
TEdgeIter last,
TGetEdgeVertexStart getStart,
TGetEdgeVertexEnd getEnd);
/// Insert constraints (fixed edges) into triangulation
/**
* Insert constraints (fixed edges) into triangulation
* @note If some edge appears more than once in @ref insertEdges input this
* means that multiple boundaries overlap at the edge and impacts
* how hole detection algorithm of @ref eraseOuterTrianglesAndHoles works.
* <b>Make sure there are no erroneous duplicates.</b>
*/
void insertEdges(const std::vector<Edge>& edges);
/**
* Erase triangles adjacent to super triangle
Expand Down

0 comments on commit 0f4b4fc

Please sign in to comment.