doxygen: prevent GPL license block from being parsed as doxygen comment.
[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 union {
48         uint32_t verts[2];
49         int64_t edval;
50 } EdgeUUID;
51
52 typedef struct SortFace {
53 //      unsigned int    v[4];
54         EdgeUUID                es[4];
55         unsigned int    index;
56 } SortFace;
57
58 static void edge_store_assign(uint32_t verts[2],  const uint32_t v1, const uint32_t v2)
59 {
60         if(v1 < v2) {
61                 verts[0]= v1;
62                 verts[1]= v2;
63         }
64         else {
65                 verts[0]= v2;
66                 verts[1]= v1;
67         }
68 }
69
70 static void edge_store_from_mface_quad(EdgeUUID es[4], MFace *mf)
71 {
72         edge_store_assign(es[0].verts, mf->v1, mf->v2);
73         edge_store_assign(es[1].verts, mf->v2, mf->v3);
74         edge_store_assign(es[2].verts, mf->v3, mf->v4);
75         edge_store_assign(es[3].verts, mf->v4, mf->v1);
76 }
77
78 static void edge_store_from_mface_tri(EdgeUUID es[3], MFace *mf)
79 {
80         edge_store_assign(es[0].verts, mf->v1, mf->v2);
81         edge_store_assign(es[1].verts, mf->v2, mf->v3);
82         edge_store_assign(es[2].verts, mf->v3, mf->v1);
83         es[3].verts[0] = es[3].verts[1] = UINT_MAX;
84 }
85
86 static int int64_cmp(const void *v1, const void *v2)
87 {
88         const int64_t x1= *(const int64_t *)v1;
89         const int64_t x2= *(const int64_t *)v2;
90
91         if( x1 > x2 ) return 1;
92         else if( x1 < x2 ) return -1;
93         return 0;
94 }
95
96 static int search_face_cmp(const void *v1, const void *v2)
97 {
98         const SortFace *sfa= v1, *sfb= v2;
99
100         if      (sfa->es[0].edval > sfb->es[0].edval) return 1;
101         else if (sfa->es[0].edval < sfb->es[0].edval) return -1;
102
103         else if (sfa->es[1].edval > sfb->es[1].edval) return 1;
104         else if (sfa->es[1].edval < sfb->es[1].edval) return -1;
105
106         else if (sfa->es[2].edval > sfb->es[2].edval) return 1;
107         else if (sfa->es[2].edval < sfb->es[2].edval) return -1;
108
109         else if (sfa->es[3].edval > sfb->es[3].edval) return 1;
110         else if (sfa->es[3].edval < sfb->es[3].edval) return -1;
111         else                                                                              return 0;
112
113 }
114
115 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)
116 {
117 #       define PRINT if(do_verbose) printf
118 #       define REMOVE_EDGE_TAG(_med) { _med->v2= _med->v1; do_edge_free= 1; }
119 #       define REMOVE_FACE_TAG(_mf) { _mf->v3=0; do_face_free= 1; }
120
121 //      MVert *mv;
122         MEdge *med;
123         MFace *mf;
124         MFace *mf_prev;
125         int i;
126
127         int do_face_free= FALSE;
128         int do_edge_free= FALSE;
129
130         int do_edge_recalc= FALSE;
131
132         EdgeHash *edge_hash = BLI_edgehash_new();
133
134         SortFace *sort_faces= MEM_callocN(sizeof(SortFace) * totface, "search faces");
135         SortFace *sf;
136         SortFace *sf_prev;
137         int totsortface= 0;
138
139         BLI_assert(!(do_fixes && me == NULL));
140
141         PRINT("ED_mesh_validate: verts(%d), edges(%d), faces(%d)\n", totvert, totedge, totface);
142
143         if(totedge == 0 && totface != 0) {
144                 PRINT("    locical error, %d faces and 0 edges\n", totface);
145                 do_edge_recalc= TRUE;
146         }
147
148         for(i=0, med= medges; i<totedge; i++, med++) {
149                 int remove= FALSE;
150                 if(med->v1 == med->v2) {
151                         PRINT("    edge %d: has matching verts, both %d\n", i, med->v1);
152                         remove= do_fixes;
153                 }
154                 if(med->v1 >= totvert) {
155                         PRINT("    edge %d: v1 index out of range, %d\n", i, med->v1);
156                         remove= do_fixes;
157                 }
158                 if(med->v2 >= totvert) {
159                         PRINT("    edge %d: v2 index out of range, %d\n", i, med->v2);
160                         remove= do_fixes;
161                 }
162
163                 if(BLI_edgehash_haskey(edge_hash, med->v1, med->v2)) {
164                         PRINT("    edge %d: is a duplicate of, %d\n", i, GET_INT_FROM_POINTER(BLI_edgehash_lookup(edge_hash, med->v1, med->v2)));
165                         remove= do_fixes;
166                 }
167
168                 if(remove == FALSE){
169                         BLI_edgehash_insert(edge_hash, med->v1, med->v2, SET_INT_IN_POINTER(i));
170                 }
171                 else {
172                         REMOVE_EDGE_TAG(med);
173                 }
174         }
175
176         for(i=0, mf=mfaces, sf=sort_faces; i<totface; i++, mf++) {
177                 int remove= FALSE;
178                 int fidx;
179                 unsigned int fv[4];
180
181                 fidx = mf->v4 ? 3:2;
182                 do {
183                         fv[fidx]= *(&(mf->v1) + fidx);
184                         if(fv[fidx] >= totvert) {
185                                 PRINT("    face %d: 'v%d' index out of range, %d\n", i, fidx + 1, fv[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                                         edge_store_from_mface_quad(sf->es, mf);
227
228                                         qsort(sf->es, 4, sizeof(int64_t), int64_cmp);
229                                 }
230                                 else {
231                                         edge_store_from_mface_tri(sf->es, mf);
232                                         qsort(sf->es, 3, sizeof(int64_t), int64_cmp);
233                                 }
234
235                                 totsortface++;
236                                 sf++;
237                         }
238                 }
239                 if(remove) {
240                         REMOVE_FACE_TAG(mf);
241                 }
242         }
243
244         qsort(sort_faces, totsortface, sizeof(SortFace), search_face_cmp);
245
246         sf= sort_faces;
247         sf_prev= sf;
248         sf++;
249
250         for(i=1; i<totsortface; i++, sf++) {
251                 int remove= FALSE;
252                 /* on a valid mesh, code below will never run */
253                 if(memcmp(sf->es, sf_prev->es, sizeof(sf_prev->es)) == 0) {
254                         mf= mfaces + sf->index;
255
256                         if(do_verbose) {
257                                 mf_prev= mfaces + sf_prev->index;
258                                 if(mf->v4) {
259                                         PRINT("    face %d & %d: are duplicates (%d,%d,%d,%d) (%d,%d,%d,%d)\n", sf->index, sf_prev->index, mf->v1, mf->v2, mf->v3, mf->v4, mf_prev->v1, mf_prev->v2, mf_prev->v3, mf_prev->v4);
260                                 }
261                                 else {
262                                         PRINT("    face %d & %d: are duplicates (%d,%d,%d) (%d,%d,%d)\n", sf->index, sf_prev->index, mf->v1, mf->v2, mf->v3, mf_prev->v1, mf_prev->v2, mf_prev->v3);
263                                 }
264                         }
265
266                         remove= do_fixes;
267                 }
268                 else {
269                         sf_prev= sf;
270                 }
271
272                 if(remove) {
273                         REMOVE_FACE_TAG(mf);
274                 }
275         }
276
277         BLI_edgehash_free(edge_hash, NULL);
278         MEM_freeN(sort_faces);
279
280         PRINT("BKE_mesh_validate: finished\n\n");
281
282 #        undef PRINT
283 #        undef REMOVE_EDGE_TAG
284 #        undef REMOVE_FACE_TAG
285
286         if(me) {
287                 if(do_face_free) {
288                         mesh_strip_loose_faces(me);
289                 }
290
291                 if (do_edge_free) {
292                         mesh_strip_loose_edges(me);
293                 }
294
295                 if(do_fixes && do_edge_recalc) {
296                         BKE_mesh_calc_edges(me, TRUE);
297                 }
298         }
299
300         return (do_face_free || do_edge_free || do_edge_recalc);
301 }
302
303 int BKE_mesh_validate(Mesh *me, int do_verbose)
304 {
305         printf("MESH: %s\n", me->id.name+2);
306         return BKE_mesh_validate_arrays(me, me->mvert, me->totvert, me->medge, me->totedge, me->mface, me->totface, do_verbose, TRUE);
307 }
308
309 int BKE_mesh_validate_dm(DerivedMesh *dm)
310 {
311         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);
312 }
313
314 void BKE_mesh_calc_edges(Mesh *mesh, int update)
315 {
316         CustomData edata;
317         EdgeHashIterator *ehi;
318         MFace *mf = mesh->mface;
319         MEdge *med, *med_orig;
320         EdgeHash *eh = BLI_edgehash_new();
321         int i, totedge, totface = mesh->totface;
322
323         if(mesh->totedge==0)
324                 update= 0;
325
326         if(update) {
327                 /* assume existing edges are valid
328                  * useful when adding more faces and generating edges from them */
329                 med= mesh->medge;
330                 for(i= 0; i<mesh->totedge; i++, med++)
331                         BLI_edgehash_insert(eh, med->v1, med->v2, med);
332         }
333
334         for (i = 0; i < totface; i++, mf++) {
335                 if (!BLI_edgehash_haskey(eh, mf->v1, mf->v2))
336                         BLI_edgehash_insert(eh, mf->v1, mf->v2, NULL);
337                 if (!BLI_edgehash_haskey(eh, mf->v2, mf->v3))
338                         BLI_edgehash_insert(eh, mf->v2, mf->v3, NULL);
339
340                 if (mf->v4) {
341                         if (!BLI_edgehash_haskey(eh, mf->v3, mf->v4))
342                                 BLI_edgehash_insert(eh, mf->v3, mf->v4, NULL);
343                         if (!BLI_edgehash_haskey(eh, mf->v4, mf->v1))
344                                 BLI_edgehash_insert(eh, mf->v4, mf->v1, NULL);
345                 } else {
346                         if (!BLI_edgehash_haskey(eh, mf->v3, mf->v1))
347                                 BLI_edgehash_insert(eh, mf->v3, mf->v1, NULL);
348                 }
349         }
350
351         totedge = BLI_edgehash_size(eh);
352
353         /* write new edges into a temporary CustomData */
354         memset(&edata, 0, sizeof(edata));
355         CustomData_add_layer(&edata, CD_MEDGE, CD_CALLOC, NULL, totedge);
356
357         ehi = BLI_edgehashIterator_new(eh);
358         med = CustomData_get_layer(&edata, CD_MEDGE);
359         for(i = 0; !BLI_edgehashIterator_isDone(ehi);
360                 BLI_edgehashIterator_step(ehi), ++i, ++med) {
361
362                 if(update && (med_orig=BLI_edgehashIterator_getValue(ehi))) {
363                         *med= *med_orig; /* copy from the original */
364                 } else {
365                         BLI_edgehashIterator_getKey(ehi, (int*)&med->v1, (int*)&med->v2);
366                         med->flag = ME_EDGEDRAW|ME_EDGERENDER|SELECT; /* select for newly created meshes which are selected [#25595] */
367                 }
368         }
369         BLI_edgehashIterator_free(ehi);
370
371         /* free old CustomData and assign new one */
372         CustomData_free(&mesh->edata, mesh->totedge);
373         mesh->edata = edata;
374         mesh->totedge = totedge;
375
376         mesh->medge = CustomData_get_layer(&mesh->edata, CD_MEDGE);
377
378         BLI_edgehash_free(eh, NULL);
379 }