From c4e041da23b9c45273fcd4874308c536b6a315d1 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 3 Dec 2021 19:29:35 +1100 Subject: Cleanup: move public doc-strings into headers for 'bmesh' Some minor improvements to doc-strings too. Ref T92709 --- source/blender/bmesh/tools/bmesh_beautify.h | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'source/blender/bmesh/tools/bmesh_beautify.h') diff --git a/source/blender/bmesh/tools/bmesh_beautify.h b/source/blender/bmesh/tools/bmesh_beautify.h index d0fef828e7c..2e7950118c1 100644 --- a/source/blender/bmesh/tools/bmesh_beautify.h +++ b/source/blender/bmesh/tools/bmesh_beautify.h @@ -27,6 +27,9 @@ enum { EDGE_RESTRICT_DEGENERATE = (1 << 1), }; +/** + * \note This function sets the edge indices to invalid values. + */ void BM_mesh_beautify_fill(BMesh *bm, BMEdge **edge_array, const int edge_array_len, @@ -35,6 +38,12 @@ void BM_mesh_beautify_fill(BMesh *bm, const short oflag_edge, const short oflag_face); +/** + * Assuming we have 2 triangles sharing an edge (2 - 4), + * check if the edge running from (1 - 3) gives better results. + * + * \return (negative number means the edge can be rotated, lager == better). + */ float BM_verts_calc_rotate_beauty(const BMVert *v1, const BMVert *v2, const BMVert *v3, -- cgit v1.2.3