Mempool: delay allocating an initial chunk, its not always used
[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 static unsigned int erot_gsetutil_hash(const void *ptr)
63 {
64         const EdRotState *e_state = (const EdRotState *)ptr;
65         unsigned int
66         hash  = BLI_ghashutil_inthash(SET_INT_IN_POINTER(e_state->v1));
67         hash ^= BLI_ghashutil_inthash(SET_INT_IN_POINTER(e_state->v2));
68         hash ^= BLI_ghashutil_inthash(SET_INT_IN_POINTER(e_state->f1));
69         hash ^= BLI_ghashutil_inthash(SET_INT_IN_POINTER(e_state->f2));
70         return hash;
71 }
72 static int erot_gsetutil_cmp(const void *a, const void *b)
73 {
74         const EdRotState *e_state_a = (const EdRotState *)a;
75         const EdRotState *e_state_b = (const EdRotState *)b;
76         if      (e_state_a->v1 < e_state_b->v1) return -1;
77         else if (e_state_a->v1 > e_state_b->v1) return  1;
78         else if (e_state_a->v2 < e_state_b->v2) return -1;
79         else if (e_state_a->v2 > e_state_b->v2) return  1;
80         else if (e_state_a->f1 < e_state_b->f1) return -1;
81         else if (e_state_a->f1 > e_state_b->f1) return  1;
82         else if (e_state_a->f2 < e_state_b->f2) return -1;
83         else if (e_state_a->f2 > e_state_b->f2) return  1;
84         else                                    return  0;
85 }
86
87 static GSet *erot_gset_new(void)
88 {
89         return BLI_gset_new(erot_gsetutil_hash, erot_gsetutil_cmp, __func__);
90 }
91
92 /* ensure v0 is smaller */
93 #define EDGE_ORD(v0, v1)   \
94         if (v0 > v1) {         \
95                 SWAP(int, v0, v1); \
96         } (void)0
97
98 static void erot_state_ex(const BMEdge *e, int v_index[2], int f_index[2])
99 {
100         BLI_assert(BM_edge_is_manifold((BMEdge *)e));
101         BLI_assert(BM_vert_in_edge(e, e->l->prev->v)              == false);
102         BLI_assert(BM_vert_in_edge(e, e->l->radial_next->prev->v) == false);
103
104         /* verts of the edge */
105         v_index[0] = BM_elem_index_get(e->v1);
106         v_index[1] = BM_elem_index_get(e->v2);
107         EDGE_ORD(v_index[0], v_index[1]);
108
109         /* verts of each of the 2 faces attached to this edge
110          * (that are not apart of this edge) */
111         f_index[0] = BM_elem_index_get(e->l->prev->v);
112         f_index[1] = BM_elem_index_get(e->l->radial_next->prev->v);
113         EDGE_ORD(f_index[0], f_index[1]);
114 }
115
116 static void erot_state_current(const BMEdge *e, EdRotState *e_state)
117 {
118         erot_state_ex(e, &e_state->v1, &e_state->f1);
119 }
120
121 static void erot_state_alternate(const BMEdge *e, EdRotState *e_state)
122 {
123         erot_state_ex(e, &e_state->f1, &e_state->v1);
124 }
125
126 /* -------------------------------------------------------------------- */
127 /* Calculate the improvement of rotating the edge */
128
129 /**
130  * \return a negative value means the edge can be rotated.
131  */
132 static float bm_edge_calc_rotate_beauty__area(
133         const float v1[3], const float v2[3], const float v3[3], const float v4[3])
134 {
135         /* not a loop (only to be able to break out) */
136         do {
137                 float v1_xy[2], v2_xy[2], v3_xy[2], v4_xy[2];
138
139                 /* first get the 2d values */
140                 {
141                         bool is_zero_a, is_zero_b;
142                         float no[3];
143                         float axis_mat[3][3];
144
145                         // printf("%p %p %p %p - %p %p\n", v1, v2, v3, v4, e->l->f, e->l->radial_next->f);
146                         BLI_assert((ELEM3(v1, v2, v3, v4) == false) &&
147                                    (ELEM3(v2, v1, v3, v4) == false) &&
148                                    (ELEM3(v3, v1, v2, v4) == false) &&
149                                    (ELEM3(v4, v1, v2, v3) == false));
150
151                         is_zero_a = area_tri_v3(v2, v3, v4) <= FLT_EPSILON;
152                         is_zero_b = area_tri_v3(v2, v4, v1) <= FLT_EPSILON;
153
154                         if (LIKELY(is_zero_a == false && is_zero_b == false)) {
155                                 float no_a[3], no_b[3];
156                                 normal_tri_v3(no_a, v2, v3, v4);  /* a */
157                                 normal_tri_v3(no_b, v2, v4, v1);  /* b */
158                                 add_v3_v3v3(no, no_a, no_b);
159                                 if (UNLIKELY(normalize_v3(no) <= FLT_EPSILON)) {
160                                         break;
161                                 }
162                         }
163                         else if (is_zero_a == false) {
164                                 normal_tri_v3(no, v2, v3, v4);  /* a */
165                         }
166                         else if (is_zero_b == false) {
167                                 normal_tri_v3(no, v2, v4, v1);  /* b */
168                         }
169                         else {
170                                 /* both zero area, no useful normal can be calculated */
171                                 break;
172                         }
173
174                         // { float a = angle_normalized_v3v3(no_a, no_b); printf("~ %.7f\n", a); fflush(stdout);}
175
176                         axis_dominant_v3_to_m3(axis_mat, no);
177                         mul_v2_m3v3(v1_xy, axis_mat, v1);
178                         mul_v2_m3v3(v2_xy, axis_mat, v2);
179                         mul_v2_m3v3(v3_xy, axis_mat, v3);
180                         mul_v2_m3v3(v4_xy, axis_mat, v4);
181                 }
182
183                 // printf("%p %p %p %p - %p %p\n", v1, v2, v3, v4, e->l->f, e->l->radial_next->f);
184
185                 if (is_quad_convex_v2(v1_xy, v2_xy, v3_xy, v4_xy)) {
186                         /* testing rule: the area divided by the perimeter,
187                          * check if (1-3) beats the existing (2-4) edge rotation */
188                         float area_a, area_b;
189                         float prim_a, prim_b;
190                         float fac_24, fac_13;
191
192                         float len_12, len_23, len_34, len_41, len_24, len_13;
193
194                         /* edges around the quad */
195                         len_12 = len_v2v2(v1_xy, v2_xy);
196                         len_23 = len_v2v2(v2_xy, v3_xy);
197                         len_34 = len_v2v2(v3_xy, v4_xy);
198                         len_41 = len_v2v2(v4_xy, v1_xy);
199                         /* edges crossing the quad interior */
200                         len_13 = len_v2v2(v1_xy, v3_xy);
201                         len_24 = len_v2v2(v2_xy, v4_xy);
202
203                         /* edge (2-4), current state */
204                         area_a = area_tri_v2(v2_xy, v3_xy, v4_xy);
205                         area_b = area_tri_v2(v2_xy, v4_xy, v1_xy);
206                         prim_a = len_23 + len_34 + len_24;
207                         prim_b = len_24 + len_41 + len_12;
208                         fac_24 = (area_a / prim_a) + (area_b / prim_b);
209
210                         /* edge (1-3), new state */
211                         area_a = area_tri_v2(v1_xy, v2_xy, v3_xy);
212                         area_b = area_tri_v2(v1_xy, v3_xy, v4_xy);
213                         prim_a = len_12 + len_23 + len_13;
214                         prim_b = len_34 + len_41 + len_13;
215                         fac_13 = (area_a / prim_a) + (area_b / prim_b);
216
217                         /* negative number if (1-3) is an improved state */
218                         return fac_24 - fac_13;
219                 }
220         } while (false);
221
222         return FLT_MAX;
223 }
224
225 static float bm_edge_calc_rotate_beauty__angle(
226         const float v1[3], const float v2[3], const float v3[3], const float v4[3])
227 {
228         /* not a loop (only to be able to break out) */
229         do {
230                 float no_a[3], no_b[3];
231                 float angle_24, angle_13;
232
233                 /* edge (2-4), current state */
234                 normal_tri_v3(no_a, v2, v3, v4);
235                 normal_tri_v3(no_b, v2, v4, v1);
236                 angle_24 = angle_normalized_v3v3(no_a, no_b);
237
238                 /* edge (1-3), new state */
239                 /* only check new state for degenerate outcome */
240                 if ((normal_tri_v3(no_a, v1, v2, v3) == 0.0f) ||
241                     (normal_tri_v3(no_b, v1, v3, v4) == 0.0f))
242                 {
243                         break;
244                 }
245                 angle_13 = angle_normalized_v3v3(no_a, no_b);
246
247                 return angle_13 - angle_24;
248         } while (false);
249
250         return FLT_MAX;
251 }
252
253 float BM_verts_calc_rotate_beauty(
254 const BMVert *v1, const BMVert *v2, const BMVert *v3, const BMVert *v4, const short flag, const short method)
255 {
256         /* not a loop (only to be able to break out) */
257         do {
258                 if (flag & VERT_RESTRICT_TAG) {
259                         const BMVert *v_a = v1, *v_b = v3;
260                         if (BM_elem_flag_test(v_a, BM_ELEM_TAG) ==  BM_elem_flag_test(v_b, BM_ELEM_TAG)) {
261                                 break;
262                         }
263                 }
264
265                 if (UNLIKELY(v1 == v3)) {
266                         // printf("This should never happen, but does sometimes!\n");
267                         break;
268                 }
269
270                 switch (method) {
271                         case 0:
272                                 return bm_edge_calc_rotate_beauty__area(v1->co, v2->co, v3->co, v4->co);
273                         default:
274                                 return bm_edge_calc_rotate_beauty__angle(v1->co, v2->co, v3->co, v4->co);
275                 }
276         } while (false);
277
278         return FLT_MAX;
279 }
280
281 static float bm_edge_calc_rotate_beauty(const BMEdge *e, const short flag, const short method)
282 {
283         const BMVert *v1, *v2, *v3, *v4;
284         v1 = e->l->prev->v;               /* first vert co */
285         v2 = e->l->v;                     /* e->v1 or e->v2*/
286         v3 = e->l->radial_next->prev->v;  /* second vert co */
287         v4 = e->l->next->v;               /* e->v1 or e->v2*/
288
289         return BM_verts_calc_rotate_beauty(v1, v2, v3, v4, flag, method);
290 }
291
292 /* -------------------------------------------------------------------- */
293 /* Update the edge cost of rotation in the heap */
294
295 BLI_INLINE bool edge_in_array(const BMEdge *e, const BMEdge **edge_array, const int edge_array_len)
296 {
297         const int index = BM_elem_index_get(e);
298         return ((index >= 0) &&
299                 (index < edge_array_len) &&
300                 (e == edge_array[index]));
301 }
302
303 /* recalc an edge in the heap (surrounding geometry has changed) */
304 static void bm_edge_update_beauty_cost_single(BMEdge *e, Heap *eheap, HeapNode **eheap_table, GSet **edge_state_arr,
305                                               /* only for testing the edge is in the array */
306                                               const BMEdge **edge_array, const int edge_array_len,
307
308                                               const short flag, const short method)
309 {
310         if (edge_in_array(e, edge_array, edge_array_len)) {
311                 const int i = BM_elem_index_get(e);
312                 GSet *e_state_set = edge_state_arr[i];
313
314                 if (eheap_table[i]) {
315                         BLI_heap_remove(eheap, eheap_table[i]);
316                         eheap_table[i] = NULL;
317                 }
318
319                 /* check if we can add it back */
320                 BLI_assert(BM_edge_is_manifold(e) == true);
321
322                 /* check we're not moving back into a state we have been in before */
323                 if (e_state_set != NULL) {
324                         EdRotState e_state_alt;
325                         erot_state_alternate(e, &e_state_alt);
326                         if (BLI_gset_haskey(e_state_set, (void *)&e_state_alt)) {
327                                 // printf("  skipping, we already have this state\n");
328                                 return;
329                         }
330                 }
331
332                 {
333                         /* recalculate edge */
334                         const float cost = bm_edge_calc_rotate_beauty(e, flag, method);
335                         if (cost < 0.0f) {
336                                 eheap_table[i] = BLI_heap_insert(eheap, cost, e);
337                         }
338                         else {
339                                 eheap_table[i] = NULL;
340                         }
341                 }
342         }
343 }
344
345 /* we have rotated an edge, tag other edges and clear this one */
346 static void bm_edge_update_beauty_cost(BMEdge *e, Heap *eheap, HeapNode **eheap_table, GSet **edge_state_arr,
347                                        const BMEdge **edge_array, const int edge_array_len,
348                                        /* only for testing the edge is in the array */
349                                        const short flag, const short method)
350 {
351         int i;
352
353         BMEdge *e_arr[4] = {
354             e->l->next->e,
355             e->l->prev->e,
356             e->l->radial_next->next->e,
357             e->l->radial_next->prev->e,
358         };
359
360         BLI_assert(e->l->f->len == 3 &&
361                    e->l->radial_next->f->len == 3);
362
363         BLI_assert(BM_edge_face_count(e) == 2);
364
365         for (i = 0; i < 4; i++) {
366                 bm_edge_update_beauty_cost_single(
367                         e_arr[i],
368                         eheap, eheap_table, edge_state_arr,
369                         edge_array, edge_array_len,
370                         flag, method);
371         }
372 }
373
374 /* -------------------------------------------------------------------- */
375 /* Beautify Fill */
376
377 /**
378  * \note This function sets the edge indices to invalid values.
379  */
380 void BM_mesh_beautify_fill(BMesh *bm, BMEdge **edge_array, const int edge_array_len,
381                                   const short flag, const short method,
382                                   const short oflag_edge, const short oflag_face)
383 {
384         Heap *eheap;             /* edge heap */
385         HeapNode **eheap_table;  /* edge index aligned table pointing to the eheap */
386
387         GSet       **edge_state_arr  = MEM_callocN((size_t)edge_array_len * sizeof(GSet *), __func__);
388         BLI_mempool *edge_state_pool = BLI_mempool_create(sizeof(EdRotState), 0, 512, BLI_MEMPOOL_NOP);
389         int i;
390
391 #ifdef DEBUG_TIME
392         TIMEIT_START(beautify_fill);
393 #endif
394
395         eheap = BLI_heap_new_ex((unsigned int)edge_array_len);
396         eheap_table = MEM_mallocN(sizeof(HeapNode *) * (size_t)edge_array_len, __func__);
397
398         /* build heap */
399         for (i = 0; i < edge_array_len; i++) {
400                 BMEdge *e = edge_array[i];
401                 const float cost = bm_edge_calc_rotate_beauty(e, flag, method);
402                 if (cost < 0.0f) {
403                         eheap_table[i] = BLI_heap_insert(eheap, cost, e);
404                 }
405                 else {
406                         eheap_table[i] = NULL;
407                 }
408
409                 BM_elem_index_set(e, i);  /* set_dirty */
410         }
411         bm->elem_index_dirty |= BM_EDGE;
412
413         while (BLI_heap_is_empty(eheap) == false) {
414                 BMEdge *e = BLI_heap_popmin(eheap);
415                 i = BM_elem_index_get(e);
416                 eheap_table[i] = NULL;
417
418                 BLI_assert(BM_edge_face_count(e) == 2);
419
420                 e = BM_edge_rotate(bm, e, false, BM_EDGEROT_CHECK_EXISTS);
421
422                 BLI_assert(e == NULL || BM_edge_face_count(e) == 2);
423
424                 if (LIKELY(e)) {
425                         GSet *e_state_set = edge_state_arr[i];
426
427                         /* add the new state into the set so we don't move into this state again
428                          * note: we could add the previous state too but this isn't essential)
429                          *       for avoiding eternal loops */
430                         EdRotState *e_state = BLI_mempool_alloc(edge_state_pool);
431                         erot_state_current(e, e_state);
432                         if (UNLIKELY(e_state_set == NULL)) {
433                                 edge_state_arr[i] = e_state_set = erot_gset_new();  /* store previous state */
434                         }
435                         BLI_assert(BLI_gset_haskey(e_state_set, (void *)e_state) == false);
436                         BLI_gset_insert(e_state_set, e_state);
437
438
439                         // printf("  %d -> %d, %d\n", i, BM_elem_index_get(e->v1), BM_elem_index_get(e->v2));
440
441                         /* maintain the index array */
442                         edge_array[i] = e;
443                         BM_elem_index_set(e, i);
444
445                         /* recalculate faces connected on the heap */
446                         bm_edge_update_beauty_cost(e, eheap, eheap_table, edge_state_arr,
447                                                    (const BMEdge **)edge_array, edge_array_len,
448                                                    flag, method);
449
450                         /* update flags */
451                         if (oflag_edge)
452                                 BMO_elem_flag_enable(bm, e, oflag_edge);
453                         if (oflag_face) {
454                                 BMO_elem_flag_enable(bm, e->l->f, oflag_face);
455                                 BMO_elem_flag_enable(bm, e->l->radial_next->f, oflag_face);
456                         }
457                 }
458         }
459
460         BLI_heap_free(eheap, NULL);
461         MEM_freeN(eheap_table);
462
463         for (i = 0; i < edge_array_len; i++) {
464                 if (edge_state_arr[i]) {
465                         BLI_gset_free(edge_state_arr[i], NULL);
466                 }
467         }
468
469         MEM_freeN(edge_state_arr);
470         BLI_mempool_destroy(edge_state_pool);
471
472 #ifdef DEBUG_TIME
473         TIMEIT_END(beautify_fill);
474 #endif
475 }
476