b2373a069dbc639287c70cc02398556f6ac48261
[blender.git] / source / blender / bmesh / intern / bmesh_walkers.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_WALKERS_H__
24 #define __BMESH_WALKERS_H__
25
26 /** \file blender/bmesh/intern/bmesh_walkers.h
27  *  \ingroup bmesh
28  */
29
30 /*
31  * NOTE: do NOT modify topology while walking a mesh!
32  */
33
34 typedef enum {
35         BMW_DEPTH_FIRST,
36         BMW_BREADTH_FIRST
37 } BMWOrder;
38
39 typedef enum {
40         BMW_FLAG_NOP = 0,
41         BMW_FLAG_TEST_HIDDEN = (1 << 0)
42 } BMWFlag;
43
44 /*Walkers*/
45 typedef struct BMWalker {
46         char    begin_htype;  /* only for validating input */
47         void  (*begin) (struct BMWalker *walker, void *start);
48         void *(*step)  (struct BMWalker *walker);
49         void *(*yield) (struct BMWalker *walker);
50         int structsize;
51         BMWOrder order;
52         int valid_mask;
53
54         /* runtime */
55         int layer;
56
57         BMesh *bm;
58         BLI_mempool *worklist;
59         ListBase states;
60
61         /* these masks are to be tested against elements BMO_elem_flag_test(),
62          * should never be accessed directly only through BMW_init() and bmw_mask_check_*() functions */
63         short mask_vert;
64         short mask_edge;
65         short mask_face;
66
67         BMWFlag flag;
68
69         struct GSet *visit_set;
70         struct GSet *visit_set_alt;
71         int depth;
72 } BMWalker;
73
74 /* define to make BMW_init more clear */
75 #define BMW_MASK_NOP 0
76
77 /* initialize a walker.  searchmask restricts some (not all) walkers to
78  * elements with a specific tool flag set.  flags is specific to each walker.*/
79 void BMW_init(
80         struct BMWalker *walker, BMesh *bm, int type,
81         short mask_vert, short mask_edge, short mask_face,
82         BMWFlag flag,
83         int layer);
84 void *BMW_begin(BMWalker *walker, void *start);
85 void *BMW_step(struct BMWalker *walker);
86 void  BMW_end(struct BMWalker *walker);
87 int   BMW_current_depth(BMWalker *walker);
88
89 /*these are used by custom walkers*/
90 void *BMW_current_state(BMWalker *walker);
91 void *BMW_state_add(BMWalker *walker);
92 void  BMW_state_remove(BMWalker *walker);
93 void *BMW_walk(BMWalker *walker);
94 void  BMW_reset(BMWalker *walker);
95
96 #define BMW_ITER(ele, walker, data) \
97         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BMW_begin(walker, (BM_CHECK_TYPE_ELEM(data), data)); \
98              ele; \
99              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BMW_step(walker))
100
101 /*
102  * example of usage, walking over an island of tool flagged faces:
103  *
104  * BMWalker walker;
105  * BMFace *f;
106  *
107  * BMW_init(&walker, bm, BMW_ISLAND, SOME_OP_FLAG);
108  *
109  * for (f = BMW_begin(&walker, some_start_face); f; f = BMW_step(&walker)) {
110  *     // do something with f
111  * }
112  * BMW_end(&walker);
113  */
114
115 enum {
116         BMW_VERT_SHELL,
117         BMW_LOOP_SHELL,
118         BMW_LOOP_SHELL_WIRE,
119         BMW_FACE_SHELL,
120         BMW_EDGELOOP,
121         BMW_FACELOOP,
122         BMW_EDGERING,
123         BMW_EDGEBOUNDARY,
124         /* BMW_RING, */
125         BMW_LOOPDATA_ISLAND,
126         BMW_ISLANDBOUND,
127         BMW_ISLAND,
128         BMW_ISLAND_MANIFOLD,
129         BMW_CONNECTED_VERTEX,
130         /* end of array index enum vals */
131
132         /* do not intitialze function pointers and struct size in BMW_init */
133         BMW_CUSTOM,
134         BMW_MAXWALKERS
135 };
136
137 /* use with BMW_init, so as not to confuse with restrict flags */
138 #define BMW_NIL_LAY  0
139
140 #endif /* __BMESH_WALKERS_H__ */