mesh.validate() now returns True if any corrections were made.
[blender.git] / source / blender / blenkernel / intern / mesh_validate.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2011 Blender Foundation.
21  * All rights reserved.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <limits.h>
30
31 #include "DNA_mesh_types.h"
32 #include "DNA_meshdata_types.h"
33
34 #include "BLO_sys_types.h"
35
36 #include "BLI_utildefines.h"
37 #include "BLI_edgehash.h"
38
39 #include "BKE_DerivedMesh.h"
40
41 #include "MEM_guardedalloc.h"
42
43 #include "BKE_mesh.h"
44
45 #define SELECT 1
46
47 typedef struct SortFace {
48         unsigned int v[4];
49         unsigned int index;
50 } SortFace;
51
52 typedef union {
53         uint32_t verts[2];
54         int64_t edval;
55 } EdgeUUID;
56
57 static void edge_store_assign(uint32_t verts[2],  const uint32_t v1, const uint32_t v2)
58 {
59         if(v1 < v2) {
60                 verts[0]= v1;
61                 verts[1]= v2;
62         }
63         else {
64                 verts[0]= v2;
65                 verts[1]= v1;
66         }
67 }
68
69 static void edge_store_from_mface_quad(EdgeUUID es[3], MFace *mf)
70 {
71         edge_store_assign(es[0].verts, mf->v1, mf->v2);
72         edge_store_assign(es[1].verts, mf->v2, mf->v3);
73         edge_store_assign(es[2].verts, mf->v3, mf->v4);
74         edge_store_assign(es[2].verts, mf->v4, mf->v1);
75 }
76
77 static void edge_store_from_mface_tri(EdgeUUID es[3], MFace *mf)
78 {
79         edge_store_assign(es[0].verts, mf->v1, mf->v2);
80         edge_store_assign(es[1].verts, mf->v2, mf->v3);
81         edge_store_assign(es[2].verts, mf->v3, mf->v1);
82 }
83
84 static int uint_cmp(const void *v1, const void *v2)
85 {
86         const unsigned int x1= GET_INT_FROM_POINTER(v1), x2= GET_INT_FROM_POINTER(v2);
87
88         if( x1 > x2 ) return 1;
89         else if( x1 < x2 ) return -1;
90         return 0;
91 }
92
93 static int search_face_cmp(const void *v1, const void *v2)
94 {
95         const SortFace *sfa= v1, *sfb= v2;
96
97         if              (sfa->v[0] > sfb->v[0]) return 1;
98         else if (sfa->v[0] < sfb->v[0]) return -1;
99
100         if              (sfa->v[1] > sfb->v[1]) return 1;
101         else if (sfa->v[1] < sfb->v[1]) return -1;
102
103         if              (sfa->v[2] > sfb->v[2]) return 1;
104         else if (sfa->v[2] < sfb->v[2]) return -1;
105
106         if              (sfa->v[3] > sfb->v[3]) return 1;
107         else if (sfa->v[3] < sfb->v[3]) return -1;
108
109         return 0;
110 }
111
112 int BKE_mesh_validate_arrays(Mesh *me, MVert *UNUSED(mverts), int totvert, MEdge *medges, int totedge, MFace *mfaces, int totface, const short do_verbose, const short do_fixes)
113 {
114 #       define PRINT if(do_verbose) printf
115 #       define REMOVE_EDGE_TAG(_med) { _med->v2= _med->v1; do_edge_free= 1; }
116 #       define REMOVE_FACE_TAG(_mf) { _mf->v3=0; do_face_free= 1; }
117
118 //      MVert *mv;
119         MEdge *med;
120         MFace *mf;
121         int i;
122
123         int do_face_free= FALSE;
124         int do_edge_free= FALSE;
125
126         int do_edge_recalc= FALSE;
127
128         EdgeHash *edge_hash = BLI_edgehash_new();
129
130         SortFace *sort_faces= MEM_callocN(sizeof(SortFace) * totface, "search faces");
131         SortFace *sf;
132         SortFace *sf_prev;
133         int totsortface= 0;
134
135         BLI_assert(!(do_fixes && me == NULL));
136
137         PRINT("ED_mesh_validate: verts(%d), edges(%d), faces(%d)\n", totvert, totedge, totface);
138
139         if(totedge == 0 && totface != 0) {
140                 PRINT("    locical error, %d faces and 0 edges\n", totface);
141                 do_edge_recalc= TRUE;
142         }
143
144         for(i=0, med= medges; i<totedge; i++, med++) {
145                 int remove= FALSE;
146                 if(med->v1 == med->v2) {
147                         PRINT("    edge %d: has matching verts, both %d\n", i, med->v1);
148                         remove= do_fixes;
149                 }
150                 if(med->v1 >= totvert) {
151                         PRINT("    edge %d: v1 index out of range, %d\n", i, med->v1);
152                         remove= do_fixes;
153                 }
154                 if(med->v2 >= totvert) {
155                         PRINT("    edge %d: v2 index out of range, %d\n", i, med->v2);
156                         remove= do_fixes;
157                 }
158
159                 if(BLI_edgehash_haskey(edge_hash, med->v1, med->v2)) {
160                         PRINT("    edge %d: is a duplicate of, %d\n", i, GET_INT_FROM_POINTER(BLI_edgehash_lookup(edge_hash, med->v1, med->v2)));
161                         remove= do_fixes;
162                 }
163
164                 if(remove == FALSE){
165                         BLI_edgehash_insert(edge_hash, med->v1, med->v2, SET_INT_IN_POINTER(i));
166                 }
167                 else {
168                         REMOVE_EDGE_TAG(med);
169                 }
170         }
171
172         for(i=0, mf=mfaces, sf=sort_faces; i<totface; i++, mf++) {
173                 int remove= FALSE;
174                 int fidx;
175
176                 fidx = mf->v4 ? 3:2;
177                 do {
178                         sf->v[fidx]= *(&mf->v1 + fidx);
179                         if(sf->v[fidx] >= totvert) {
180                                 PRINT("    face %d: 'v%d' index out of range, %d\n", i, fidx + 1, sf->v[fidx]);
181                                 remove= do_fixes;
182                         }
183                 } while (fidx--);
184
185                 if(remove == FALSE) {
186                         if(mf->v4) {
187                                 if(mf->v1 == mf->v2) { PRINT("    face %d: verts invalid, v1/v2 both %d\n", i, mf->v1); remove= do_fixes; }
188                                 if(mf->v1 == mf->v3) { PRINT("    face %d: verts invalid, v1/v3 both %d\n", i, mf->v1); remove= do_fixes;  }
189                                 if(mf->v1 == mf->v4) { PRINT("    face %d: verts invalid, v1/v4 both %d\n", i, mf->v1); remove= do_fixes;  }
190
191                                 if(mf->v2 == mf->v3) { PRINT("    face %d: verts invalid, v2/v3 both %d\n", i, mf->v2); remove= do_fixes;  }
192                                 if(mf->v2 == mf->v4) { PRINT("    face %d: verts invalid, v2/v4 both %d\n", i, mf->v2); remove= do_fixes;  }
193
194                                 if(mf->v3 == mf->v4) { PRINT("    face %d: verts invalid, v3/v4 both %d\n", i, mf->v3); remove= do_fixes;  }
195                         }
196                         else {
197                                 if(mf->v1 == mf->v2) { PRINT("    faceT %d: verts invalid, v1/v2 both %d\n", i, mf->v1); remove= do_fixes; }
198                                 if(mf->v1 == mf->v3) { PRINT("    faceT %d: verts invalid, v1/v3 both %d\n", i, mf->v1); remove= do_fixes; }
199
200                                 if(mf->v2 == mf->v3) { PRINT("    faceT %d: verts invalid, v2/v3 both %d\n", i, mf->v2); remove= do_fixes; }
201                         }
202
203                         if(remove == FALSE) {
204                                 if(totedge) {
205                                         if(mf->v4) {
206                                                 if(!BLI_edgehash_haskey(edge_hash, mf->v1, mf->v2)) { PRINT("    face %d: edge v1/v2 (%d,%d) is missing egde data\n", i, mf->v1, mf->v2); do_edge_recalc= TRUE; }
207                                                 if(!BLI_edgehash_haskey(edge_hash, mf->v2, mf->v3)) { PRINT("    face %d: edge v2/v3 (%d,%d) is missing egde data\n", i, mf->v2, mf->v3); do_edge_recalc= TRUE; }
208                                                 if(!BLI_edgehash_haskey(edge_hash, mf->v3, mf->v4)) { PRINT("    face %d: edge v3/v4 (%d,%d) is missing egde data\n", i, mf->v3, mf->v4); do_edge_recalc= TRUE; }
209                                                 if(!BLI_edgehash_haskey(edge_hash, mf->v4, mf->v1)) { PRINT("    face %d: edge v4/v1 (%d,%d) is missing egde data\n", i, mf->v4, mf->v1); do_edge_recalc= TRUE; }
210                                         }
211                                         else {
212                                                 if(!BLI_edgehash_haskey(edge_hash, mf->v1, mf->v2)) { PRINT("    face %d: edge v1/v2 (%d,%d) is missing egde data\n", i, mf->v1, mf->v2); do_edge_recalc= TRUE; }
213                                                 if(!BLI_edgehash_haskey(edge_hash, mf->v2, mf->v3)) { PRINT("    face %d: edge v2/v3 (%d,%d) is missing egde data\n", i, mf->v2, mf->v3); do_edge_recalc= TRUE; }
214                                                 if(!BLI_edgehash_haskey(edge_hash, mf->v3, mf->v1)) { PRINT("    face %d: edge v3/v1 (%d,%d) is missing egde data\n", i, mf->v3, mf->v1); do_edge_recalc= TRUE; }
215                                         }
216                                 }
217
218                                 sort_faces[totsortface].index = i;
219
220                                 if(mf->v4) {
221                                         qsort(sf->v, 4, sizeof(unsigned int), uint_cmp);
222                                 }
223                                 else {
224                                         qsort(sf->v, 3, sizeof(unsigned int), uint_cmp);
225                                         sf->v[3] = UINT_MAX;
226                                 }
227
228                                 totsortface++;
229                                 sf++;
230                         }
231                 }
232                 if(remove) {
233                         REMOVE_FACE_TAG(mf);
234                 }
235         }
236
237         qsort(sort_faces, totsortface, sizeof(SortFace), search_face_cmp);
238
239         sf= sort_faces;
240         sf_prev= sf;
241         sf++;
242
243         for(i=1; i<totsortface; i++, sf++) {
244                 int remove= FALSE;
245                 /* on a valid mesh, code below will never run */
246                 if(memcmp(sf->v, sf_prev->v, sizeof(sf_prev->v)) == 0) {
247                         /* slow, could be smarter here */
248                         MFace *mf= mfaces + sf->index;
249                         MFace *mf_prev= mfaces + sf_prev->index;
250
251                         EdgeUUID eu[4];
252                         EdgeUUID eu_prev[4];
253
254                         if(mf->v4) {
255                                 edge_store_from_mface_quad(eu, mf);
256                                 edge_store_from_mface_quad(eu_prev, mf_prev);
257
258                                 if(
259                                         ELEM4(eu[0].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval, eu_prev[3].edval) &&
260                                         ELEM4(eu[1].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval, eu_prev[3].edval) &&
261                                         ELEM4(eu[2].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval, eu_prev[3].edval) &&
262                                         ELEM4(eu[3].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval, eu_prev[3].edval)
263                                 ) {
264                                         PRINT("    face %d & %d: are duplicates ", sf->index, sf_prev->index);
265                                         PRINT("(%d,%d,%d,%d) ", mf->v1, mf->v2, mf->v3, mf->v4);
266                                         PRINT("(%d,%d,%d,%d)\n", mf_prev->v1, mf_prev->v2, mf_prev->v3, mf_prev->v4);
267                                         remove= do_fixes;
268                                 }
269                         }
270                         else {
271                                 edge_store_from_mface_tri(eu, mf);
272                                 edge_store_from_mface_tri(eu_prev, mf);
273                                 if(
274                                         ELEM3(eu[0].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval) &&
275                                         ELEM3(eu[1].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval) &&
276                                         ELEM3(eu[2].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval)
277                                 ) {
278                                         PRINT("    face %d & %d: are duplicates ", sf->index, sf_prev->index);
279                                         PRINT("(%d,%d,%d) ", mf->v1, mf->v2, mf->v3);
280                                         PRINT("(%d,%d,%d)\n", mf_prev->v1, mf_prev->v2, mf_prev->v3);
281                                         remove= do_fixes;
282                                 }
283                         }
284                 }
285
286                 if(remove) {
287                         REMOVE_FACE_TAG(mf);
288                         /* keep sf_prev incase next face also matches*/
289                 }
290                 else {
291                         sf_prev= sf;
292                 }
293         }
294
295         BLI_edgehash_free(edge_hash, NULL);
296         MEM_freeN(sort_faces);
297
298         PRINT("BKE_mesh_validate: finished\n\n");
299
300 #        undef PRINT
301 #        undef REMOVE_EDGE_TAG
302 #        undef REMOVE_FACE_TAG
303
304         if(me) {
305                 if(do_face_free) {
306                         mesh_strip_loose_faces(me);
307                 }
308
309                 if (do_edge_free) {
310                         mesh_strip_loose_edges(me);
311                 }
312
313                 if(do_fixes && do_edge_recalc) {
314                         BKE_mesh_calc_edges(me, TRUE);
315                 }
316         }
317
318         return (do_face_free || do_edge_free || do_edge_recalc);
319 }
320
321 int BKE_mesh_validate(Mesh *me, int do_verbose)
322 {
323         printf("MESH: %s\n", me->id.name+2);
324         return BKE_mesh_validate_arrays(me, me->mvert, me->totvert, me->medge, me->totedge, me->mface, me->totface, do_verbose, TRUE);
325 }
326
327 int BKE_mesh_validate_dm(DerivedMesh *dm)
328 {
329         return BKE_mesh_validate_arrays(NULL, dm->getVertArray(dm), dm->getNumVerts(dm), dm->getEdgeArray(dm), dm->getNumEdges(dm), dm->getFaceArray(dm), dm->getNumFaces(dm), TRUE, FALSE);
330 }
331
332 void BKE_mesh_calc_edges(Mesh *mesh, int update)
333 {
334         CustomData edata;
335         EdgeHashIterator *ehi;
336         MFace *mf = mesh->mface;
337         MEdge *med, *med_orig;
338         EdgeHash *eh = BLI_edgehash_new();
339         int i, totedge, totface = mesh->totface;
340
341         if(mesh->totedge==0)
342                 update= 0;
343
344         if(update) {
345                 /* assume existing edges are valid
346                  * useful when adding more faces and generating edges from them */
347                 med= mesh->medge;
348                 for(i= 0; i<mesh->totedge; i++, med++)
349                         BLI_edgehash_insert(eh, med->v1, med->v2, med);
350         }
351
352         for (i = 0; i < totface; i++, mf++) {
353                 if (!BLI_edgehash_haskey(eh, mf->v1, mf->v2))
354                         BLI_edgehash_insert(eh, mf->v1, mf->v2, NULL);
355                 if (!BLI_edgehash_haskey(eh, mf->v2, mf->v3))
356                         BLI_edgehash_insert(eh, mf->v2, mf->v3, NULL);
357
358                 if (mf->v4) {
359                         if (!BLI_edgehash_haskey(eh, mf->v3, mf->v4))
360                                 BLI_edgehash_insert(eh, mf->v3, mf->v4, NULL);
361                         if (!BLI_edgehash_haskey(eh, mf->v4, mf->v1))
362                                 BLI_edgehash_insert(eh, mf->v4, mf->v1, NULL);
363                 } else {
364                         if (!BLI_edgehash_haskey(eh, mf->v3, mf->v1))
365                                 BLI_edgehash_insert(eh, mf->v3, mf->v1, NULL);
366                 }
367         }
368
369         totedge = BLI_edgehash_size(eh);
370
371         /* write new edges into a temporary CustomData */
372         memset(&edata, 0, sizeof(edata));
373         CustomData_add_layer(&edata, CD_MEDGE, CD_CALLOC, NULL, totedge);
374
375         ehi = BLI_edgehashIterator_new(eh);
376         med = CustomData_get_layer(&edata, CD_MEDGE);
377         for(i = 0; !BLI_edgehashIterator_isDone(ehi);
378                 BLI_edgehashIterator_step(ehi), ++i, ++med) {
379
380                 if(update && (med_orig=BLI_edgehashIterator_getValue(ehi))) {
381                         *med= *med_orig; /* copy from the original */
382                 } else {
383                         BLI_edgehashIterator_getKey(ehi, (int*)&med->v1, (int*)&med->v2);
384                         med->flag = ME_EDGEDRAW|ME_EDGERENDER|SELECT; /* select for newly created meshes which are selected [#25595] */
385                 }
386         }
387         BLI_edgehashIterator_free(ehi);
388
389         /* free old CustomData and assign new one */
390         CustomData_free(&mesh->edata, mesh->totedge);
391         mesh->edata = edata;
392         mesh->totedge = totedge;
393
394         mesh->medge = CustomData_get_layer(&mesh->edata, CD_MEDGE);
395
396         BLI_edgehash_free(eh, NULL);
397 }