ea7505bcba42a149941480f339c7b835c4346286
[blender.git] / source / blender / bmesh / bmesh_class.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): Geoffrey Bantle, Levi Schooley, Joseph Eagar.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BMESH_CLASS_H__
24 #define __BMESH_CLASS_H__
25
26 /** \file blender/bmesh/bmesh_class.h
27  *  \ingroup bmesh
28  */
29
30 /* bmesh data structures */
31
32 /* dissable holes for now, these are ifdef'd because they use more memory and cant be saved in DNA currently */
33 // #define USE_BMESH_HOLES
34
35 struct BMesh;
36 struct BMVert;
37 struct BMEdge;
38 struct BMLoop;
39 struct BMFace;
40
41 struct BLI_mempool;
42
43 /* note: it is very important for BMHeader to start with two
44  * pointers. this is a requirement of mempool's method of
45  * iteration.
46  *
47  * hrm. it doesn't but still works ok, remove the comment above? - campbell.
48  */
49
50 // #pragma GCC diagnostic error "-Wpadded"
51
52 /**
53  * BMHeader
54  *
55  * All mesh elements begin with a BMHeader. This structure
56  * hold several types of data
57  *
58  * 1: The type of the element (vert, edge, loop or face)
59  * 2: Persistent "header" flags/markings (smooth, seam, select, hidden, etc)
60  *     note that this is different from the "tool" flags.
61  * 3: Unique ID in the bmesh.
62  * 4: some elements for internal record keeping.
63  */
64 typedef struct BMHeader {
65         void *data; /* customdata layers */
66         int index; /* notes:
67                     * - Use BM_elem_index_get/set macros for index
68                     * - Uninitialized to -1 so we can easily tell its not set.
69                     * - Used for edge/vert/face/loop, check BMesh.elem_index_dirty for valid index values,
70                     *   this is abused by various tools which set it dirty.
71                     * - For loops this is used for sorting during tessellation. */
72
73         char htype;    /* element geometric type (verts/edges/loops/faces) */
74         char hflag;    /* this would be a CD layer, see below */
75
76         /* internal use only!
77          * note,.we are very picky about not bloating this struct
78          * but in this case its padded up to 16 bytes anyway,
79          * so adding a flag here gives no increase in size */
80         char api_flag;
81 //      char _pad;
82 } BMHeader;
83
84 BLI_STATIC_ASSERT((sizeof(BMHeader) <= 16), "BMHeader size has grown!");
85
86 /* note: need some way to specify custom locations for custom data layers.  so we can
87  * make them point directly into structs.  and some way to make it only happen to the
88  * active layer, and properly update when switching active layers.*/
89
90 typedef struct BMVert {
91         BMHeader head;
92         struct BMFlagLayer *oflags; /* keep after header, an array of flags, mostly used by the operator stack */
93
94         float co[3];  /* vertex coordinates */
95         float no[3];  /* vertex normal */
96
97         /* pointer to (any) edge using this vertex (for disk cycles)
98          *
99          * note: some higher level functions set this to different edges that use this vertex,
100          *       which is a bit of an abuse of internal bmesh data but also works OK for now (use with care!).
101          */
102         struct BMEdge *e;
103 } BMVert;
104
105 /* disk link structure, only used by edges */
106 typedef struct BMDiskLink {
107         struct BMEdge *next, *prev;
108 } BMDiskLink;
109
110 typedef struct BMEdge {
111         BMHeader head;
112         struct BMFlagLayer *oflags; /* keep after header, an array of flags, mostly used by the operator stack */
113
114         struct BMVert *v1, *v2;  /* vertices (unordered) */
115
116         /* the list of loops around the edge (use l->radial_prev/next)
117          * to access the other loops using the edge */
118         struct BMLoop *l;
119         
120         /* disk cycle pointers
121          * relative data: d1 indicates indicates the next/prev edge around vertex v1 and d2 does the same for v2 */
122         BMDiskLink v1_disk_link, v2_disk_link;
123 } BMEdge;
124
125 typedef struct BMLoop {
126         BMHeader head;
127         /* notice no flags layer */
128
129         struct BMVert *v;
130         struct BMEdge *e; /* edge, using verts (v, next->v) */
131         struct BMFace *f;
132
133         /* circular linked list of loops which all use the same edge as this one '->e',
134          * but not necessarily the same vertex (can be either v1 or v2 of our own '->e') */
135         struct BMLoop *radial_next, *radial_prev;
136
137         /* these were originally commented as private but are used all over the code */
138         /* can't use ListBase API, due to head */
139         struct BMLoop *next, *prev; /* next/prev verts around the face */
140 } BMLoop;
141
142 /* can cast BMFace/BMEdge/BMVert, but NOT BMLoop, since these don't have a flag layer */
143 typedef struct BMElemF {
144         BMHeader head;
145
146         /* keep directly after header,
147          * optional array of flags, only used by the operator stack */
148         struct BMFlagLayer *oflags;
149 } BMElemF;
150
151 /* can cast anything to this, including BMLoop */
152 typedef struct BMElem {
153         BMHeader head;
154 } BMElem;
155
156 #ifdef USE_BMESH_HOLES
157 /* eventually, this structure will be used for supporting holes in faces */
158 typedef struct BMLoopList {
159         struct BMLoopList *next, *prev;
160         struct BMLoop *first, *last;
161 } BMLoopList;
162 #endif
163
164 typedef struct BMFace {
165         BMHeader head;
166         struct BMFlagLayer *oflags; /* an array of flags, mostly used by the operator stack */
167
168 #ifdef USE_BMESH_HOLES
169         int totbounds; /*total boundaries, is one plus the number of holes in the face*/
170         ListBase loops;
171 #else
172         BMLoop *l_first;
173 #endif
174         int   len;   /* number of vertices in the face */
175         float no[3];  /* face normal */
176         short mat_nr;  /* material index */
177 //      short _pad[3];
178 } BMFace;
179
180 typedef struct BMFlagLayer {
181         short f; /* flags */
182 } BMFlagLayer;
183
184 // #pragma GCC diagnostic ignored "-Wpadded"
185
186 typedef struct BMesh {
187         int totvert, totedge, totloop, totface;
188         int totvertsel, totedgesel, totfacesel;
189
190         /* flag index arrays as being dirty so we can check if they are clean and
191          * avoid looping over the entire vert/edge/face/loop array in those cases.
192          * valid flags are - BM_VERT | BM_EDGE | BM_FACE | BM_LOOP. */
193         char elem_index_dirty;
194
195         /* flag array table as being dirty so we know when its safe to use it,
196          * or when it needs to be re-created */
197         char elem_table_dirty;
198
199
200         /* element pools */
201         struct BLI_mempool *vpool, *epool, *lpool, *fpool;
202
203         /* mempool lookup tables (optional)
204          * index tables, to map indices to elements via
205          * BM_mesh_elem_table_ensure and associated functions.  don't
206          * touch this or read it directly.\
207          * Use BM_mesh_elem_table_ensure(), BM_vert/edge/face_at_index() */
208         BMVert **vtable;
209         BMEdge **etable;
210         BMFace **ftable;
211
212         /* size of allocated tables */
213         int vtable_tot;
214         int etable_tot;
215         int ftable_tot;
216
217         /* operator api stuff (must be all NULL or all alloc'd) */
218         struct BLI_mempool *vtoolflagpool, *etoolflagpool, *ftoolflagpool;
219
220         int stackdepth;
221         struct BMOperator *currentop;
222         
223         CustomData vdata, edata, ldata, pdata;
224
225 #ifdef USE_BMESH_HOLES
226         struct BLI_mempool *looplistpool;
227 #endif
228
229         /* should be copy of scene select mode */
230         /* stored in BMEditMesh too, this is a bit confusing,
231          * make sure they're in sync!
232          * Only use when the edit mesh cant be accessed - campbell */
233         short selectmode;
234         
235         /* ID of the shape key this bmesh came from */
236         int shapenr;
237         
238         int walkers, totflags;
239         ListBase selected;
240
241         BMFace *act_face;
242
243         ListBase errorstack;
244
245         void *py_handle;
246 } BMesh;
247
248 /* BMHeader->htype (char) */
249 enum {
250         BM_VERT = 1,
251         BM_EDGE = 2,
252         BM_LOOP = 4,
253         BM_FACE = 8
254 };
255
256 #define BM_ALL (BM_VERT | BM_EDGE | BM_LOOP | BM_FACE)
257 #define BM_ALL_NOLOOP (BM_VERT | BM_EDGE | BM_FACE)
258
259 /* BMHeader->hflag (char) */
260 enum {
261         BM_ELEM_SELECT  = (1 << 0),
262         BM_ELEM_HIDDEN  = (1 << 1),
263         BM_ELEM_SEAM    = (1 << 2),
264         BM_ELEM_SMOOTH  = (1 << 3), /* used for faces and edges, note from the user POV,
265                                  * this is a sharp edge when disabled */
266
267         BM_ELEM_TAG     = (1 << 4), /* internal flag, used for ensuring correct normals
268                                  * during multires interpolation, and any other time
269                                  * when temp tagging is handy.
270                                  * always assume dirty & clear before use. */
271
272         BM_ELEM_DRAW    = (1 << 5), /* edge display */
273
274         /* spare tag, assumed dirty, use define in each function to name based on use */
275         // _BM_ELEM_TAG_ALT = (1 << 6),  // UNUSED
276
277         BM_ELEM_INTERNAL_TAG = (1 << 7) /* for low level internal API tagging,
278                                      * since tools may want to tag verts and
279                                      * not have functions clobber them */
280 };
281
282 struct BPy_BMGeneric;
283 extern void bpy_bm_generic_invalidate(struct BPy_BMGeneric *self);
284
285 typedef bool (*BMElemFilterFunc)(BMElem *, void *user_data);
286
287 /* defines */
288 #define BM_ELEM_CD_GET_VOID_P(ele, offset) \
289         (assert(offset != -1), (void *)((char *)(ele)->head.data + (offset)))
290
291 #define BM_ELEM_CD_SET_FLOAT(ele, offset, f) \
292         { assert(offset != -1); *((float *)((char *)(ele)->head.data + (offset))) = (f); } (void)0
293
294 #define BM_ELEM_CD_GET_FLOAT(ele, offset) \
295         (assert(offset != -1), *((float *)((char *)(ele)->head.data + (offset))))
296
297 #define BM_ELEM_CD_GET_FLOAT_AS_UCHAR(ele, offset) \
298         (assert(offset != -1), (unsigned char)(BM_ELEM_CD_GET_FLOAT(ele, offset) * 255.0f))
299
300 /*forward declarations*/
301
302 #ifdef USE_BMESH_HOLES
303 #  define BM_FACE_FIRST_LOOP(p) (((BMLoopList *)((p)->loops.first))->first)
304 #else
305 #  define BM_FACE_FIRST_LOOP(p) ((p)->l_first)
306 #endif
307
308 /**
309  * size to use for stack arrays when dealing with NGons,
310  * alloc after this limit is reached.
311  * this value is rather arbitrary */
312 #define BM_DEFAULT_NGON_STACK_SIZE 32
313 /**
314  * size to use for stack arrays dealing with connected mesh data
315  * verts of faces, edges of vert - etc.
316  * often used with #BM_iter_as_arrayN() */
317 #define BM_DEFAULT_ITER_STACK_SIZE 16
318
319 /* avoid inf loop, this value is arbitrary
320  * but should not error on valid cases */
321 #define BM_LOOP_RADIAL_MAX 10000
322 #define BM_NGON_MAX 100000
323
324 /* setting zero so we can catch bugs in OpenMP/BMesh */
325 #ifdef DEBUG
326 #  define BM_OMP_LIMIT 0
327 #else
328 #  define BM_OMP_LIMIT 10000
329 #endif
330
331 #endif /* __BMESH_CLASS_H__ */