GHash: add BLI_ghashutil_uinthash_v4 for hashing 4 ints at once
[blender.git] / source / blender / bmesh / tools / bmesh_beautify.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Joseph Eagar.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/bmesh/tools/bmesh_beautify.c
24  *  \ingroup bmesh
25  *
26  * Beautify the mesh by rotating edges between triangles
27  * to more attractive positions until no more rotations can be made.
28  *
29  * In principle this is very simple however there is the possibility of
30  * going into an eternal loop where edges keep rotating.
31  * To avoid this - each edge stores a set of it previous
32  * states so as not to rotate back.
33  *
34  * TODO
35  * - Take face normals into account.
36  */
37
38 #include "BLI_math.h"
39 #include "BLI_heap.h"
40
41 #include "MEM_guardedalloc.h"
42
43 #include "bmesh.h"
44 #include "bmesh_beautify.h"  /* own include */
45
46
47 // #define DEBUG_TIME
48
49 #ifdef DEBUG_TIME
50 #  include "PIL_time.h"
51 #  include "PIL_time_utildefines.h"
52 #endif
53
54 /* -------------------------------------------------------------------- */
55 /* GSet for edge rotation */
56
57 typedef struct EdRotState {
58         int v1, v2; /*  edge vert, small -> large */
59         int f1, f2; /*  face vert, small -> large */
60 } EdRotState;
61
62 #if 0
63 /* use BLI_ghashutil_inthash_v4 direct */
64 static unsigned int erot_gsetutil_hash(const void *ptr)
65 {
66         const EdRotState *e_state = (const EdRotState *)ptr;
67         return BLI_ghashutil_inthash_v4(&e_state->v1);
68 }
69 #endif
70 static int erot_gsetutil_cmp(const void *a, const void *b)
71 {
72         const EdRotState *e_state_a = (const EdRotState *)a;
73         const EdRotState *e_state_b = (const EdRotState *)b;
74         if      (e_state_a->v1 < e_state_b->v1) return -1;
75         else if (e_state_a->v1 > e_state_b->v1) return  1;
76         else if (e_state_a->v2 < e_state_b->v2) return -1;
77         else if (e_state_a->v2 > e_state_b->v2) return  1;
78         else if (e_state_a->f1 < e_state_b->f1) return -1;
79         else if (e_state_a->f1 > e_state_b->f1) return  1;
80         else if (e_state_a->f2 < e_state_b->f2) return -1;
81         else if (e_state_a->f2 > e_state_b->f2) return  1;
82         else                                    return  0;
83 }
84
85 static GSet *erot_gset_new(void)
86 {
87         return BLI_gset_new(BLI_ghashutil_inthash_v4_p, erot_gsetutil_cmp, __func__);
88 }
89
90 /* ensure v0 is smaller */
91 #define EDGE_ORD(v0, v1)   \
92         if (v0 > v1) {         \
93                 SWAP(int, v0, v1); \
94         } (void)0
95
96 static void erot_state_ex(const BMEdge *e, int v_index[2], int f_index[2])
97 {
98         BLI_assert(BM_edge_is_manifold((BMEdge *)e));
99         BLI_assert(BM_vert_in_edge(e, e->l->prev->v)              == false);
100         BLI_assert(BM_vert_in_edge(e, e->l->radial_next->prev->v) == false);
101
102         /* verts of the edge */
103         v_index[0] = BM_elem_index_get(e->v1);
104         v_index[1] = BM_elem_index_get(e->v2);
105         EDGE_ORD(v_index[0], v_index[1]);
106
107         /* verts of each of the 2 faces attached to this edge
108          * (that are not apart of this edge) */
109         f_index[0] = BM_elem_index_get(e->l->prev->v);
110         f_index[1] = BM_elem_index_get(e->l->radial_next->prev->v);
111         EDGE_ORD(f_index[0], f_index[1]);
112 }
113
114 static void erot_state_current(const BMEdge *e, EdRotState *e_state)
115 {
116         erot_state_ex(e, &e_state->v1, &e_state->f1);
117 }
118
119 static void erot_state_alternate(const BMEdge *e, EdRotState *e_state)
120 {
121         erot_state_ex(e, &e_state->f1, &e_state->v1);
122 }
123
124 /* -------------------------------------------------------------------- */
125 /* Calculate the improvement of rotating the edge */
126
127 /**
128  * \return a negative value means the edge can be rotated.
129  */
130 static float bm_edge_calc_rotate_beauty__area(
131         const float v1[3], const float v2[3], const float v3[3], const float v4[3])
132 {
133         /* not a loop (only to be able to break out) */
134         do {
135                 float v1_xy[2], v2_xy[2], v3_xy[2], v4_xy[2];
136
137                 /* first get the 2d values */
138                 {
139                         bool is_zero_a, is_zero_b;
140                         float no[3];
141                         float axis_mat[3][3];
142
143                         // printf("%p %p %p %p - %p %p\n", v1, v2, v3, v4, e->l->f, e->l->radial_next->f);
144                         BLI_assert((ELEM3(v1, v2, v3, v4) == false) &&
145                                    (ELEM3(v2, v1, v3, v4) == false) &&
146                                    (ELEM3(v3, v1, v2, v4) == false) &&
147                                    (ELEM3(v4, v1, v2, v3) == false));
148
149                         is_zero_a = area_tri_v3(v2, v3, v4) <= FLT_EPSILON;
150                         is_zero_b = area_tri_v3(v2, v4, v1) <= FLT_EPSILON;
151
152                         if (LIKELY(is_zero_a == false && is_zero_b == false)) {
153                                 float no_a[3], no_b[3];
154                                 normal_tri_v3(no_a, v2, v3, v4);  /* a */
155                                 normal_tri_v3(no_b, v2, v4, v1);  /* b */
156                                 add_v3_v3v3(no, no_a, no_b);
157                                 if (UNLIKELY(normalize_v3(no) <= FLT_EPSILON)) {
158                                         break;
159                                 }
160                         }
161                         else if (is_zero_a == false) {
162                                 normal_tri_v3(no, v2, v3, v4);  /* a */
163                         }
164                         else if (is_zero_b == false) {
165                                 normal_tri_v3(no, v2, v4, v1);  /* b */
166                         }
167                         else {
168                                 /* both zero area, no useful normal can be calculated */
169                                 break;
170                         }
171
172                         // { float a = angle_normalized_v3v3(no_a, no_b); printf("~ %.7f\n", a); fflush(stdout);}
173
174                         axis_dominant_v3_to_m3(axis_mat, no);
175                         mul_v2_m3v3(v1_xy, axis_mat, v1);
176                         mul_v2_m3v3(v2_xy, axis_mat, v2);
177                         mul_v2_m3v3(v3_xy, axis_mat, v3);
178                         mul_v2_m3v3(v4_xy, axis_mat, v4);
179                 }
180
181                 // printf("%p %p %p %p - %p %p\n", v1, v2, v3, v4, e->l->f, e->l->radial_next->f);
182
183                 if (is_quad_convex_v2(v1_xy, v2_xy, v3_xy, v4_xy)) {
184                         /* testing rule: the area divided by the perimeter,
185                          * check if (1-3) beats the existing (2-4) edge rotation */
186                         float area_a, area_b;
187                         float prim_a, prim_b;
188                         float fac_24, fac_13;
189
190                         float len_12, len_23, len_34, len_41, len_24, len_13;
191
192                         /* edges around the quad */
193                         len_12 = len_v2v2(v1_xy, v2_xy);
194                         len_23 = len_v2v2(v2_xy, v3_xy);
195                         len_34 = len_v2v2(v3_xy, v4_xy);
196                         len_41 = len_v2v2(v4_xy, v1_xy);
197                         /* edges crossing the quad interior */
198                         len_13 = len_v2v2(v1_xy, v3_xy);
199                         len_24 = len_v2v2(v2_xy, v4_xy);
200
201                         /* edge (2-4), current state */
202                         area_a = area_tri_v2(v2_xy, v3_xy, v4_xy);
203                         area_b = area_tri_v2(v2_xy, v4_xy, v1_xy);
204                         prim_a = len_23 + len_34 + len_24;
205                         prim_b = len_24 + len_41 + len_12;
206                         fac_24 = (area_a / prim_a) + (area_b / prim_b);
207
208                         /* edge (1-3), new state */
209                         area_a = area_tri_v2(v1_xy, v2_xy, v3_xy);
210                         area_b = area_tri_v2(v1_xy, v3_xy, v4_xy);
211                         prim_a = len_12 + len_23 + len_13;
212                         prim_b = len_34 + len_41 + len_13;
213                         fac_13 = (area_a / prim_a) + (area_b / prim_b);
214
215                         /* negative number if (1-3) is an improved state */
216                         return fac_24 - fac_13;
217                 }
218         } while (false);
219
220         return FLT_MAX;
221 }
222
223 static float bm_edge_calc_rotate_beauty__angle(
224         const float v1[3], const float v2[3], const float v3[3], const float v4[3])
225 {
226         /* not a loop (only to be able to break out) */
227         do {
228                 float no_a[3], no_b[3];
229                 float angle_24, angle_13;
230
231                 /* edge (2-4), current state */
232                 normal_tri_v3(no_a, v2, v3, v4);
233                 normal_tri_v3(no_b, v2, v4, v1);
234                 angle_24 = angle_normalized_v3v3(no_a, no_b);
235
236                 /* edge (1-3), new state */
237                 /* only check new state for degenerate outcome */
238                 if ((normal_tri_v3(no_a, v1, v2, v3) == 0.0f) ||
239                     (normal_tri_v3(no_b, v1, v3, v4) == 0.0f))
240                 {
241                         break;
242                 }
243                 angle_13 = angle_normalized_v3v3(no_a, no_b);
244
245                 return angle_13 - angle_24;
246         } while (false);
247
248         return FLT_MAX;
249 }
250
251 float BM_verts_calc_rotate_beauty(
252 const BMVert *v1, const BMVert *v2, const BMVert *v3, const BMVert *v4, const short flag, const short method)
253 {
254         /* not a loop (only to be able to break out) */
255         do {
256                 if (flag & VERT_RESTRICT_TAG) {
257                         const BMVert *v_a = v1, *v_b = v3;
258                         if (BM_elem_flag_test(v_a, BM_ELEM_TAG) ==  BM_elem_flag_test(v_b, BM_ELEM_TAG)) {
259                                 break;
260                         }
261                 }
262
263                 if (UNLIKELY(v1 == v3)) {
264                         // printf("This should never happen, but does sometimes!\n");
265                         break;
266                 }
267
268                 switch (method) {
269                         case 0:
270                                 return bm_edge_calc_rotate_beauty__area(v1->co, v2->co, v3->co, v4->co);
271                         default:
272                                 return bm_edge_calc_rotate_beauty__angle(v1->co, v2->co, v3->co, v4->co);
273                 }
274         } while (false);
275
276         return FLT_MAX;
277 }
278
279 static float bm_edge_calc_rotate_beauty(const BMEdge *e, const short flag, const short method)
280 {
281         const BMVert *v1, *v2, *v3, *v4;
282         v1 = e->l->prev->v;               /* first vert co */
283         v2 = e->l->v;                     /* e->v1 or e->v2*/
284         v3 = e->l->radial_next->prev->v;  /* second vert co */
285         v4 = e->l->next->v;               /* e->v1 or e->v2*/
286
287         return BM_verts_calc_rotate_beauty(v1, v2, v3, v4, flag, method);
288 }
289
290 /* -------------------------------------------------------------------- */
291 /* Update the edge cost of rotation in the heap */
292
293 BLI_INLINE bool edge_in_array(const BMEdge *e, const BMEdge **edge_array, const int edge_array_len)
294 {
295         const int index = BM_elem_index_get(e);
296         return ((index >= 0) &&
297                 (index < edge_array_len) &&
298                 (e == edge_array[index]));
299 }
300
301 /* recalc an edge in the heap (surrounding geometry has changed) */
302 static void bm_edge_update_beauty_cost_single(BMEdge *e, Heap *eheap, HeapNode **eheap_table, GSet **edge_state_arr,
303                                               /* only for testing the edge is in the array */
304                                               const BMEdge **edge_array, const int edge_array_len,
305
306                                               const short flag, const short method)
307 {
308         if (edge_in_array(e, edge_array, edge_array_len)) {
309                 const int i = BM_elem_index_get(e);
310                 GSet *e_state_set = edge_state_arr[i];
311
312                 if (eheap_table[i]) {
313                         BLI_heap_remove(eheap, eheap_table[i]);
314                         eheap_table[i] = NULL;
315                 }
316
317                 /* check if we can add it back */
318                 BLI_assert(BM_edge_is_manifold(e) == true);
319
320                 /* check we're not moving back into a state we have been in before */
321                 if (e_state_set != NULL) {
322                         EdRotState e_state_alt;
323                         erot_state_alternate(e, &e_state_alt);
324                         if (BLI_gset_haskey(e_state_set, (void *)&e_state_alt)) {
325                                 // printf("  skipping, we already have this state\n");
326                                 return;
327                         }
328                 }
329
330                 {
331                         /* recalculate edge */
332                         const float cost = bm_edge_calc_rotate_beauty(e, flag, method);
333                         if (cost < 0.0f) {
334                                 eheap_table[i] = BLI_heap_insert(eheap, cost, e);
335                         }
336                         else {
337                                 eheap_table[i] = NULL;
338                         }
339                 }
340         }
341 }
342
343 /* we have rotated an edge, tag other edges and clear this one */
344 static void bm_edge_update_beauty_cost(BMEdge *e, Heap *eheap, HeapNode **eheap_table, GSet **edge_state_arr,
345                                        const BMEdge **edge_array, const int edge_array_len,
346                                        /* only for testing the edge is in the array */
347                                        const short flag, const short method)
348 {
349         int i;
350
351         BMEdge *e_arr[4] = {
352             e->l->next->e,
353             e->l->prev->e,
354             e->l->radial_next->next->e,
355             e->l->radial_next->prev->e,
356         };
357
358         BLI_assert(e->l->f->len == 3 &&
359                    e->l->radial_next->f->len == 3);
360
361         BLI_assert(BM_edge_face_count(e) == 2);
362
363         for (i = 0; i < 4; i++) {
364                 bm_edge_update_beauty_cost_single(
365                         e_arr[i],
366                         eheap, eheap_table, edge_state_arr,
367                         edge_array, edge_array_len,
368                         flag, method);
369         }
370 }
371
372 /* -------------------------------------------------------------------- */
373 /* Beautify Fill */
374
375 /**
376  * \note This function sets the edge indices to invalid values.
377  */
378 void BM_mesh_beautify_fill(BMesh *bm, BMEdge **edge_array, const int edge_array_len,
379                                   const short flag, const short method,
380                                   const short oflag_edge, const short oflag_face)
381 {
382         Heap *eheap;             /* edge heap */
383         HeapNode **eheap_table;  /* edge index aligned table pointing to the eheap */
384
385         GSet       **edge_state_arr  = MEM_callocN((size_t)edge_array_len * sizeof(GSet *), __func__);
386         BLI_mempool *edge_state_pool = BLI_mempool_create(sizeof(EdRotState), 0, 512, BLI_MEMPOOL_NOP);
387         int i;
388
389 #ifdef DEBUG_TIME
390         TIMEIT_START(beautify_fill);
391 #endif
392
393         eheap = BLI_heap_new_ex((unsigned int)edge_array_len);
394         eheap_table = MEM_mallocN(sizeof(HeapNode *) * (size_t)edge_array_len, __func__);
395
396         /* build heap */
397         for (i = 0; i < edge_array_len; i++) {
398                 BMEdge *e = edge_array[i];
399                 const float cost = bm_edge_calc_rotate_beauty(e, flag, method);
400                 if (cost < 0.0f) {
401                         eheap_table[i] = BLI_heap_insert(eheap, cost, e);
402                 }
403                 else {
404                         eheap_table[i] = NULL;
405                 }
406
407                 BM_elem_index_set(e, i);  /* set_dirty */
408         }
409         bm->elem_index_dirty |= BM_EDGE;
410
411         while (BLI_heap_is_empty(eheap) == false) {
412                 BMEdge *e = BLI_heap_popmin(eheap);
413                 i = BM_elem_index_get(e);
414                 eheap_table[i] = NULL;
415
416                 BLI_assert(BM_edge_face_count(e) == 2);
417
418                 e = BM_edge_rotate(bm, e, false, BM_EDGEROT_CHECK_EXISTS);
419
420                 BLI_assert(e == NULL || BM_edge_face_count(e) == 2);
421
422                 if (LIKELY(e)) {
423                         GSet *e_state_set = edge_state_arr[i];
424
425                         /* add the new state into the set so we don't move into this state again
426                          * note: we could add the previous state too but this isn't essential)
427                          *       for avoiding eternal loops */
428                         EdRotState *e_state = BLI_mempool_alloc(edge_state_pool);
429                         erot_state_current(e, e_state);
430                         if (UNLIKELY(e_state_set == NULL)) {
431                                 edge_state_arr[i] = e_state_set = erot_gset_new();  /* store previous state */
432                         }
433                         BLI_assert(BLI_gset_haskey(e_state_set, (void *)e_state) == false);
434                         BLI_gset_insert(e_state_set, e_state);
435
436
437                         // printf("  %d -> %d, %d\n", i, BM_elem_index_get(e->v1), BM_elem_index_get(e->v2));
438
439                         /* maintain the index array */
440                         edge_array[i] = e;
441                         BM_elem_index_set(e, i);
442
443                         /* recalculate faces connected on the heap */
444                         bm_edge_update_beauty_cost(e, eheap, eheap_table, edge_state_arr,
445                                                    (const BMEdge **)edge_array, edge_array_len,
446                                                    flag, method);
447
448                         /* update flags */
449                         if (oflag_edge)
450                                 BMO_elem_flag_enable(bm, e, oflag_edge);
451                         if (oflag_face) {
452                                 BMO_elem_flag_enable(bm, e->l->f, oflag_face);
453                                 BMO_elem_flag_enable(bm, e->l->radial_next->f, oflag_face);
454                         }
455                 }
456         }
457
458         BLI_heap_free(eheap, NULL);
459         MEM_freeN(eheap_table);
460
461         for (i = 0; i < edge_array_len; i++) {
462                 if (edge_state_arr[i]) {
463                         BLI_gset_free(edge_state_arr[i], NULL);
464                 }
465         }
466
467         MEM_freeN(edge_state_arr);
468         BLI_mempool_destroy(edge_state_pool);
469
470 #ifdef DEBUG_TIME
471         TIMEIT_END(beautify_fill);
472 #endif
473 }
474