Cycles / Sky Texture:
[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 #include "BLI_ghash.h"
31
32 /*
33  * NOTE: do NOT modify topology while walking a mesh!
34  */
35
36 typedef enum {
37         BMW_DEPTH_FIRST,
38         BMW_BREADTH_FIRST
39 } BMWOrder;
40
41 typedef enum {
42         BMW_FLAG_NOP = 0,
43         BMW_FLAG_TEST_HIDDEN = (1 << 0)
44 } BMWFlag;
45
46 /*Walkers*/
47 typedef struct BMWalker {
48         void  (*begin) (struct BMWalker *walker, void *start);
49         void *(*step)  (struct BMWalker *walker);
50         void *(*yield) (struct BMWalker *walker);
51         int structsize;
52         BMWOrder order;
53         int valid_mask;
54
55         /* runtime */
56         int layer;
57
58         BMesh *bm;
59         BLI_mempool *worklist;
60         ListBase states;
61
62         /* these masks are to be tested against elements BMO_elem_flag_test(),
63          * should never be accessed directly only through BMW_init() and bmw_mask_check_*() functions */
64         short mask_vert;
65         short mask_edge;
66         short mask_face;
67
68         BMWFlag flag;
69
70         GSet *visit_set;
71         GSet *visit_set_alt;
72         int depth;
73 } BMWalker;
74
75 /* define to make BMW_init more clear */
76 #define BMW_MASK_NOP 0
77
78 /* initialize a walker.  searchmask restricts some (not all) walkers to
79  * elements with a specific tool flag set.  flags is specific to each walker.*/
80 void BMW_init(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 /*
97  * example of usage, walking over an island of tool flagged faces:
98  *
99  * BMWalker walker;
100  * BMFace *f;
101  *
102  * BMW_init(&walker, bm, BMW_ISLAND, SOME_OP_FLAG);
103  *
104  * for (f = BMW_begin(&walker, some_start_face); f; f = BMW_step(&walker)) {
105  *     // do something with f
106  * }
107  * BMW_end(&walker);
108  */
109
110 enum {
111         /* walk over connected geometry.  can restrict to a search flag,
112          * or not, it's optional.
113          *
114          * takes a vert as an argument, and spits out edges, restrict flag acts
115          * on the edges as well. */
116         BMW_SHELL,
117         /*walk over an edge loop.  search flag doesn't do anything.*/
118         BMW_LOOP,
119         BMW_FACELOOP,
120         BMW_EDGERING,
121         /* #define BMW_RING     2 */
122         /* walk over uv islands; takes a loop as input.  restrict flag
123          * restricts the walking to loops whose vert has restrict flag set as a
124          * tool flag.
125          *
126          * the flag parameter to BMW_init maps to a loop customdata layer index.
127          */
128         BMW_LOOPDATA_ISLAND,
129         /* walk over an island of flagged faces.  note, that this doesn't work on
130          * non-manifold geometry.  it might be better to rewrite this to extract
131          * boundary info from the island walker, rather then directly walking
132          * over the boundary.  raises an error if it encounters nonmanifold
133          * geometry. */
134         BMW_ISLANDBOUND,
135         /* walk over all faces in an island of tool flagged faces. */
136         BMW_ISLAND,
137         /* walk from a vertex to all connected vertices. */
138         BMW_CONNECTED_VERTEX,
139         /* end of array index enum vals */
140
141         /* do not intitialze function pointers and struct size in BMW_init */
142         BMW_CUSTOM,
143         BMW_MAXWALKERS
144 };
145
146 /* use with BMW_init, so as not to confuse with restrict flags */
147 #define BMW_NIL_LAY  0
148
149 #endif /* __BMESH_WALKERS_H__ */