mesh validation: bugfix for removing doubles, another fix coming...
[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[4], 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[3].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= *(const unsigned int *)v1;
87         const unsigned int x2= *(const unsigned int *)v2;
88
89         if( x1 > x2 ) return 1;
90         else if( x1 < x2 ) return -1;
91         return 0;
92 }
93
94 static int search_face_cmp(const void *v1, const void *v2)
95 {
96         const SortFace *sfa= v1, *sfb= v2;
97
98         if              (sfa->v[0] > sfb->v[0]) return 1;
99         else if (sfa->v[0] < sfb->v[0]) return -1;
100
101         else if (sfa->v[1] > sfb->v[1]) return 1;
102         else if (sfa->v[1] < sfb->v[1]) return -1;
103
104         else if (sfa->v[2] > sfb->v[2]) return 1;
105         else if (sfa->v[2] < sfb->v[2]) return -1;
106
107         else if (sfa->v[3] > sfb->v[3]) return 1;
108         else if (sfa->v[3] < sfb->v[3]) return -1;
109
110 //      else if (sfb->index > sfa->index) return 1;
111 //      else if (sfb->index < sfa->index) return -1;
112         else                                                      return 0;
113
114 }
115
116 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)
117 {
118 #       define PRINT if(do_verbose) printf
119 #       define REMOVE_EDGE_TAG(_med) { _med->v2= _med->v1; do_edge_free= 1; }
120 #       define REMOVE_FACE_TAG(_mf) { _mf->v3=0; do_face_free= 1; }
121
122 //      MVert *mv;
123         MEdge *med;
124         MFace *mf;
125         MFace *mf_prev;
126         int i;
127
128         int do_face_free= FALSE;
129         int do_edge_free= FALSE;
130
131         int do_edge_recalc= FALSE;
132
133         EdgeHash *edge_hash = BLI_edgehash_new();
134
135         SortFace *sort_faces= MEM_callocN(sizeof(SortFace) * totface, "search faces");
136         SortFace *sf;
137         SortFace *sf_prev;
138         int totsortface= 0;
139
140         BLI_assert(!(do_fixes && me == NULL));
141
142         PRINT("ED_mesh_validate: verts(%d), edges(%d), faces(%d)\n", totvert, totedge, totface);
143
144         if(totedge == 0 && totface != 0) {
145                 PRINT("    locical error, %d faces and 0 edges\n", totface);
146                 do_edge_recalc= TRUE;
147         }
148
149         for(i=0, med= medges; i<totedge; i++, med++) {
150                 int remove= FALSE;
151                 if(med->v1 == med->v2) {
152                         PRINT("    edge %d: has matching verts, both %d\n", i, med->v1);
153                         remove= do_fixes;
154                 }
155                 if(med->v1 >= totvert) {
156                         PRINT("    edge %d: v1 index out of range, %d\n", i, med->v1);
157                         remove= do_fixes;
158                 }
159                 if(med->v2 >= totvert) {
160                         PRINT("    edge %d: v2 index out of range, %d\n", i, med->v2);
161                         remove= do_fixes;
162                 }
163
164                 if(BLI_edgehash_haskey(edge_hash, med->v1, med->v2)) {
165                         PRINT("    edge %d: is a duplicate of, %d\n", i, GET_INT_FROM_POINTER(BLI_edgehash_lookup(edge_hash, med->v1, med->v2)));
166                         remove= do_fixes;
167                 }
168
169                 if(remove == FALSE){
170                         BLI_edgehash_insert(edge_hash, med->v1, med->v2, SET_INT_IN_POINTER(i));
171                 }
172                 else {
173                         REMOVE_EDGE_TAG(med);
174                 }
175         }
176
177         for(i=0, mf=mfaces, sf=sort_faces; i<totface; i++, mf++) {
178                 int remove= FALSE;
179                 int fidx;
180
181                 fidx = mf->v4 ? 3:2;
182                 do {
183                         sf->v[fidx]= *(&(mf->v1) + fidx);
184                         if(sf->v[fidx] >= totvert) {
185                                 PRINT("    face %d: 'v%d' index out of range, %d\n", i, fidx + 1, sf->v[fidx]);
186                                 remove= do_fixes;
187                         }
188                 } while (fidx--);
189
190                 if(remove == FALSE) {
191                         if(mf->v4) {
192                                 if(mf->v1 == mf->v2) { PRINT("    face %d: verts invalid, v1/v2 both %d\n", i, mf->v1); remove= do_fixes; }
193                                 if(mf->v1 == mf->v3) { PRINT("    face %d: verts invalid, v1/v3 both %d\n", i, mf->v1); remove= do_fixes;  }
194                                 if(mf->v1 == mf->v4) { PRINT("    face %d: verts invalid, v1/v4 both %d\n", i, mf->v1); remove= do_fixes;  }
195
196                                 if(mf->v2 == mf->v3) { PRINT("    face %d: verts invalid, v2/v3 both %d\n", i, mf->v2); remove= do_fixes;  }
197                                 if(mf->v2 == mf->v4) { PRINT("    face %d: verts invalid, v2/v4 both %d\n", i, mf->v2); remove= do_fixes;  }
198
199                                 if(mf->v3 == mf->v4) { PRINT("    face %d: verts invalid, v3/v4 both %d\n", i, mf->v3); remove= do_fixes;  }
200                         }
201                         else {
202                                 if(mf->v1 == mf->v2) { PRINT("    faceT %d: verts invalid, v1/v2 both %d\n", i, mf->v1); remove= do_fixes; }
203                                 if(mf->v1 == mf->v3) { PRINT("    faceT %d: verts invalid, v1/v3 both %d\n", i, mf->v1); remove= do_fixes; }
204
205                                 if(mf->v2 == mf->v3) { PRINT("    faceT %d: verts invalid, v2/v3 both %d\n", i, mf->v2); remove= do_fixes; }
206                         }
207
208                         if(remove == FALSE) {
209                                 if(totedge) {
210                                         if(mf->v4) {
211                                                 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; }
212                                                 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; }
213                                                 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; }
214                                                 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; }
215                                         }
216                                         else {
217                                                 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; }
218                                                 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; }
219                                                 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; }
220                                         }
221                                 }
222
223                                 sf->index = i;
224
225                                 if(mf->v4) {
226                                         qsort(sf->v, 4, sizeof(unsigned int), uint_cmp);
227                                 }
228                                 else {
229                                         qsort(sf->v, 3, sizeof(unsigned int), uint_cmp);
230                                         sf->v[3] = UINT_MAX;
231                                 }
232
233                                 totsortface++;
234                                 sf++;
235                         }
236                 }
237                 if(remove) {
238                         REMOVE_FACE_TAG(mf);
239                 }
240         }
241
242         qsort(sort_faces, totsortface, sizeof(SortFace), search_face_cmp);
243
244         sf= sort_faces;
245         sf_prev= sf;
246         sf++;
247
248         for(i=1; i<totsortface; i++, sf++) {
249                 int remove= FALSE;
250                 /* on a valid mesh, code below will never run */
251                 if(memcmp(sf->v, sf_prev->v, sizeof(sf_prev->v)) == 0) {
252                         /* slow, could be smarter here */
253                         EdgeUUID eu[4];
254                         EdgeUUID eu_prev[4];
255
256                         mf= mfaces + sf->index;
257                         mf_prev= mfaces + sf_prev->index;
258
259                         if(mf->v4) {
260                                 edge_store_from_mface_quad(eu, mf);
261                                 edge_store_from_mface_quad(eu_prev, mf_prev);
262
263                                 if(
264                                         ELEM4(eu[0].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval, eu_prev[3].edval) &&
265                                         ELEM4(eu[1].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval, eu_prev[3].edval) &&
266                                         ELEM4(eu[2].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval, eu_prev[3].edval) &&
267                                         ELEM4(eu[3].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval, eu_prev[3].edval)
268                                 ) {
269                                         PRINT("    face %d & %d: are duplicates ", sf->index, sf_prev->index);
270                                         PRINT("(%d,%d,%d,%d) ", mf->v1, mf->v2, mf->v3, mf->v4);
271                                         PRINT("(%d,%d,%d,%d)\n", mf_prev->v1, mf_prev->v2, mf_prev->v3, mf_prev->v4);
272                                         remove= do_fixes;
273                                 }
274                         }
275                         else {
276                                 edge_store_from_mface_tri(eu, mf);
277                                 edge_store_from_mface_tri(eu_prev, mf_prev);
278                                 if(
279                                         ELEM3(eu[0].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval) &&
280                                         ELEM3(eu[1].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval) &&
281                                         ELEM3(eu[2].edval, eu_prev[0].edval, eu_prev[1].edval, eu_prev[2].edval)
282                                 ) {
283                                         PRINT("    face %d & %d: are duplicates ", sf->index, sf_prev->index);
284                                         PRINT("(%d,%d,%d) ", mf->v1, mf->v2, mf->v3);
285                                         PRINT("(%d,%d,%d)\n", mf_prev->v1, mf_prev->v2, mf_prev->v3);
286                                         remove= do_fixes;
287                                 }
288                         }
289                 }
290
291                 if(remove) {
292                         REMOVE_FACE_TAG(mf);
293                         /* keep sf_prev incase next face also matches*/
294                 }
295                 else {
296                         sf_prev= sf;
297                 }
298         }
299
300         BLI_edgehash_free(edge_hash, NULL);
301         MEM_freeN(sort_faces);
302
303         PRINT("BKE_mesh_validate: finished\n\n");
304
305 #        undef PRINT
306 #        undef REMOVE_EDGE_TAG
307 #        undef REMOVE_FACE_TAG
308
309         if(me) {
310                 if(do_face_free) {
311                         mesh_strip_loose_faces(me);
312                 }
313
314                 if (do_edge_free) {
315                         mesh_strip_loose_edges(me);
316                 }
317
318                 if(do_fixes && do_edge_recalc) {
319                         BKE_mesh_calc_edges(me, TRUE);
320                 }
321         }
322
323         return (do_face_free || do_edge_free || do_edge_recalc);
324 }
325
326 int BKE_mesh_validate(Mesh *me, int do_verbose)
327 {
328         printf("MESH: %s\n", me->id.name+2);
329         return BKE_mesh_validate_arrays(me, me->mvert, me->totvert, me->medge, me->totedge, me->mface, me->totface, do_verbose, TRUE);
330 }
331
332 int BKE_mesh_validate_dm(DerivedMesh *dm)
333 {
334         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);
335 }
336
337 void BKE_mesh_calc_edges(Mesh *mesh, int update)
338 {
339         CustomData edata;
340         EdgeHashIterator *ehi;
341         MFace *mf = mesh->mface;
342         MEdge *med, *med_orig;
343         EdgeHash *eh = BLI_edgehash_new();
344         int i, totedge, totface = mesh->totface;
345
346         if(mesh->totedge==0)
347                 update= 0;
348
349         if(update) {
350                 /* assume existing edges are valid
351                  * useful when adding more faces and generating edges from them */
352                 med= mesh->medge;
353                 for(i= 0; i<mesh->totedge; i++, med++)
354                         BLI_edgehash_insert(eh, med->v1, med->v2, med);
355         }
356
357         for (i = 0; i < totface; i++, mf++) {
358                 if (!BLI_edgehash_haskey(eh, mf->v1, mf->v2))
359                         BLI_edgehash_insert(eh, mf->v1, mf->v2, NULL);
360                 if (!BLI_edgehash_haskey(eh, mf->v2, mf->v3))
361                         BLI_edgehash_insert(eh, mf->v2, mf->v3, NULL);
362
363                 if (mf->v4) {
364                         if (!BLI_edgehash_haskey(eh, mf->v3, mf->v4))
365                                 BLI_edgehash_insert(eh, mf->v3, mf->v4, NULL);
366                         if (!BLI_edgehash_haskey(eh, mf->v4, mf->v1))
367                                 BLI_edgehash_insert(eh, mf->v4, mf->v1, NULL);
368                 } else {
369                         if (!BLI_edgehash_haskey(eh, mf->v3, mf->v1))
370                                 BLI_edgehash_insert(eh, mf->v3, mf->v1, NULL);
371                 }
372         }
373
374         totedge = BLI_edgehash_size(eh);
375
376         /* write new edges into a temporary CustomData */
377         memset(&edata, 0, sizeof(edata));
378         CustomData_add_layer(&edata, CD_MEDGE, CD_CALLOC, NULL, totedge);
379
380         ehi = BLI_edgehashIterator_new(eh);
381         med = CustomData_get_layer(&edata, CD_MEDGE);
382         for(i = 0; !BLI_edgehashIterator_isDone(ehi);
383                 BLI_edgehashIterator_step(ehi), ++i, ++med) {
384
385                 if(update && (med_orig=BLI_edgehashIterator_getValue(ehi))) {
386                         *med= *med_orig; /* copy from the original */
387                 } else {
388                         BLI_edgehashIterator_getKey(ehi, (int*)&med->v1, (int*)&med->v2);
389                         med->flag = ME_EDGEDRAW|ME_EDGERENDER|SELECT; /* select for newly created meshes which are selected [#25595] */
390                 }
391         }
392         BLI_edgehashIterator_free(ehi);
393
394         /* free old CustomData and assign new one */
395         CustomData_free(&mesh->edata, mesh->totedge);
396         mesh->edata = edata;
397         mesh->totedge = totedge;
398
399         mesh->medge = CustomData_get_layer(&mesh->edata, CD_MEDGE);
400
401         BLI_edgehash_free(eh, NULL);
402 }