bb25d3fabd161b850b0d233c27e447d62b47034b
[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 = 13,
78         BM_LOOPS_OF_EDGE = 14
79 } BMIterType;
80
81 #define BM_ITYPE_MAX 15
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 (ele = BM_iter_new(iter, bm, itype, NULL); ele; ele = BM_iter_step(iter))
88
89 #define BM_ITER_MESH_INDEX(ele, iter, bm, itype, indexvar) \
90         for (ele = BM_iter_new(iter, bm, itype, NULL), indexvar = 0; ele; ele = BM_iter_step(iter), (indexvar)++)
91
92 #define BM_ITER_ELEM(ele, iter, data, itype) \
93         for (ele = BM_iter_new(iter, NULL, itype, data); ele; ele = BM_iter_step(iter))
94
95 #define BM_ITER_ELEM_INDEX(ele, iter, data, itype, indexvar) \
96         for (ele = BM_iter_new(iter, NULL, itype, data), indexvar = 0; ele; ele = BM_iter_step(iter), (indexvar)++)
97
98 /* iterator type structs */
99 struct BMIter__vert_of_mesh {
100         BMesh *bm;
101         BLI_mempool_iter pooliter;
102 };
103 struct BMIter__edge_of_mesh {
104         BMesh *bm;
105         BLI_mempool_iter pooliter;
106 };
107 struct BMIter__face_of_mesh {
108         BMesh *bm;
109         BLI_mempool_iter pooliter;
110 };
111 struct BMIter__edge_of_vert {
112         BMVert *vdata;
113         BMEdge *e_first, *e_next;
114 };
115 struct BMIter__face_of_vert {
116         BMVert *vdata;
117         BMLoop *l_first, *l_next;
118         BMEdge *e_first, *e_next;
119 };
120 struct BMIter__loop_of_vert {
121         BMVert *vdata;
122         BMLoop *l_first, *l_next;
123         BMEdge *e_first, *e_next;
124 };
125 struct BMIter__loop_of_edge {
126         BMEdge *edata;
127         BMLoop *l_first, *l_next;
128 };
129 struct BMIter__loop_of_loop {
130         BMLoop *ldata;
131         BMLoop *l_first, *l_next;
132 };
133 struct BMIter__face_of_edge {
134         BMEdge *edata;
135         BMLoop *l_first, *l_next;
136 };
137 struct BMIter__vert_of_edge {
138         BMEdge *edata;
139 };
140 struct BMIter__vert_of_face {
141         BMFace *pdata;
142         BMLoop *l_first, *l_next;
143 };
144 struct BMIter__edge_of_face {
145         BMFace *pdata;
146         BMLoop *l_first, *l_next;
147 };
148 struct BMIter__loop_of_face {
149         BMFace *pdata;
150         BMLoop *l_first, *l_next;
151 };
152
153 typedef void  (*BMIter__begin_cb) (void *);
154 typedef void *(*BMIter__step_cb) (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 */
159 typedef struct BMIter {
160         /* keep union first */
161         union {
162                 struct BMIter__vert_of_mesh vert_of_mesh;
163                 struct BMIter__edge_of_mesh edge_of_mesh;
164                 struct BMIter__face_of_mesh face_of_mesh;
165
166                 struct BMIter__edge_of_vert edge_of_vert;
167                 struct BMIter__face_of_vert face_of_vert;
168                 struct BMIter__loop_of_vert loop_of_vert;
169                 struct BMIter__loop_of_edge loop_of_edge;
170                 struct BMIter__loop_of_loop loop_of_loop;
171                 struct BMIter__face_of_edge face_of_edge;
172                 struct BMIter__vert_of_edge vert_of_edge;
173                 struct BMIter__vert_of_face vert_of_face;
174                 struct BMIter__edge_of_face edge_of_face;
175                 struct BMIter__loop_of_face loop_of_face;
176         } data;
177
178         BMIter__begin_cb begin;
179         BMIter__step_cb step;
180
181         int count;  /* note, only some iterators set this, don't rely on it */
182         char itype;
183 } BMIter;
184
185 void   *BM_iter_at_index(BMesh *bm, const char itype, void *data, int index) ATTR_WARN_UNUSED_RESULT;
186 int     BM_iter_as_array(BMesh *bm, const char itype, void *data, void **array, const int len);
187 void   *BM_iter_as_arrayN(BMesh *bm, const char itype, void *data, int *r_len,
188                           void **stack_array, int stack_array_size) ATTR_WARN_UNUSED_RESULT;
189 int     BMO_iter_as_array(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const char restrictmask,
190                           void **array, const int len);
191 void    *BMO_iter_as_arrayN(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const char restrictmask,
192                             int *r_len,
193                             /* optional args to avoid an alloc (normally stack array) */
194                             void **stack_array, int stack_array_size);
195
196 int     BM_iter_elem_count_flag(const char itype, void *data, const char hflag, const bool value);
197 int     BMO_iter_elem_count_flag(BMesh *bm, const char itype, void *data, const short oflag, const bool value);
198 int     BM_iter_mesh_count_flag(const char itype, BMesh *bm, const char hflag, const bool value);
199
200 /* private for bmesh_iterators_inline.c */
201
202 #define BMITER_CB_DEF(name) \
203         struct BMIter__##name; \
204         void  bmiter__##name##_begin(struct BMIter__##name *iter); \
205         void *bmiter__##name##_step(struct BMIter__##name *iter)
206
207 BMITER_CB_DEF(vert_of_mesh);
208 BMITER_CB_DEF(edge_of_mesh);
209 BMITER_CB_DEF(face_of_mesh);
210 BMITER_CB_DEF(edge_of_vert);
211 BMITER_CB_DEF(face_of_vert);
212 BMITER_CB_DEF(loop_of_vert);
213 BMITER_CB_DEF(loop_of_edge);
214 BMITER_CB_DEF(loop_of_loop);
215 BMITER_CB_DEF(face_of_edge);
216 BMITER_CB_DEF(vert_of_edge);
217 BMITER_CB_DEF(vert_of_face);
218 BMITER_CB_DEF(edge_of_face);
219 BMITER_CB_DEF(loop_of_face);
220
221 #undef BMITER_CB_DEF
222
223 #include "intern/bmesh_iterators_inline.h"
224
225 #endif /* __BMESH_ITERATORS_H__ */