diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-03 11:29:35 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-03 12:10:57 +0300 |
commit | c4e041da23b9c45273fcd4874308c536b6a315d1 (patch) | |
tree | 9afdea81b57e801d3a1930988ebf3a2145a408bb /source/blender/bmesh/intern/bmesh_edgeloop.h | |
parent | 7c4fc5b58d2e7982aefbba093cb8f1dc36b64884 (diff) |
Cleanup: move public doc-strings into headers for 'bmesh'
Some minor improvements to doc-strings too.
Ref T92709
Diffstat (limited to 'source/blender/bmesh/intern/bmesh_edgeloop.h')
-rw-r--r-- | source/blender/bmesh/intern/bmesh_edgeloop.h | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/source/blender/bmesh/intern/bmesh_edgeloop.h b/source/blender/bmesh/intern/bmesh_edgeloop.h index 34fc4c0ccc1..58b0d92fb72 100644 --- a/source/blender/bmesh/intern/bmesh_edgeloop.h +++ b/source/blender/bmesh/intern/bmesh_edgeloop.h @@ -28,6 +28,9 @@ struct GSet; struct ListBase; /* multiple edgeloops (ListBase) */ +/** + * \return listbase of listbases, each linking to a vertex. + */ int BM_mesh_edgeloops_find(BMesh *bm, struct ListBase *r_eloops, bool (*test_fn)(BMEdge *, void *user_data), @@ -47,7 +50,10 @@ void BM_mesh_edgeloops_calc_normal_aligned(BMesh *bm, const float no_align[3]); void BM_mesh_edgeloops_calc_order(BMesh *bm, ListBase *eloops, const bool use_normals); -/* single edgeloop */ +/** + * Copy a single edge-loop. + * \return new edge-loops. + */ struct BMEdgeLoopStore *BM_edgeloop_copy(struct BMEdgeLoopStore *el_store); struct BMEdgeLoopStore *BM_edgeloop_from_verts(BMVert **v_arr, const int v_arr_tot, @@ -59,9 +65,18 @@ int BM_edgeloop_length_get(struct BMEdgeLoopStore *el_store); struct ListBase *BM_edgeloop_verts_get(struct BMEdgeLoopStore *el_store); const float *BM_edgeloop_normal_get(struct BMEdgeLoopStore *el_store); const float *BM_edgeloop_center_get(struct BMEdgeLoopStore *el_store); +/** + * Edges are assigned to one vert -> the next. + */ void BM_edgeloop_edges_get(struct BMEdgeLoopStore *el_store, BMEdge **e_arr); void BM_edgeloop_calc_center(BMesh *bm, struct BMEdgeLoopStore *el_store); bool BM_edgeloop_calc_normal(BMesh *bm, struct BMEdgeLoopStore *el_store); +/** + * For open loops that are straight lines, + * calculating the normal as if it were a polygon is meaningless. + * + * Instead use an alignment vector and calculate the normal based on that. + */ bool BM_edgeloop_calc_normal_aligned(BMesh *bm, struct BMEdgeLoopStore *el_store, const float no_align[3]); |