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