doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / blenkernel / intern / BME_mesh.c
1 /*
2  * BME_mesh.c    jan 2007
3  *
4  *      BMesh mesh level functions.
5  *
6  * $Id$
7  *
8  * ***** BEGIN GPL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  * about this.  
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * The Original Code is Copyright (C) 2007 Blender Foundation.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): Geoffrey Bantle.
31  *
32  * ***** END GPL LICENSE BLOCK *****
33  */
34
35
36 #include "MEM_guardedalloc.h"
37 #include "BKE_bmesh.h"
38 #include "bmesh_private.h"
39
40 /*      
41  *      BME MAKE MESH
42  *
43  *  Allocates a new BME_Mesh structure.
44  *  Returns -
45  *  Pointer to a Bmesh
46  *
47 */
48
49 BME_Mesh *BME_make_mesh(int allocsize[4])
50 {
51         /*allocate the structure*/
52         BME_Mesh *bm = MEM_callocN(sizeof(BME_Mesh),"BMesh");
53         /*allocate the memory pools for the mesh elements*/
54         bm->vpool = BLI_mempool_create(sizeof(BME_Vert), allocsize[0], allocsize[0], 0);
55         bm->epool = BLI_mempool_create(sizeof(BME_Edge), allocsize[1], allocsize[1], 0);
56         bm->lpool = BLI_mempool_create(sizeof(BME_Loop), allocsize[2], allocsize[2], 0);
57         bm->ppool = BLI_mempool_create(sizeof(BME_Poly), allocsize[3], allocsize[3], 0);
58         return bm;
59 }
60 /*      
61  *      BME FREE MESH
62  *
63  *      Frees a BME_Mesh structure.
64 */
65
66 void BME_free_mesh(BME_Mesh *bm)
67 {
68         BME_Vert *v;
69         BME_Edge *e;
70         BME_Loop *l;
71         BME_Poly *f;
72
73         for(v=bm->verts.first; v; v=v->next) CustomData_bmesh_free_block(&bm->vdata, &v->data);
74         for(e=bm->edges.first; e; e=e->next) CustomData_bmesh_free_block(&bm->edata, &e->data);
75         for(f=bm->polys.first; f; f=f->next){
76                 CustomData_bmesh_free_block(&bm->pdata, &f->data);
77                 l = f->loopbase;
78                 do{
79                         CustomData_bmesh_free_block(&bm->ldata, &l->data);
80                         l = l->next;
81                 }while(l!=f->loopbase);
82         }
83
84         /*Free custom data pools, This should probably go in CustomData_free?*/
85         if(bm->vdata.totlayer) BLI_mempool_destroy(bm->vdata.pool);
86         if(bm->edata.totlayer) BLI_mempool_destroy(bm->edata.pool);
87         if(bm->ldata.totlayer) BLI_mempool_destroy(bm->ldata.pool);
88         if(bm->pdata.totlayer) BLI_mempool_destroy(bm->pdata.pool);
89
90          /*free custom data*/
91         CustomData_free(&bm->vdata,0);
92         CustomData_free(&bm->edata,0);
93         CustomData_free(&bm->ldata,0);
94         CustomData_free(&bm->pdata,0);
95
96         /*destroy element pools*/
97         BLI_mempool_destroy(bm->vpool);
98         BLI_mempool_destroy(bm->epool);
99         BLI_mempool_destroy(bm->ppool);
100         BLI_mempool_destroy(bm->lpool);
101         
102         MEM_freeN(bm);  
103 }
104
105 /*      
106  *      BME MODEL BEGIN AND END
107  *
108  *      These two functions represent the 'point of entry' for tools. Every BMesh tool
109  *      must begin with a call to BME_model_end() and finish with a call to BME_model_end().
110  *      No modification of mesh data is allowed except in between these two calls.
111  *
112  *  The purpose of these calls is allow for housekeeping tasks to be performed,
113  *  such as allocating/freeing scratch arrays or performing debug validation of 
114  *  the mesh structure.
115  *
116  *  Returns -
117  *  Nothing
118  *
119 */
120
121 int BME_model_begin(BME_Mesh *bm){
122         /*Initialize some scratch pointer arrays used by eulers*/
123         bm->vtar = MEM_callocN(sizeof(BME_Vert *) * 1024, "BMesh scratch vert array");
124         bm->edar = MEM_callocN(sizeof(BME_Edge *) * 1024, "BMesh scratch edge array");
125         bm->lpar = MEM_callocN(sizeof(BME_Loop *) * 1024, "BMesh scratch loop array");
126         bm->plar = MEM_callocN(sizeof(BME_Poly *) * 1024, "BMesh scratch poly array");
127
128         bm->vtarlen = bm->edarlen = bm->lparlen = bm->plarlen = 1024;
129
130         return 1;
131 }
132
133 void BME_model_end(BME_Mesh *bm){
134         int meshok, totvert, totedge, totpoly;
135
136         totvert = BLI_countlist(&(bm->verts));
137         totedge = BLI_countlist(&(bm->edges));
138         totpoly = BLI_countlist(&(bm->polys));
139
140         if(bm->vtar) MEM_freeN(bm->vtar);
141         if(bm->edar) MEM_freeN(bm->edar);
142         if(bm->lpar) MEM_freeN(bm->lpar);
143         if(bm->plar) MEM_freeN(bm->plar);
144         
145         bm->vtar = NULL;
146         bm->edar = NULL;
147         bm->lpar = NULL;
148         bm->plar = NULL;
149         bm->vtarlen = bm->edarlen = bm->lparlen = bm->plarlen = 0;
150         
151         
152         if(bm->totvert!=totvert || bm->totedge!=totedge || bm->totpoly!=totpoly)
153                 BME_error();
154         
155         meshok = BME_validate_mesh(bm, 1);
156         if(!meshok){
157                 BME_error();
158         }
159 }
160
161 /*      
162  *      BME VALIDATE MESH
163  *
164  *      There are several levels of validation for meshes. At the 
165  *  Euler level, some basic validation is done to local topology.
166  *  To catch more subtle problems however, BME_validate_mesh() is 
167  *  called by BME_model_end() whenever a tool is done executing.
168  *  The purpose of this function is to insure that during the course 
169  *  of tool execution that nothing has been done to invalidate the 
170  *  structure, and if it has, provide a way of reporting that so that
171  *  we can restore the proper structure from a backup. Since a full mesh
172  *  validation would be too expensive, this is presented as a compromise.
173  *
174  *      TODO 
175  *      
176  *      -Make this only part of debug builds
177  */
178
179 #define VHALT(halt) {BME_error(); if(halt) return 0;}
180
181 int BME_validate_mesh(struct BME_Mesh *bm, int halt)
182 {
183         BME_Vert *v;
184         BME_Edge *e;
185         BME_Poly *f;
186         BME_Loop *l;
187         BME_CycleNode *diskbase;
188         int i, ok;
189         
190         /*Simple edge verification*/
191         for(e=bm->edges.first; e; e=e->next){
192                 if(e->v1 == e->v2) VHALT(halt);
193                 /*validate e->d1.data and e->d2.data*/
194                 if(e->d1.data != e || e->d2.data != e) VHALT(halt);
195                 /*validate e->loop->e*/
196                 if(e->loop){
197                         if(e->loop->e != e) VHALT(halt);
198                 }
199         }
200         
201         /*calculate disk cycle lengths*/
202         for(v=bm->verts.first; v; v=v->next) v->tflag1 = v->tflag2 = 0;
203         for(e=bm->edges.first; e; e=e->next){ 
204                 e->v1->tflag1++;
205                 e->v2->tflag1++;
206         }
207         /*Validate vertices and disk cycle*/
208         for(v=bm->verts.first; v; v=v->next){
209                 /*validate v->edge pointer*/
210                 if(v->tflag1){
211                         if(v->edge){
212                                 ok = BME_vert_in_edge(v->edge,v);
213                                 if(!ok) VHALT(halt);
214                                 /*validate length of disk cycle*/
215                                 diskbase = BME_disk_getpointer(v->edge, v);
216                                 ok = BME_cycle_validate(v->tflag1, diskbase);
217                                 if(!ok) VHALT(halt);
218                                 /*validate that each edge in disk cycle contains V*/
219                                 for(i=0, e=v->edge; i < v->tflag1; i++, e = BME_disk_nextedge(e,v)){
220                                         ok = BME_vert_in_edge(e, v);
221                                         if(!ok) VHALT(halt);
222                                 }
223                         }
224                         else VHALT(halt);
225                 }
226         }
227         /*validate edges*/
228         for(e=bm->edges.first; e; e=e->next){
229                 /*seperate these into BME_disk_hasedge (takes pointer to edge)*/
230                 /*search v1 disk cycle for edge*/
231                 ok = BME_disk_hasedge(e->v1,e);
232                 if(!ok) VHALT(halt);
233                 /*search v2 disk cycle for edge*/
234                 ok = BME_disk_hasedge(e->v2,e);
235                 if(!ok) VHALT(halt);
236         }
237         
238         for(e=bm->edges.first; e; e=e->next) e->tflag2 = 0; //store incident faces
239         /*Validate the loop cycle integrity.*/
240         for(f=bm->polys.first; f; f=f->next){
241                 ok = BME_cycle_length(f->loopbase);
242                 if(ok > 1){
243                         f->tflag1 = ok;
244                 }
245                 else VHALT(halt);
246                 for(i=0, l=f->loopbase; i < f->tflag1; i++, l=l->next){
247                         /*verify loop->v pointers*/
248                         ok = BME_verts_in_edge(l->v, l->next->v, l->e);
249                         if(!ok) VHALT(halt);
250                         /*verify radial node data pointer*/
251                         if(l->radial.data != l) VHALT(halt);
252                         /*validate l->e->loop poitner*/
253                         if(l->e->loop == NULL) VHALT(halt);
254                         /*validate l->f pointer*/
255                         if(l->f != f) VHALT(halt);
256                         /*see if l->e->loop is actually in radial cycle*/
257                         
258                         l->e->tflag2++;
259                  }
260         }
261         
262         /*validate length of radial cycle*/
263         for(e=bm->edges.first; e; e=e->next){
264                 if(e->loop){
265                         ok = BME_cycle_validate(e->tflag2,&(e->loop->radial));
266                         if(!ok) VHALT(halt);
267                 }
268         }
269         
270         /*validate that EIDs are within range... if not indicates corrupted mem*/
271
272         /*if we get this far, pretty safe to return 1*/
273         return 1;
274 }
275
276 /*      Currently just a convient place for a breakpoint.
277         Probably should take an error string
278 */
279 void BME_error(void){
280         printf("BME modelling error!");
281 }