Blender V5.3
bmesh_iterators.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
10
21
22#include "BLI_bit_span.hh"
23#include "BLI_compiler_attrs.hh"
24#include "BLI_mempool.hh"
25
26#include "bmesh_class.hh"
28
29/* these iterator over all elements of a specific
30 * type in the mesh.
31 *
32 * be sure to keep 'bm_iter_itype_htype_map' in sync with any changes
33 */
34
35namespace blender {
36
41 /* these are topological iterators. */
45 BM_VERTS_OF_EDGE = 7, /* just v1, v2: added so py can use generalized sequencer wrapper */
50 /* returns elements from all boundaries, and returns
51 * the first element at the end to flag that we're entering
52 * a different face hole boundary. */
53 // BM_ALL_LOOPS_OF_FACE = 12,
54 /* iterate through loops around this loop, which are fetched
55 * from the other faces in the radial cycle surrounding the
56 * input loop's edge. */
59};
60
61#define BM_ITYPE_MAX 14
62
63/* the iterator htype for each iterator */
64extern const char bm_iter_itype_htype_map[BM_ITYPE_MAX];
65
66/* -------------------------------------------------------------------- */
71
72#define BM_ITER_MESH(ele, iter, bm, itype) \
73 for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, bm, itype, NULL); ele; \
74 BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter))
75
76#define BM_ITER_MESH_INDEX(ele, iter, bm, itype, indexvar) \
77 for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, bm, itype, NULL), indexvar = 0; ele; \
78 BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter), (indexvar)++)
79
80/* a version of BM_ITER_MESH which keeps the next item in storage
81 * so we can delete the current item, see bug #36923. */
82#ifndef NDEBUG
83# define BM_ITER_MESH_MUTABLE(ele, ele_next, iter, bm, itype) \
84 for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, bm, itype, NULL); \
85 ele ? ((void)((iter)->count = BM_iter_mesh_count(itype, bm)), \
86 (void)(BM_CHECK_TYPE_ELEM_ASSIGN(ele_next) = BM_iter_step(iter)), \
87 1) : \
88 0; \
89 BM_CHECK_TYPE_ELEM_ASSIGN(ele) = ele_next)
90#else
91# define BM_ITER_MESH_MUTABLE(ele, ele_next, iter, bm, itype) \
92 for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, bm, itype, NULL); \
93 ele ? ((BM_CHECK_TYPE_ELEM_ASSIGN(ele_next) = BM_iter_step(iter)), 1) : 0; \
94 ele = ele_next)
95#endif
96
97#define BM_ITER_ELEM(ele, iter, data, itype) \
98 for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, NULL, itype, data); ele; \
99 BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter))
100
101#define BM_ITER_ELEM_INDEX(ele, iter, data, itype, indexvar) \
102 for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, NULL, itype, data), indexvar = 0; ele; \
103 BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter), (indexvar)++)
104
106
107/* iterator type structs */
152
153using BMIter__begin_cb = void (*)(void *);
154using BMIter__step_cb = void *(*)(void *);
155
156/* Iterator Structure */
157/* NOTE: some of these vars are not used,
158 * so they have been commented to save stack space since this struct is used all over */
182
193int BM_iter_as_array(BMesh *bm, char itype, void *data, void **array, int len);
205 char itype,
206 void *data,
207 int *r_len,
208 void **stack_array,
209 int stack_array_size) ATTR_WARN_UNUSED_RESULT;
216 const char *slot_name,
217 char restrictmask,
218 void **array,
219 int len);
221 const char *slot_name,
222 char restrictmask,
223 int *r_len,
224 /* Optional args to avoid an allocate (normally stack array). */
225 void **stack_array,
226 int stack_array_size);
227
229 BMesh *bm,
230 MutableBitSpan bitmap,
231 bool (*test_fn)(BMElem *, void *user_data),
232 void *user_data);
237 MutableBitSpan bitmap,
238 bool (*test_fn)(BMFace *, void *user_data),
239 void *user_data);
240
246int BM_iter_elem_count_flag(char itype, void *data, char hflag, bool value);
252int BMO_iter_elem_count_flag(BMesh *bm, char itype, void *data, short oflag, bool value);
256int BM_iter_mesh_count(char itype, BMesh *bm);
262int BM_iter_mesh_count_flag(char itype, BMesh *bm, char hflag, bool value);
263
264/* private for bmesh_iterators_inline.c */
265
266#define BMITER_CB_DEF(name) \
267 struct BMIter__##name; \
268 void bmiter__##name##_begin(struct BMIter__##name *iter); \
269 void *bmiter__##name##_step(struct BMIter__##name *iter)
270
271BMITER_CB_DEF(elem_of_mesh);
272BMITER_CB_DEF(edge_of_vert);
273BMITER_CB_DEF(face_of_vert);
274BMITER_CB_DEF(loop_of_vert);
275BMITER_CB_DEF(loop_of_edge);
276BMITER_CB_DEF(loop_of_loop);
277BMITER_CB_DEF(face_of_edge);
278BMITER_CB_DEF(vert_of_edge);
279BMITER_CB_DEF(vert_of_face);
280BMITER_CB_DEF(edge_of_face);
281BMITER_CB_DEF(loop_of_face);
282
283#undef BMITER_CB_DEF
284
285} // namespace blender
286
287#include "intern/bmesh_iterators_inline.hh" /* IWYU pragma: export */
288
289#define BM_ITER_CHECK_TYPE_DATA(data) \
290 CHECK_TYPE_ANY(data, void *, BMFace *, BMEdge *, BMVert *, BMLoop *, BMElem *)
291
292#define BM_iter_new(iter, bm, itype, data) \
293 (BM_ITER_CHECK_TYPE_DATA(data), BM_iter_new(iter, bm, itype, data))
294#define BM_iter_init(iter, bm, itype, data) \
295 (BM_ITER_CHECK_TYPE_DATA(data), BM_iter_init(iter, bm, itype, data))
#define BM_ITYPE_MAX
#define BMO_OP_MAX_SLOTS
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
BMesh Iterators.
int BM_iter_elem_count_flag(const char itype, void *data, const char hflag, const bool value)
Elem Iter Flag Count.
const char bm_iter_itype_htype_map[BM_ITYPE_MAX]
int BM_iter_mesh_count(const char itype, BMesh *bm)
void *(*)(void *) BMIter__step_cb
void * BM_iter_at_index(BMesh *bm, const char itype, void *data, int index)
BMesh const char itype
int BMO_iter_elem_count_flag(BMesh *bm, const char itype, void *data, const short oflag, const bool value)
Elem Iter Tool Flag Count.
BMITER_CB_DEF(elem_of_mesh)
BMesh const char void * data
void * BM_iter_as_arrayN(BMesh *bm, const char itype, void *data, int *r_len, void **stack_array, int stack_array_size)
Iterator as Array.
void(*)(void *) BMIter__begin_cb
int BMO_iter_as_array(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const char restrictmask, void **array, const int len)
Operator Iterator as Array.
int BM_iter_mesh_bitmap_from_filter(const char itype, BMesh *bm, MutableBitSpan bitmap, bool(*test_fn)(BMElem *, void *user_data), void *user_data)
void * BMO_iter_as_arrayN(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const char restrictmask, int *r_len, void **stack_array, int stack_array_size)
int BM_iter_mesh_count_flag(const char itype, BMesh *bm, const char hflag, const bool value)
Mesh Iter Flag Count.
bool ATTR_WARN_UNUSED_RESULT
ATTR_WARN_UNUSED_RESULT const BMFlagLayer const short oflag
int BM_iter_mesh_bitmap_from_filter_tessface(BMesh *bm, MutableBitSpan bitmap, bool(*test_fn)(BMFace *, void *user_data), void *user_data)
int BM_iter_as_array(BMesh *bm, const char itype, void *data, void **array, const int len)
Iterator as Array.
BMIter__step_cb step
BMIter__begin_cb begin
BMIter__face_of_edge face_of_edge
BMIter__elem_of_mesh elem_of_mesh
BMIter__vert_of_face vert_of_face
BMIter__vert_of_edge vert_of_edge
BMIter__loop_of_vert loop_of_vert
BMIter__loop_of_edge loop_of_edge
BMIter__loop_of_loop loop_of_loop
BMIter__edge_of_face edge_of_face
BMIter__edge_of_vert edge_of_vert
BMIter__loop_of_face loop_of_face
BMIter__face_of_vert face_of_vert