Cleanup: remove redundant doxygen \file argument
[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 \ingroup bmesh
21  *
22  * BMesh walker API.
23  */
24
25 extern BMWalker *bm_walker_types[];
26 extern const int bm_totwalkers;
27
28
29 /* Pointer hiding */
30 typedef struct BMwGenericWalker {
31         Link link;
32         int depth;
33 } BMwGenericWalker;
34
35
36 typedef struct BMwShellWalker {
37         BMwGenericWalker header;
38         BMEdge *curedge;
39 } BMwShellWalker;
40
41 typedef struct BMwLoopShellWalker {
42         BMwGenericWalker header;
43         BMLoop *curloop;
44 } BMwLoopShellWalker;
45
46 typedef struct BMwLoopShellWireWalker {
47         BMwGenericWalker header;
48         BMElem *curelem;
49 } BMwLoopShellWireWalker;
50
51 typedef struct BMwIslandboundWalker {
52         BMwGenericWalker header;
53         BMLoop *base;
54         BMVert *lastv;
55         BMLoop *curloop;
56 } BMwIslandboundWalker;
57
58 typedef struct BMwIslandWalker {
59         BMwGenericWalker header;
60         BMFace *cur;
61 } BMwIslandWalker;
62
63 typedef struct BMwEdgeLoopWalker {
64         BMwGenericWalker header;
65         BMEdge *cur, *start;
66         BMVert *lastv, *startv;
67         BMFace *f_hub;
68         bool is_boundary; /* boundary looping changes behavior */
69         bool is_single;  /* single means the edge verts are only connected to 1 face */
70 } BMwEdgeLoopWalker;
71
72 typedef struct BMwFaceLoopWalker {
73         BMwGenericWalker header;
74         BMLoop *l;
75         bool no_calc;
76 } BMwFaceLoopWalker;
77
78 typedef struct BMwEdgeringWalker {
79         BMwGenericWalker header;
80         BMLoop *l;
81         BMEdge *wireedge;
82 } BMwEdgeringWalker;
83
84 typedef struct BMwEdgeboundaryWalker {
85         BMwGenericWalker header;
86         BMEdge *e;
87 } BMwEdgeboundaryWalker;
88
89 typedef struct BMwUVEdgeWalker {
90         BMwGenericWalker header;
91         BMLoop *l;
92 } BMwUVEdgeWalker;
93
94 typedef struct BMwConnectedVertexWalker {
95         BMwGenericWalker header;
96         BMVert *curvert;
97 } BMwConnectedVertexWalker;
98
99 #endif /* __BMESH_WALKERS_PRIVATE_H__ */