Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / intern / polyfill_2d_beautify.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup bli
18  *
19  * This function is to improve the tessellation resulting from polyfill2d,
20  * creating optimal topology.
21  *
22  * The functionality here matches #BM_mesh_beautify_fill,
23  * but its far simpler to perform this operation in 2d,
24  * on a simple polygon representation where we _know_:
25  *
26  * - The polygon is primitive with no holes with a continuous boundary.
27  * - Tris have consistent winding.
28  * - 2d (saves some hassles projecting face pairs on an axis for every edge-rotation)
29  *   also saves us having to store all previous edge-states (see #EdRotState in bmesh_beautify.c)
30  *
31  * \note
32  *
33  * No globals - keep threadsafe.
34  */
35
36 #include "BLI_utildefines.h"
37 #include "BLI_math.h"
38
39 #include "BLI_memarena.h"
40 #include "BLI_heap.h"
41
42 #include "BLI_polyfill_2d_beautify.h"  /* own include */
43
44 #include "BLI_strict_flags.h"
45
46 /* Used to find matching edges. */
47 struct OrderEdge {
48         uint verts[2];
49         uint e_half;
50 };
51
52 /* Half edge used for rotating in-place. */
53 struct HalfEdge {
54         uint v;
55         uint e_next;
56         uint e_radial;
57         uint base_index;
58 };
59
60 static int oedge_cmp(const void *a1, const void *a2)
61 {
62         const struct OrderEdge *x1 = a1, *x2 = a2;
63         if (x1->verts[0] > x2->verts[0]) {
64                 return 1;
65         }
66         else if (x1->verts[0] < x2->verts[0]) {
67                 return -1;
68         }
69
70         if (x1->verts[1] > x2->verts[1]) {
71                 return 1;
72         }
73         else if (x1->verts[1] < x2->verts[1]) {
74                 return -1;
75         }
76
77         /* only for pradictability */
78         if (x1->e_half > x2->e_half) {
79                 return 1;
80         }
81         else if (x1->e_half < x2->e_half) {
82                 return -1;
83         }
84         /* Should never get here, no two edges should be the same. */
85         BLI_assert(false);
86         return 0;
87 }
88
89 BLI_INLINE bool is_boundary_edge(uint i_a, uint i_b, const uint coord_last)
90 {
91         BLI_assert(i_a < i_b);
92         return ((i_a + 1 == i_b) || UNLIKELY((i_a == 0) && (i_b == coord_last)));
93 }
94 /**
95  * Assuming we have 2 triangles sharing an edge (2 - 4),
96  * check if the edge running from (1 - 3) gives better results.
97  *
98  * \param lock_degenerate: Use to avoid rotating out of a degenerate state.
99  * - When true, an existing zero area face on either side of the (2 - 4) split will return a positive value.
100  * - When false, the check must be non-biased towards either split direction.
101  *
102  * \return (negative number means the edge can be rotated, lager == better).
103  */
104 float BLI_polyfill_beautify_quad_rotate_calc_ex(
105         const float v1[2], const float v2[2], const float v3[2], const float v4[2],
106         const bool lock_degenerate)
107 {
108         /* not a loop (only to be able to break out) */
109         do {
110                 /* Allow very small faces to be considered non-zero. */
111                 const float eps_zero_area = 1e-12f;
112                 const float area_2x_234 = cross_tri_v2(v2, v3, v4);
113                 const float area_2x_241 = cross_tri_v2(v2, v4, v1);
114
115                 const float area_2x_123 = cross_tri_v2(v1, v2, v3);
116                 const float area_2x_134 = cross_tri_v2(v1, v3, v4);
117
118                 BLI_assert((ELEM(v1, v2, v3, v4) == false) &&
119                            (ELEM(v2, v1, v3, v4) == false) &&
120                            (ELEM(v3, v1, v2, v4) == false) &&
121                            (ELEM(v4, v1, v2, v3) == false));
122                 /*
123                  * Test for unusable (1-3) state.
124                  * - Area sign flipping to check faces aren't going to point in opposite directions.
125                  * - Area epsilon check that the one of the faces won't be zero area.
126                  */
127                 if ((area_2x_123 >= 0.0f) != (area_2x_134 >= 0.0f)) {
128                         break;
129                 }
130                 else if ((fabsf(area_2x_123) <= eps_zero_area) || (fabsf(area_2x_134) <= eps_zero_area)) {
131                         break;
132                 }
133
134                 /* Test for unusable (2-4) state (same as above). */
135                 if ((area_2x_234 >= 0.0f) != (area_2x_241 >= 0.0f)) {
136                         if (lock_degenerate) {
137                                 break;
138                         }
139                         else {
140                                 return -FLT_MAX;  /* always rotate */
141                         }
142                 }
143                 else if ((fabsf(area_2x_234) <= eps_zero_area) || (fabsf(area_2x_241) <= eps_zero_area)) {
144                         return -FLT_MAX;  /* always rotate */
145                 }
146
147                 {
148                         /* testing rule: the area divided by the perimeter,
149                          * check if (1-3) beats the existing (2-4) edge rotation */
150                         float area_a, area_b;
151                         float prim_a, prim_b;
152                         float fac_24, fac_13;
153
154                         float len_12, len_23, len_34, len_41, len_24, len_13;
155
156                         /* edges around the quad */
157                         len_12 = len_v2v2(v1, v2);
158                         len_23 = len_v2v2(v2, v3);
159                         len_34 = len_v2v2(v3, v4);
160                         len_41 = len_v2v2(v4, v1);
161                         /* edges crossing the quad interior */
162                         len_13 = len_v2v2(v1, v3);
163                         len_24 = len_v2v2(v2, v4);
164
165                         /* note, area is in fact (area * 2),
166                          * but in this case its OK, since we're comparing ratios */
167
168                         /* edge (2-4), current state */
169                         area_a = fabsf(area_2x_234);
170                         area_b = fabsf(area_2x_241);
171                         prim_a = len_23 + len_34 + len_24;
172                         prim_b = len_41 + len_12 + len_24;
173                         fac_24 = (area_a / prim_a) + (area_b / prim_b);
174
175                         /* edge (1-3), new state */
176                         area_a = fabsf(area_2x_123);
177                         area_b = fabsf(area_2x_134);
178                         prim_a = len_12 + len_23 + len_13;
179                         prim_b = len_34 + len_41 + len_13;
180                         fac_13 = (area_a / prim_a) + (area_b / prim_b);
181
182                         /* negative number if (1-3) is an improved state */
183                         return fac_24 - fac_13;
184                 }
185         } while (false);
186
187         return FLT_MAX;
188 }
189
190 static float polyedge_rotate_beauty_calc(
191         const float (*coords)[2],
192         const struct HalfEdge *edges,
193         const struct HalfEdge *e_a)
194 {
195         const struct HalfEdge *e_b = &edges[e_a->e_radial];
196
197         const struct HalfEdge *e_a_other = &edges[edges[e_a->e_next].e_next];
198         const struct HalfEdge *e_b_other = &edges[edges[e_b->e_next].e_next];
199
200         const float *v1, *v2, *v3, *v4;
201
202         v1 = coords[e_a_other->v];
203         v2 = coords[e_a->v];
204         v3 = coords[e_b_other->v];
205         v4 = coords[e_b->v];
206
207         return BLI_polyfill_beautify_quad_rotate_calc(v1, v2, v3, v4);
208 }
209
210 static void polyedge_beauty_cost_update_single(
211         const float (*coords)[2],
212         const struct HalfEdge *edges,
213         struct HalfEdge *e,
214         Heap *eheap, HeapNode **eheap_table)
215 {
216         const uint i = e->base_index;
217         /* recalculate edge */
218         const float cost = polyedge_rotate_beauty_calc(coords, edges, e);
219         /* We can get cases where both choices generate very small negative costs,
220          * which leads to infinite loop. Anyway, costs above that are not worth recomputing,
221          * maybe we could even optimize it to a smaller limit?
222          * Actually, FLT_EPSILON is too small in some cases, 1e-6f seems to work OK hopefully?
223          * See T43578, T49478. */
224         if (cost < -1e-6f) {
225                 BLI_heap_insert_or_update(eheap, &eheap_table[i], cost, e);
226         }
227         else {
228                 if (eheap_table[i]) {
229                         BLI_heap_remove(eheap, eheap_table[i]);
230                         eheap_table[i] = NULL;
231                 }
232         }
233 }
234
235 static void polyedge_beauty_cost_update(
236         const float (*coords)[2],
237         struct HalfEdge *edges,
238         struct HalfEdge *e,
239         Heap *eheap, HeapNode **eheap_table)
240 {
241         struct HalfEdge *e_arr[4];
242         e_arr[0] = &edges[e->e_next];
243         e_arr[1] = &edges[e_arr[0]->e_next];
244
245         e = &edges[e->e_radial];
246         e_arr[2] = &edges[e->e_next];
247         e_arr[3] = &edges[e_arr[2]->e_next];
248
249         for (uint i = 0; i < 4; i++) {
250                 if (e_arr[i] && e_arr[i]->base_index != UINT_MAX) {
251                         polyedge_beauty_cost_update_single(
252                                 coords, edges,
253                                 e_arr[i],
254                                 eheap, eheap_table);
255                 }
256         }
257 }
258
259 static void polyedge_rotate(
260         struct HalfEdge *edges,
261         struct HalfEdge *e)
262 {
263         /** CCW winding, rotate internal edge to new vertical state.
264          *
265          * \code{.unparsed}
266          *   Before         After
267          *      X             X
268          *     / \           /|\
269          *  e4/   \e5     e4/ | \e5
270          *   / e3  \       /  |  \
271          * X ------- X -> X e0|e3 X
272          *   \ e0  /       \  |  /
273          *  e2\   /e1     e2\ | /e1
274          *     \ /           \|/
275          *      X             X
276          * \endcode
277          */
278         struct HalfEdge *ed[6];
279         uint ed_index[6];
280
281         ed_index[0] = (uint)(e - edges);
282         ed[0] = &edges[ed_index[0]];
283         ed_index[1] = ed[0]->e_next;
284         ed[1] = &edges[ed_index[1]];
285         ed_index[2] = ed[1]->e_next;
286         ed[2] = &edges[ed_index[2]];
287
288         ed_index[3] = e->e_radial;
289         ed[3] = &edges[ed_index[3]];
290         ed_index[4] = ed[3]->e_next;
291         ed[4] = &edges[ed_index[4]];
292         ed_index[5] = ed[4]->e_next;
293         ed[5] = &edges[ed_index[5]];
294
295         ed[0]->e_next = ed_index[2];
296         ed[1]->e_next = ed_index[3];
297         ed[2]->e_next = ed_index[4];
298         ed[3]->e_next = ed_index[5];
299         ed[4]->e_next = ed_index[0];
300         ed[5]->e_next = ed_index[1];
301
302         ed[0]->v = ed[5]->v;
303         ed[3]->v = ed[2]->v;
304 }
305
306 /**
307  * The intention is that this calculates the output of #BLI_polyfill_calc
308  * \note assumes the \a coords form a boundary,
309  * so any edges running along contiguous (wrapped) indices,
310  * are ignored since the edges wont share 2 faces.
311  */
312 void BLI_polyfill_beautify(
313         const float (*coords)[2],
314         const uint coords_tot,
315         uint (*tris)[3],
316
317         /* structs for reuse */
318         MemArena *arena, Heap *eheap)
319 {
320         const uint coord_last = coords_tot - 1;
321         const uint tris_len = coords_tot - 2;
322         /* internal edges only (between 2 tris) */
323         const uint edges_len = tris_len - 1;
324
325         HeapNode **eheap_table;
326
327         const uint half_edges_len = 3 * tris_len;
328         struct HalfEdge *half_edges = BLI_memarena_alloc(arena, sizeof(*half_edges) * half_edges_len);
329         struct OrderEdge *order_edges = BLI_memarena_alloc(arena, sizeof(struct OrderEdge) * 2 * edges_len);
330         uint order_edges_len = 0;
331
332         /* first build edges */
333         for (uint i = 0; i < tris_len; i++) {
334                 for (uint j_curr = 0, j_prev = 2; j_curr < 3; j_prev = j_curr++) {
335                         const uint e_index_prev = (i * 3) + j_prev;
336                         const uint e_index_curr = (i * 3) + j_curr;
337
338                         half_edges[e_index_prev].v = tris[i][j_prev];
339                         half_edges[e_index_prev].e_next = e_index_curr;
340                         half_edges[e_index_prev].e_radial = UINT_MAX;
341                         half_edges[e_index_prev].base_index = UINT_MAX;
342
343                         uint e_pair[2] = {tris[i][j_prev], tris[i][j_curr]};
344                         if (e_pair[0] > e_pair[1]) {
345                                 SWAP(uint, e_pair[0], e_pair[1]);
346                         }
347
348                         /* ensure internal edges. */
349                         if (!is_boundary_edge(e_pair[0], e_pair[1], coord_last)) {
350                                 order_edges[order_edges_len].verts[0] = e_pair[0];
351                                 order_edges[order_edges_len].verts[1] = e_pair[1];
352                                 order_edges[order_edges_len].e_half = e_index_prev;
353                                 order_edges_len += 1;
354                         }
355                 }
356         }
357         BLI_assert(edges_len * 2 == order_edges_len);
358
359         qsort(order_edges, order_edges_len, sizeof(struct OrderEdge), oedge_cmp);
360
361         for (uint i = 0, base_index = 0; i < order_edges_len; base_index++) {
362                 const struct OrderEdge *oe_a = &order_edges[i++];
363                 const struct OrderEdge *oe_b = &order_edges[i++];
364                 BLI_assert(oe_a->verts[0] == oe_a->verts[0] && oe_a->verts[1] == oe_a->verts[1]);
365                 half_edges[oe_a->e_half].e_radial = oe_b->e_half;
366                 half_edges[oe_b->e_half].e_radial = oe_a->e_half;
367                 half_edges[oe_a->e_half].base_index = base_index;
368                 half_edges[oe_b->e_half].base_index = base_index;
369         }
370         /* order_edges could be freed now. */
371
372         /* Now perform iterative rotations. */
373 #if 0
374         eheap_table = BLI_memarena_alloc(arena, sizeof(HeapNode *) * (size_t)edges_len);
375 #else
376         /* We can re-use this since its big enough. */
377         eheap_table = (void *)order_edges;
378         order_edges = NULL;
379 #endif
380
381         /* Build heap. */
382         {
383                 struct HalfEdge *e = half_edges;
384                 for (uint i = 0; i < half_edges_len; i++, e++) {
385                         /* Accounts for boundary edged too (UINT_MAX). */
386                         if (e->e_radial < i) {
387                                 const float cost = polyedge_rotate_beauty_calc(coords, half_edges, e);
388                                 if (cost < 0.0f) {
389                                         eheap_table[e->base_index] = BLI_heap_insert(eheap, cost, e);
390                                 }
391                                 else {
392                                         eheap_table[e->base_index] = NULL;
393                                 }
394                         }
395                 }
396         }
397
398         while (BLI_heap_is_empty(eheap) == false) {
399                 struct HalfEdge *e = BLI_heap_pop_min(eheap);
400                 eheap_table[e->base_index] = NULL;
401
402                 polyedge_rotate(half_edges, e);
403
404                 /* recalculate faces connected on the heap */
405                 polyedge_beauty_cost_update(
406                         coords, half_edges,
407                         e,
408                         eheap, eheap_table);
409         }
410
411         BLI_heap_clear(eheap, NULL);
412
413         /* MEM_freeN(eheap_table); */  /* arena */
414
415         /* get tris from half edge. */
416         uint tri_index = 0;
417         for (uint i = 0; i < half_edges_len; i++) {
418                 struct HalfEdge *e = &half_edges[i];
419                 if (e->v != UINT_MAX) {
420                         uint *tri = tris[tri_index++];
421
422                         tri[0] = e->v;
423                         e->v = UINT_MAX;
424
425                         e = &half_edges[e->e_next];
426                         tri[1] = e->v;
427                         e->v = UINT_MAX;
428
429                         e = &half_edges[e->e_next];
430                         tri[2] = e->v;
431                         e->v = UINT_MAX;
432                 }
433         }
434 }