Code documentation updates (2).
This commit is contained in:
@@ -6,8 +6,16 @@
|
||||
|
||||
namespace TriangleNet.IO
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface used to indicate support for file formats in the <see cref="FileProcessor" />.
|
||||
/// </summary>
|
||||
public interface IFileFormat
|
||||
{
|
||||
/// <summary>
|
||||
/// Test whether the given file is supported.
|
||||
/// </summary>
|
||||
/// <param name="file">The file to read.</param>
|
||||
/// <returns>Returns true if the file can be read.</returns>
|
||||
bool IsSupported(string file);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,15 +13,11 @@ namespace TriangleNet.IO
|
||||
using TriangleNet.Meshing;
|
||||
|
||||
/// <summary>
|
||||
/// Implements geometry and mesh file formats of the the original Triangle code.
|
||||
/// Implements geometry and mesh file formats of the original Triangle project.
|
||||
/// </summary>
|
||||
public class TriangleFormat : IPolygonFormat, IMeshFormat
|
||||
{
|
||||
/// <summary>
|
||||
/// Returns a value indicating whether the given file is supported by this format.
|
||||
/// </summary>
|
||||
/// <param name="file"></param>
|
||||
/// <returns></returns>
|
||||
/// <inheritdoc />
|
||||
public bool IsSupported(string file)
|
||||
{
|
||||
string ext = Path.GetExtension(file).ToLower();
|
||||
|
||||
@@ -50,7 +50,7 @@ namespace TriangleNet.Meshing
|
||||
/// </summary>
|
||||
/// <param name="quality">The quality constraints.</param>
|
||||
/// <param name="delaunay">
|
||||
/// A value indicating, if the refined mesh should be Conforming Delaunay.
|
||||
/// A value indicating, whether the refined mesh should be Conforming Delaunay.
|
||||
/// </param>
|
||||
void Refine(QualityOptions quality, bool delaunay);
|
||||
}
|
||||
|
||||
@@ -84,6 +84,12 @@ namespace TriangleNet.Topology.DCEL
|
||||
/// a valid next pointer).</param>
|
||||
/// <param name="depth">Maximum edge count of faces (default = 0 means skip check).</param>
|
||||
/// <returns></returns>
|
||||
/// <remarks>
|
||||
/// The <paramref name="depth"/> value relates to the maximum degree of a vertex in the
|
||||
/// triangulation. For quality meshes, the maximum degree is usually low, but for meshes
|
||||
/// build from PSLGs without quality constraints applied, either provide a larger value
|
||||
/// or disable the check by setting <paramref name="depth"/> to 0 (default).
|
||||
/// </remarks>
|
||||
public virtual bool IsConsistent(bool closed = true, int depth = 0)
|
||||
{
|
||||
// Check vertices for null pointers.
|
||||
|
||||
@@ -63,16 +63,17 @@ namespace TriangleNet.Voronoi.Legacy
|
||||
get { return regions.Values; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Enumerates the edges of the Voronoi diagram.
|
||||
/// </summary>
|
||||
public IEnumerable<IEdge> Edges
|
||||
{
|
||||
get { return EnumerateEdges(); }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the Voronoi diagram as raw output data.
|
||||
/// Generate the Voronoi diagram.
|
||||
/// </summary>
|
||||
/// <param name="mesh"></param>
|
||||
/// <returns></returns>
|
||||
/// <remarks>
|
||||
/// The Voronoi diagram is the geometric dual of the Delaunay triangulation.
|
||||
/// Hence, the Voronoi vertices are listed by traversing the Delaunay
|
||||
|
||||
@@ -19,12 +19,16 @@ namespace TriangleNet.Voronoi
|
||||
/// </summary>
|
||||
public abstract class VoronoiBase : DcelMesh
|
||||
{
|
||||
/// <summary>Predicates</summary>
|
||||
protected IPredicates predicates;
|
||||
|
||||
/// <summary>Voronoi factory</summary>
|
||||
protected IVoronoiFactory factory;
|
||||
|
||||
// List of infinite half-edges, i.e. half-edges that start at circumcenters of triangles
|
||||
// which lie on the domain boundary.
|
||||
/// <summary>
|
||||
/// List of infinite half-edges, i.e. half-edges that start at circumcenters
|
||||
/// of triangles on the domain boundary.
|
||||
/// </summary>
|
||||
protected List<HalfEdge> rays;
|
||||
|
||||
/// <summary>
|
||||
@@ -278,6 +282,7 @@ namespace TriangleNet.Voronoi
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override IEnumerable<IEdge> EnumerateEdges()
|
||||
{
|
||||
var edges = new List<IEdge>(this.edges.Count / 2);
|
||||
|
||||
Reference in New Issue
Block a user