Skip to content

Commit

Permalink
added comment
Browse files Browse the repository at this point in the history
  • Loading branch information
luithefirst committed Nov 20, 2024
1 parent ef340b3 commit 3c7adcb
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/Aardvark.Geometry.PolyMesh/PolyMesh.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1175,6 +1175,14 @@ where a.Key.IsPositive

#region Various Methods

/// <summary>
/// Enumerates non-degenerate face indices.
/// The simplest check with compareVertices=false and checkNormals=false will test the edges for identical vertex indices.
/// With default arguments (compareVertices=true, checkNormals=true) vertexIndices, vertexValues, and faceNormals are used to test for degenerated faces.
/// NOTE: In case there are polygons with more than 3 vertices, a face will be considered degenerated if any edge is degenerated (identical
/// vertex indices or vertex value if compareVertices=true) and will result in missing parts of the mesh.
/// This can be avoided by using TriangulatedCopy() beforehand.
/// </summary>
public IEnumerable<int> NonDegenerateFaceIndices(
bool compareVertices = true, bool checkNormals = true)
{
Expand Down

0 comments on commit 3c7adcb

Please sign in to comment.