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