Cleanup: commas at the end of enums
[blender.git] / source / blender / bmesh / intern / bmesh_iterators.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Joseph Eagar.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BMESH_ITERATORS_H__
24 #define __BMESH_ITERATORS_H__
25
26 /** \file blender/bmesh/intern/bmesh_iterators.h
27  *  \ingroup bmesh
28  */
29
30 /**
31  * \brief BMesh Iterators
32  *
33  * The functions and structures in this file
34  * provide a unified method for iterating over
35  * the elements of a mesh and answering simple
36  * adjacency queries. Tool authors should use
37  * the iterators provided in this file instead
38  * of inspecting the structure directly.
39  *
40  */
41
42 #include "BLI_compiler_attrs.h"
43 #include "BLI_mempool.h"
44
45 /* Defines for passing to BM_iter_new.
46  *
47  * "OF" can be substituted for "around"
48  * so BM_VERTS_OF_FACE means "vertices
49  * around a face."
50  */
51
52 /* these iterator over all elements of a specific
53  * type in the mesh.
54  *
55  * be sure to keep 'bm_iter_itype_htype_map' in sync with any changes
56  */
57 typedef enum BMIterType {
58         BM_VERTS_OF_MESH = 1,
59         BM_EDGES_OF_MESH = 2,
60         BM_FACES_OF_MESH = 3,
61         /* these are topological iterators. */
62         BM_EDGES_OF_VERT = 4,
63         BM_FACES_OF_VERT = 5,
64         BM_LOOPS_OF_VERT = 6,
65         BM_VERTS_OF_EDGE = 7, /* just v1, v2: added so py can use generalized sequencer wrapper */
66         BM_FACES_OF_EDGE = 8,
67         BM_VERTS_OF_FACE = 9,
68         BM_EDGES_OF_FACE = 10,
69         BM_LOOPS_OF_FACE = 11,
70         /* returns elements from all boundaries, and returns
71          * the first element at the end to flag that we're entering
72          * a different face hole boundary*/
73         // BM_ALL_LOOPS_OF_FACE = 12,
74         /* iterate through loops around this loop, which are fetched
75          * from the other faces in the radial cycle surrounding the
76          * input loop's edge.*/
77         BM_LOOPS_OF_LOOP = 12,
78         BM_LOOPS_OF_EDGE = 13,
79 } BMIterType;
80
81 #define BM_ITYPE_MAX 14
82
83 /* the iterator htype for each iterator */
84 extern const char bm_iter_itype_htype_map[BM_ITYPE_MAX];
85
86 #define BM_ITER_MESH(ele, iter, bm, itype) \
87         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, bm, itype, NULL); \
88              ele; \
89              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter))
90
91 #define BM_ITER_MESH_INDEX(ele, iter, bm, itype, indexvar) \
92         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, bm, itype, NULL), indexvar = 0; \
93              ele; \
94              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter), (indexvar)++)
95
96 /* a version of BM_ITER_MESH which keeps the next item in storage
97  * so we can delete the current item, see bug [#36923] */
98 #ifdef DEBUG
99 #  define BM_ITER_MESH_MUTABLE(ele, ele_next, iter, bm, itype) \
100         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, bm, itype, NULL); \
101              ele ? ((void)((iter)->count = BM_iter_mesh_count(itype, bm)), \
102                     (void)(ele_next = BM_iter_step(iter)), 1) : 0; \
103              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = ele_next)
104 #else
105 #  define BM_ITER_MESH_MUTABLE(ele, ele_next, iter, bm, itype) \
106         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, bm, itype, NULL); \
107              ele ? ((BM_CHECK_TYPE_ELEM_ASSIGN(ele_next) = BM_iter_step(iter)), 1) : 0; \
108              ele = ele_next)
109 #endif
110
111
112 #define BM_ITER_ELEM(ele, iter, data, itype) \
113         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, NULL, itype, data); \
114              ele; \
115              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter))
116
117 #define BM_ITER_ELEM_INDEX(ele, iter, data, itype, indexvar) \
118         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_new(iter, NULL, itype, data), indexvar = 0; \
119              ele; \
120              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BM_iter_step(iter), (indexvar)++)
121
122 /* iterator type structs */
123 struct BMIter__elem_of_mesh {
124         BLI_mempool_iter pooliter;
125 };
126 struct BMIter__edge_of_vert {
127         BMVert *vdata;
128         BMEdge *e_first, *e_next;
129 };
130 struct BMIter__face_of_vert {
131         BMVert *vdata;
132         BMLoop *l_first, *l_next;
133         BMEdge *e_first, *e_next;
134 };
135 struct BMIter__loop_of_vert {
136         BMVert *vdata;
137         BMLoop *l_first, *l_next;
138         BMEdge *e_first, *e_next;
139 };
140 struct BMIter__loop_of_edge {
141         BMEdge *edata;
142         BMLoop *l_first, *l_next;
143 };
144 struct BMIter__loop_of_loop {
145         BMLoop *ldata;
146         BMLoop *l_first, *l_next;
147 };
148 struct BMIter__face_of_edge {
149         BMEdge *edata;
150         BMLoop *l_first, *l_next;
151 };
152 struct BMIter__vert_of_edge {
153         BMEdge *edata;
154 };
155 struct BMIter__vert_of_face {
156         BMFace *pdata;
157         BMLoop *l_first, *l_next;
158 };
159 struct BMIter__edge_of_face {
160         BMFace *pdata;
161         BMLoop *l_first, *l_next;
162 };
163 struct BMIter__loop_of_face {
164         BMFace *pdata;
165         BMLoop *l_first, *l_next;
166 };
167
168 typedef void  (*BMIter__begin_cb) (void *);
169 typedef void *(*BMIter__step_cb) (void *);
170
171 /* Iterator Structure */
172 /* note: some of these vars are not used,
173  * so they have been commented to save stack space since this struct is used all over */
174 typedef struct BMIter {
175         /* keep union first */
176         union {
177                 struct BMIter__elem_of_mesh elem_of_mesh;
178
179                 struct BMIter__edge_of_vert edge_of_vert;
180                 struct BMIter__face_of_vert face_of_vert;
181                 struct BMIter__loop_of_vert loop_of_vert;
182                 struct BMIter__loop_of_edge loop_of_edge;
183                 struct BMIter__loop_of_loop loop_of_loop;
184                 struct BMIter__face_of_edge face_of_edge;
185                 struct BMIter__vert_of_edge vert_of_edge;
186                 struct BMIter__vert_of_face vert_of_face;
187                 struct BMIter__edge_of_face edge_of_face;
188                 struct BMIter__loop_of_face loop_of_face;
189         } data;
190
191         BMIter__begin_cb begin;
192         BMIter__step_cb step;
193
194         int count;  /* note, only some iterators set this, don't rely on it */
195         char itype;
196 } BMIter;
197
198 void   *BM_iter_at_index(BMesh *bm, const char itype, void *data, int index) ATTR_WARN_UNUSED_RESULT;
199 int     BM_iter_as_array(BMesh *bm, const char itype, void *data, void **array, const int len);
200 void   *BM_iter_as_arrayN(
201         BMesh *bm, const char itype, void *data, int *r_len,
202         void **stack_array, int stack_array_size) ATTR_WARN_UNUSED_RESULT;
203 int     BMO_iter_as_array(
204         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const char restrictmask,
205         void **array, const int len);
206 void    *BMO_iter_as_arrayN(
207         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const char restrictmask,
208         int *r_len,
209         /* optional args to avoid an alloc (normally stack array) */
210         void **stack_array, int stack_array_size);
211
212 int BM_iter_mesh_bitmap_from_filter(
213         const char itype, BMesh *bm,
214         uint *bitmap,
215         bool (*test_fn)(BMElem *, void *user_data),
216         void *user_data);
217 int BM_iter_mesh_bitmap_from_filter_tessface(
218         BMesh *bm,
219         uint *bitmap,
220         bool (*test_fn)(BMFace *, void *user_data),
221         void *user_data);
222
223 int     BM_iter_elem_count_flag(const char itype, void *data, const char hflag, const bool value);
224 int     BMO_iter_elem_count_flag(BMesh *bm, const char itype, void *data, const short oflag, const bool value);
225 int     BM_iter_mesh_count(const char itype, BMesh *bm);
226 int     BM_iter_mesh_count_flag(const char itype, BMesh *bm, const char hflag, const bool value);
227
228 /* private for bmesh_iterators_inline.c */
229
230 #define BMITER_CB_DEF(name) \
231         struct BMIter__##name; \
232         void  bmiter__##name##_begin(struct BMIter__##name *iter); \
233         void *bmiter__##name##_step(struct BMIter__##name *iter)
234
235 BMITER_CB_DEF(elem_of_mesh);
236 BMITER_CB_DEF(edge_of_vert);
237 BMITER_CB_DEF(face_of_vert);
238 BMITER_CB_DEF(loop_of_vert);
239 BMITER_CB_DEF(loop_of_edge);
240 BMITER_CB_DEF(loop_of_loop);
241 BMITER_CB_DEF(face_of_edge);
242 BMITER_CB_DEF(vert_of_edge);
243 BMITER_CB_DEF(vert_of_face);
244 BMITER_CB_DEF(edge_of_face);
245 BMITER_CB_DEF(loop_of_face);
246
247 #undef BMITER_CB_DEF
248
249 #include "intern/bmesh_iterators_inline.h"
250
251 #define BM_ITER_CHECK_TYPE_DATA(data) \
252         CHECK_TYPE_ANY(data, void *, BMFace *, BMEdge *, BMVert *, BMLoop *, BMElem *)
253
254 #define BM_iter_new(iter, bm, itype, data) \
255         (BM_ITER_CHECK_TYPE_DATA(data), BM_iter_new(iter, bm, itype, data))
256 #define BM_iter_init(iter, bm, itype, data) \
257         (BM_ITER_CHECK_TYPE_DATA(data), BM_iter_init(iter, bm, itype, data))
258
259 #endif /* __BMESH_ITERATORS_H__ */