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/tools/bmesh_boolean.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/tools/bmesh_boolean.h')
-rw-r--r-- | source/blender/bmesh/tools/bmesh_boolean.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/source/blender/bmesh/tools/bmesh_boolean.h b/source/blender/bmesh/tools/bmesh_boolean.h index ed77242e14c..4dacc7b1095 100644 --- a/source/blender/bmesh/tools/bmesh_boolean.h +++ b/source/blender/bmesh/tools/bmesh_boolean.h @@ -35,6 +35,16 @@ bool BM_mesh_boolean(BMesh *bm, const bool hole_tolerant, const int boolean_mode); +/** + * Perform a Knife Intersection operation on the mesh `bm`. + * There are either one or two operands, the same as described above for #BM_mesh_boolean(). + * + * \param use_separate_all: When true, each edge that is created from the intersection should + * be used to separate all its incident faces. TODO: implement that. + * + * TODO: need to ensure that "selected/non-selected" flag of original faces gets propagated + * to the intersection result faces. + */ bool BM_mesh_boolean_knife(BMesh *bm, struct BMLoop *(*looptris)[3], const int looptris_tot, |