doxygen: add newline after \file
[blender.git] / source / blender / bmesh / intern / bmesh_walkers_private.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BMESH_WALKERS_PRIVATE_H__
18 #define __BMESH_WALKERS_PRIVATE_H__
19
20 /** \file
21  * \ingroup bmesh
22  *
23  * BMesh walker API.
24  */
25
26 extern BMWalker *bm_walker_types[];
27 extern const int bm_totwalkers;
28
29
30 /* Pointer hiding */
31 typedef struct BMwGenericWalker {
32         Link link;
33         int depth;
34 } BMwGenericWalker;
35
36
37 typedef struct BMwShellWalker {
38         BMwGenericWalker header;
39         BMEdge *curedge;
40 } BMwShellWalker;
41
42 typedef struct BMwLoopShellWalker {
43         BMwGenericWalker header;
44         BMLoop *curloop;
45 } BMwLoopShellWalker;
46
47 typedef struct BMwLoopShellWireWalker {
48         BMwGenericWalker header;
49         BMElem *curelem;
50 } BMwLoopShellWireWalker;
51
52 typedef struct BMwIslandboundWalker {
53         BMwGenericWalker header;
54         BMLoop *base;
55         BMVert *lastv;
56         BMLoop *curloop;
57 } BMwIslandboundWalker;
58
59 typedef struct BMwIslandWalker {
60         BMwGenericWalker header;
61         BMFace *cur;
62 } BMwIslandWalker;
63
64 typedef struct BMwEdgeLoopWalker {
65         BMwGenericWalker header;
66         BMEdge *cur, *start;
67         BMVert *lastv, *startv;
68         BMFace *f_hub;
69         bool is_boundary; /* boundary looping changes behavior */
70         bool is_single;  /* single means the edge verts are only connected to 1 face */
71 } BMwEdgeLoopWalker;
72
73 typedef struct BMwFaceLoopWalker {
74         BMwGenericWalker header;
75         BMLoop *l;
76         bool no_calc;
77 } BMwFaceLoopWalker;
78
79 typedef struct BMwEdgeringWalker {
80         BMwGenericWalker header;
81         BMLoop *l;
82         BMEdge *wireedge;
83 } BMwEdgeringWalker;
84
85 typedef struct BMwEdgeboundaryWalker {
86         BMwGenericWalker header;
87         BMEdge *e;
88 } BMwEdgeboundaryWalker;
89
90 typedef struct BMwUVEdgeWalker {
91         BMwGenericWalker header;
92         BMLoop *l;
93 } BMwUVEdgeWalker;
94
95 typedef struct BMwConnectedVertexWalker {
96         BMwGenericWalker header;
97         BMVert *curvert;
98 } BMwConnectedVertexWalker;
99
100 #endif /* __BMESH_WALKERS_PRIVATE_H__ */