5d112751fa02e1fdf34bd094716af71be90c78e8
[blender-staging.git] / tests / gtests / blenlib / BLI_polyfill2d_test.cc
1 /* Apache License, Version 2.0 */
2
3 #include "testing/testing.h"
4
5 /* Use to write out OBJ files, handy for checking output */
6 // #define USE_OBJ_PREVIEW
7
8 /* test every possible offset and reverse */
9 #define USE_COMBINATIONS_ALL
10 #define USE_BEAUTIFY
11
12 extern "C" {
13 #include "BLI_array_utils.h"
14 #include "BLI_polyfill2d.h"
15 #include "BLI_math.h"
16 #include "BLI_edgehash.h"
17 #include "MEM_guardedalloc.h"
18
19 #ifdef USE_OBJ_PREVIEW
20 #  include "BLI_string.h"
21 #endif
22
23 #ifdef USE_BEAUTIFY
24 #include "BLI_polyfill2d_beautify.h"
25 #include "BLI_memarena.h"
26 #include "BLI_heap.h"
27 #endif
28 }
29
30 static void polyfill_to_obj(
31         const char *id,
32         const float poly[][2], const unsigned int poly_tot,
33         const unsigned int tris[][3], const unsigned int tris_tot);
34
35 /* -------------------------------------------------------------------- */
36 /* test utility functions */
37
38 #define TRI_ERROR_VALUE (unsigned int)-1
39
40 static void test_valid_polyfill_prepare(unsigned int tris[][3], unsigned int tris_tot)
41 {
42         unsigned int i;
43         for (i = 0; i < tris_tot; i++) {
44                 unsigned int j;
45                 for (j = 0; j < 3; j++) {
46                         tris[i][j] = TRI_ERROR_VALUE;
47                 }
48         }
49 }
50
51 /**
52  * Basic check for face index values:
53  *
54  * - no duplicates.
55  * - all tris set.
56  * - all verts used at least once.
57  */
58 static void test_polyfill_simple(
59         const float poly[][2], const unsigned int poly_tot,
60         const unsigned int tris[][3], const unsigned int tris_tot)
61 {
62         unsigned int i;
63         int *tot_used = (int *)MEM_callocN(poly_tot * sizeof(int), __func__);
64         for (i = 0; i < tris_tot; i++) {
65                 unsigned int j;
66                 for (j = 0; j < 3; j++) {
67                         EXPECT_NE(TRI_ERROR_VALUE, tris[i][j]);
68                         tot_used[tris[i][j]] += 1;
69                 }
70                 EXPECT_NE(tris[i][0], tris[i][1]);
71                 EXPECT_NE(tris[i][1], tris[i][2]);
72                 EXPECT_NE(tris[i][2], tris[i][0]);
73         }
74         for (i = 0; i < poly_tot; i++) {
75                 EXPECT_NE(0, tot_used[i]);
76         }
77         MEM_freeN(tot_used);
78 }
79
80 static void  test_polyfill_topology(
81         const float poly[][2], const unsigned int poly_tot,
82         const unsigned int tris[][3], const unsigned int tris_tot)
83 {
84         EdgeHash *edgehash = BLI_edgehash_new(__func__);
85         EdgeHashIterator *ehi;
86         unsigned int i;
87         for (i = 0; i < tris_tot; i++) {
88                 unsigned int j;
89                 for (j = 0; j < 3; j++) {
90                         const unsigned int v1 = tris[i][j];
91                         const unsigned int v2 = tris[i][(j + 1) % 3];
92                         void **p = BLI_edgehash_lookup_p(edgehash, v1, v2);
93                         if (p) {
94                                 *p = (void *)((intptr_t)*p + (intptr_t)1);
95                         }
96                         else {
97                                 BLI_edgehash_insert(edgehash, v1, v2, (void *)(intptr_t)1);
98                         }
99                 }
100         }
101         EXPECT_EQ(BLI_edgehash_size(edgehash), poly_tot + (poly_tot - 3));
102
103         for (i = 0; i < poly_tot; i++) {
104                 const unsigned int v1 = i;
105                 const unsigned int v2 = (i + 1) % poly_tot;
106                 void **p = BLI_edgehash_lookup_p(edgehash, v1, v2);
107                 EXPECT_EQ((void *)p != NULL, 1);
108                 EXPECT_EQ((intptr_t)*p, 1);
109         }
110
111         for (ehi = BLI_edgehashIterator_new(edgehash), i = 0;
112              BLI_edgehashIterator_isDone(ehi) == false;
113              BLI_edgehashIterator_step(ehi), i++)
114         {
115                 void **p = BLI_edgehashIterator_getValue_p(ehi);
116                 EXPECT_TRUE(ELEM((intptr_t)*p, 1, 2));
117         }
118
119         BLI_edgehashIterator_free(ehi);
120         BLI_edgehash_free(edgehash, NULL);
121 }
122
123 /**
124  * Check all faces are flipped the same way
125  */
126 static void  test_polyfill_winding(
127         const float poly[][2], const unsigned int poly_tot,
128         const unsigned int tris[][3], const unsigned int tris_tot)
129 {
130         unsigned int i;
131         unsigned int count[2] = {0, 0};
132         for (i = 0; i < tris_tot; i++) {
133                 float winding_test = cross_tri_v2(poly[tris[i][0]], poly[tris[i][1]], poly[tris[i][2]]);
134                 if (fabsf(winding_test) > FLT_EPSILON) {
135                         count[winding_test < 0.0f] += 1;
136                 }
137         }
138         EXPECT_TRUE(ELEM(0, count[0], count[1]));
139 }
140
141 /**
142  * Check the accumulated triangle area is close to the original area.
143  */
144 static void test_polyfill_area(
145         const float poly[][2], const unsigned int poly_tot,
146         const unsigned int tris[][3], const unsigned int tris_tot)
147 {
148         unsigned int i;
149         const float area_tot = area_poly_v2(poly, poly_tot);
150         float       area_tot_tris = 0.0f;
151         const float eps_abs = 0.00001f;
152         const float eps = area_tot > 1.0f ? (area_tot * eps_abs) : eps_abs;
153         for (i = 0; i < tris_tot; i++) {
154                 area_tot_tris += area_tri_v2(poly[tris[i][0]], poly[tris[i][1]], poly[tris[i][2]]);
155         }
156         EXPECT_NEAR(area_tot, area_tot_tris, eps);
157 }
158
159
160 /* -------------------------------------------------------------------- */
161 /* Macro and helpers to manage checking */
162 /**
163  * Main template for polyfill testing.
164  */
165 static void test_polyfill_template_check(
166         const char *id, bool is_degenerate,
167         const float poly[][2], const unsigned int poly_tot,
168         const unsigned int tris[][3], const unsigned int tris_tot)
169 {
170         test_polyfill_simple(poly, poly_tot, tris, tris_tot);
171         test_polyfill_topology(poly, poly_tot, tris, tris_tot);
172         if (!is_degenerate) {
173                 test_polyfill_winding(poly, poly_tot, tris, tris_tot);
174
175                 test_polyfill_area(poly, poly_tot, tris, tris_tot);
176         }
177         polyfill_to_obj(id, poly, poly_tot, tris, tris_tot);
178 }
179
180 static void test_polyfill_template(
181         const char *id, bool is_degenerate,
182         const float poly[][2], const unsigned int poly_tot,
183         unsigned int tris[][3], const unsigned int tris_tot)
184 {
185         test_valid_polyfill_prepare(tris, tris_tot);
186         BLI_polyfill_calc(poly, poly_tot, 0, tris);
187
188         /* check all went well */
189         test_polyfill_template_check(id, is_degenerate, poly, poly_tot, tris, tris_tot);
190
191 #ifdef USE_BEAUTIFY
192         /* check beautify gives good results too */
193         {
194                 MemArena *pf_arena = BLI_memarena_new(BLI_POLYFILL_ARENA_SIZE, __func__);
195                 Heap *pf_heap = BLI_heap_new_ex(BLI_POLYFILL_ALLOC_NGON_RESERVE);
196                 EdgeHash *pf_ehash = BLI_edgehash_new_ex(__func__, BLI_POLYFILL_ALLOC_NGON_RESERVE);
197
198                 BLI_polyfill_beautify(
199                         poly, poly_tot, tris,
200                         pf_arena, pf_heap, pf_ehash);
201
202                 test_polyfill_template_check(id, is_degenerate, poly, poly_tot, tris, tris_tot);
203
204                 BLI_memarena_free(pf_arena);
205                 BLI_heap_free(pf_heap, NULL);
206                 BLI_edgehash_free(pf_ehash, NULL);
207         }
208 #endif
209 }
210
211 #ifdef USE_COMBINATIONS_ALL
212 static void test_polyfill_template_main(
213         const char *id, bool is_degenerate,
214         const float poly[][2], const unsigned int poly_tot,
215         unsigned int tris[][3], const unsigned int tris_tot)
216 {
217         /* overkill? - try at _every_ offset & reverse */
218         unsigned int poly_reverse;
219         float (*poly_copy)[2] = (float (*)[2])MEM_mallocN(sizeof(float[2]) * poly_tot, id);
220         float tmp[2];
221
222         memcpy(poly_copy, poly, sizeof(float[2]) * poly_tot);
223
224         for (poly_reverse = 0; poly_reverse < 2; poly_reverse++) {
225                 unsigned int poly_cycle;
226
227                 if (poly_reverse) {
228                         BLI_array_reverse(poly_copy, poly_tot);
229                 }
230
231                 for (poly_cycle = 0; poly_cycle < poly_tot; poly_cycle++) {
232                         // printf("polytest %s ofs=%d, reverse=%d\n", id, poly_cycle, poly_reverse);
233                         test_polyfill_template(id, is_degenerate, poly, poly_tot, tris, tris_tot);
234
235                         /* cycle */
236                         copy_v2_v2(tmp, poly_copy[0]);
237                         memmove(&poly_copy[0], &poly_copy[1], (poly_tot - 1) * sizeof(float[2]));
238                         copy_v2_v2(poly_copy[poly_tot - 1], tmp);
239                 }
240         }
241
242         MEM_freeN(poly_copy);
243 }
244 #else  /* USE_COMBINATIONS_ALL */
245 static void test_polyfill_template_main(
246         const char *id, bool is_degenerate,
247         const float poly[][2], const unsigned int poly_tot,
248         unsigned int tris[][3], const unsigned int tris_tot)
249 {
250         test_polyfill_template(id, is_degenerate, poly, poly_tot, tris, tris_tot);
251 }
252 #endif  /* USE_COMBINATIONS_ALL */
253
254 #define TEST_POLYFILL_TEMPLATE_STATIC(poly, is_degenerate) \
255 { \
256         unsigned int tris[POLY_TRI_COUNT(ARRAY_SIZE(poly))][3]; \
257         const unsigned int poly_tot = ARRAY_SIZE(poly); \
258         const unsigned int tris_tot = ARRAY_SIZE(tris); \
259         const char *id = typeid(*this).name(); \
260         \
261         test_polyfill_template_main(id, is_degenerate, poly, poly_tot, tris, tris_tot); \
262 } (void)0
263
264 /* -------------------------------------------------------------------- */
265 /* visualisation functions (not needed for testing) */
266
267 #ifdef USE_OBJ_PREVIEW
268 static void polyfill_to_obj(
269         const char *id,
270         const float poly[][2], const unsigned int poly_tot,
271         const unsigned int tris[][3], const unsigned int tris_tot)
272 {
273         char path[1024];
274         FILE *f;
275         unsigned int i;
276
277         BLI_snprintf(path, sizeof(path), "%s.obj", id);
278
279         f = fopen(path, "w");
280         if (!f) {
281                 return;
282         }
283
284         for (i = 0; i < poly_tot; i++) {
285                 fprintf(f, "v %f %f 0.0\n", UNPACK2(poly[i]));
286         }
287
288         for (i = 0; i < tris_tot; i++) {
289                 fprintf(f, "f %u %u %u\n", UNPACK3_EX(1 +, tris[i], ));
290         }
291
292         fclose(f);
293 }
294 #else
295 static void polyfill_to_obj(
296         const char *id,
297         const float poly[][2], const unsigned int poly_tot,
298         const unsigned int tris[][3], const unsigned int tris_tot)
299 {
300         (void)id;
301         (void)poly, (void)poly_tot;
302         (void)tris, (void)tris_tot;
303 }
304 #endif  /* USE_OBJ_PREVIEW */
305
306
307 /* -------------------------------------------------------------------- */
308 /* tests */
309
310 #define POLY_TRI_COUNT(len) ((len) - 2)
311
312
313 /* A counterclockwise triangle */
314 TEST(polyfill2d, TriangleCCW)
315 {
316         const float poly[][2] = {{0, 0}, {0, 1}, {1, 0}};
317         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
318 }
319
320 /* A counterclockwise square */
321 TEST(polyfill2d, SquareCCW)
322 {
323         const float poly[][2] = {{0, 0}, {0, 1}, {1, 1}, {1, 0}};
324         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
325 }
326
327 /* A clockwise square */
328 TEST(polyfill2d, SquareCW)
329 {
330         const float poly[][2] = {{0, 0}, {1, 0}, {1, 1}, {0, 1}};
331         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
332 }
333
334 /* Starfleet insigna */
335 TEST(polyfill2d, Starfleet)
336 {
337         const float poly[][2] = {{0, 0}, {0.6f, 0.4f}, {1, 0}, {0.5f, 1}};
338         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
339 }
340
341 /* Starfleet insigna with repeated point */
342 TEST(polyfill2d, StarfleetDegenerate)
343 {
344         const float poly[][2] = {{0, 0}, {0.6f, 0.4f}, {0.6f, 0.4f}, {1, 0}, {0.5f, 1}};
345         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
346 }
347
348 /* Three collinear points */
349 TEST(polyfill2d, 3Colinear)
350 {
351         const float poly[][2] = {{0, 0}, {1, 0}, {2, 0}};
352         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
353 }
354
355 /* Four collinear points */
356 TEST(polyfill2d, 4Colinear)
357 {
358         const float poly[][2] = {{0, 0}, {1, 0}, {2, 0}, {3, 0}};
359         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
360 }
361
362 /* Non-consecutive collinear points */
363 TEST(polyfill2d, UnorderedColinear)
364 {
365         const float poly[][2] = {{0, 0}, {1, 1}, {2, 0}, {3, 1}, {4, 0}};
366         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
367 }
368
369 /* Plus shape */
370 TEST(polyfill2d, PlusShape)
371 {
372         const float poly[][2] = {
373             {1, 0}, {2, 0}, {2, 1}, {3, 1}, {3, 2}, {2, 2}, {2, 3}, {1, 3}, {1, 2}, {0, 2}, {0, 1}, {1, 1}};
374         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
375 }
376
377 /* Star shape */
378 TEST(polyfill2d, StarShape)
379 {
380         const float poly[][2] = {
381             {4, 0}, {5, 3}, {8, 4}, {5, 5}, {4, 8}, {3, 5}, {0, 4}, {3, 3}};
382         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
383 }
384
385 /* U shape */
386 TEST(polyfill2d, UShape)
387 {
388         const float poly[][2] = {
389             {1, 0}, {2, 0}, {3, 1}, {3, 3}, {2, 3}, {2, 1}, {1, 1}, {1, 3}, {0, 3}, {0, 1}};
390         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
391 }
392
393 /* Spiral */
394 TEST(polyfill2d, Spiral)
395 {
396         const float poly[][2] = {
397             {1, 0}, {4, 0}, {5, 1}, {5, 4}, {4, 5}, {1, 5}, {0, 4}, {0, 3},
398             {1, 2}, {2, 2}, {3, 3}, {1, 3}, {1, 4}, {4, 4}, {4, 1}, {0, 1}};
399         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
400 }
401
402 /* Test case from http:# www.flipcode.com/archives/Efficient_Polygon_Triangulation.shtml */
403 TEST(polyfill2d, TestFlipCode)
404 {
405         const float poly[][2] = {
406             {0, 6}, {0, 0}, {3, 0}, {4, 1}, {6, 1}, {8, 0}, {12, 0}, {13, 2},
407             {8, 2}, {8, 4}, {11, 4}, {11, 6}, {6, 6}, {4, 3}, {2, 6}};
408         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
409 }
410
411 /* Self-intersection */
412 TEST(polyfill2d, SelfIntersect)
413 {
414         const float poly[][2] = {{0, 0}, {1, 1}, {2, -1}, {3, 1}, {4, 0}};
415         TEST_POLYFILL_TEMPLATE_STATIC(poly, true);
416 }
417
418 /* Self-touching */
419 TEST(polyfill2d, SelfTouch)
420 {
421         const float poly[][2] = {
422             {0, 0}, {4, 0}, {4, 4}, {2, 4}, {2, 3}, {3, 3}, {3, 1}, {1, 1}, {1, 3}, {2, 3}, {2, 4}, {0, 4}};
423         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
424 }
425
426 /* Self-overlapping */
427 TEST(polyfill2d, SelfOverlap)
428 {
429         const float poly[][2] = {
430             {0, 0}, {4, 0}, {4, 4}, {1, 4}, {1, 3}, {3, 3}, {3, 1}, {1, 1}, {1, 3}, {3, 3}, {3, 4}, {0, 4}};
431         TEST_POLYFILL_TEMPLATE_STATIC(poly, true);
432 }
433
434 /* Test case from http:# www.davdata.nl/math/polygons.html */
435 TEST(polyfill2d, TestDavData)
436 {
437         const float poly[][2] = {
438             {190, 480}, {140, 180}, {310, 100}, {330, 390}, {290, 390}, {280, 260}, {220, 260}, {220, 430}, {370, 430},
439             {350, 30}, {50, 30}, {160, 560}, {730, 510}, {710, 20}, {410, 30}, {470, 440}, {640, 410}, {630, 140},
440             {590, 140}, {580, 360}, {510, 370}, {510, 60}, {650, 70}, {660, 450}, {190, 480}};
441         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
442 }
443
444 /* Issue 815, http:# code.google.com/p/libgdx/issues/detail?id=815 */
445 TEST(polyfill2d, Issue815)
446 {
447         const float poly[][2] = {
448             {-2.0f, 0.0f}, {-2.0f, 0.5f}, {0.0f, 1.0f}, {0.5f, 2.875f},
449             {1.0f, 0.5f}, {1.5f, 1.0f}, {2.0f, 1.0f}, {2.0f, 0.0f}};
450         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
451 }
452
453 /* Issue 207, comment #1, http:# code.google.com/p/libgdx/issues/detail?id=207#c1 */
454 TEST(polyfill2d, Issue207_1)
455 {
456         const float poly[][2] = {
457             {72.42465f, 197.07095f}, {78.485535f, 189.92776f}, {86.12059f, 180.92929f}, {99.68253f, 164.94557f},
458             {105.24325f, 165.79604f}, {107.21862f, 166.09814f}, {112.41958f, 162.78253f}, {113.73238f, 161.94562f},
459             {123.29477f, 167.93805f}, {126.70667f, 170.07617f}, {73.22717f, 199.51062f}};
460         TEST_POLYFILL_TEMPLATE_STATIC(poly, true);
461 }
462
463 /* Issue 207, comment #11, http:# code.google.com/p/libgdx/issues/detail?id=207#c11 */
464 /* Also on issue 1081, http:# code.google.com/p/libgdx/issues/detail?id=1081 */
465 TEST(polyfill2d, Issue207_11)
466 {
467         const float poly[][2] = {
468             {2400.0f, 480.0f}, {2400.0f, 176.0f}, {1920.0f, 480.0f}, {1920.0459f, 484.22314f},
469             {1920.1797f, 487.91016f}, {1920.3955f, 491.0874f}, {1920.6875f, 493.78125f}, {1921.0498f, 496.01807f},
470             {1921.4766f, 497.82422f}, {1921.9619f, 499.22607f}, {1922.5f, 500.25f}, {1923.085f, 500.92236f},
471             {1923.7109f, 501.26953f}, {1924.3721f, 501.31787f}, {1925.0625f, 501.09375f}, {1925.7764f, 500.62354f},
472             {1926.5078f, 499.9336f}, {1927.251f, 499.0503f}, {1928.0f, 498.0f}, {1928.749f, 496.80908f},
473             {1929.4922f, 495.5039f}, {1930.2236f, 494.11084f}, {1930.9375f, 492.65625f}, {1931.6279f, 491.1665f},
474             {1932.2891f, 489.66797f}, {1932.915f, 488.187f}, {1933.5f, 486.75f}, {1934.0381f, 485.3833f},
475             {1934.5234f, 484.11328f}, {1934.9502f, 482.9663f}, {1935.3125f, 481.96875f}, {1935.6045f, 481.14697f},
476             {1935.8203f, 480.52734f}, {1935.9541f, 480.13623f}, {1936.0f, 480.0f}};
477         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
478 }
479
480 /* Issue 1407, http:# code.google.com/p/libgdx/issues/detail?id=1407 */
481 TEST(polyfill2d, Issue1407)
482 {
483         const float poly[][2] = {
484             {3.914329f, 1.9008259f}, {4.414321f, 1.903619f}, {4.8973203f, 1.9063174f}, {5.4979978f, 1.9096732f}};
485         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
486 }
487
488 /* Issue 1407, http:# code.google.com/p/libgdx/issues/detail?id=1407, */
489 /* with an additional point to show what is happening. */
490 TEST(polyfill2d, Issue1407_pt)
491 {
492         const float poly[][2] = {
493             {3.914329f, 1.9008259f}, {4.414321f, 1.903619f}, {4.8973203f, 1.9063174f}, {5.4979978f, 1.9096732f}, {4, 4}};
494         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
495 }
496
497 /* Simplified from Blender bug T40777 */
498 TEST(polyfill2d, IssueT40777_colinear)
499 {
500         const float poly[][2] = {
501             {0.7, 0.37}, {0.7, 0}, {0.76, 0}, {0.76, 0.4}, {0.83, 0.4}, {0.83, 0}, {0.88, 0}, {0.88, 0.4},
502             {0.94, 0.4}, {0.94, 0}, {1, 0}, {1, 0.4}, {0.03, 0.62}, {0.03, 0.89}, {0.59, 0.89}, {0.03, 1},
503             {0, 1}, {0, 0}, {0.03, 0}, {0.03, 0.37}};
504         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
505 }
506
507 /* Blender bug T41986 */
508 TEST(polyfill2d, IssueT41986_axis_align)
509 {
510         const float poly[][2] = {
511             {-0.25, -0.07}, {-0.25, 0.27}, {-1.19, 0.14}, {-0.06, 0.73}, {0.17, 1.25}, {-0.25, 1.07},
512             {-0.38, 1.02}, {-0.25, 0.94}, {-0.40, 0.90}, {-0.41, 0.86}, {-0.34, 0.83}, {-0.25, 0.82},
513             {-0.66, 0.73}, {-0.56, 1.09}, {-0.25, 1.10}, {0.00, 1.31}, {-0.03, 1.47}, {-0.25, 1.53},
514             {0.12, 1.62}, {0.36, 1.07}, {0.12, 0.67}, {0.29, 0.57}, {0.44, 0.45}, {0.57, 0.29},
515             {0.66, 0.12}, {0.68, 0.06}, {0.57, -0.36}, {-0.25, -0.37}, {0.49, -0.74}, {-0.59, -1.21},
516             {-0.25, -0.15}, {-0.46, -0.52}, {-1.08, -0.83}, {-1.45, -0.33}, {-1.25, -0.04}};
517
518         TEST_POLYFILL_TEMPLATE_STATIC(poly, false);
519 }