Cleanup: remove redundant, invalid info from headers
[blender.git] / source / blender / blenkernel / intern / curve_decimate.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 blender/blenkernel/intern/curve_decimate.c
18  *  \ingroup bke
19  */
20
21 #include "DNA_curve_types.h"
22
23 #include "MEM_guardedalloc.h"
24 #include "BLI_heap.h"
25 #include "BLI_math_vector.h"
26
27 #include "BKE_curve.h"
28
29 #include "curve_fit_nd.h"
30
31 #include "BLI_strict_flags.h"
32
33 struct Knot {
34         struct Knot *next, *prev;
35         uint point_index;  /* index in point array */
36         uint knot_index;  /* index in knot array*/
37         float tan[2][3];
38         float handles[2];
39
40         HeapNode *heap_node;
41         uint can_remove : 1;
42         uint is_removed : 1;
43
44 #ifndef NDEBUG
45         const float *co;
46 #endif
47 };
48
49 struct Removal {
50         uint knot_index;
51         /* handles for prev/next knots */
52         float handles[2];
53 };
54
55 static float knot_remove_error_value(
56         const float tan_l[3], const float tan_r[3],
57         const float (*points)[3], const uint points_len,
58         /* avoid having to re-calculate again */
59         float r_handle_factors[2])
60 {
61         const uint dims = 3;
62         float error_sq = FLT_MAX;
63         uint error_sq_index;
64         float handle_factors[2][3];
65
66         curve_fit_cubic_to_points_single_fl(
67                 &points[0][0], points_len, NULL, dims, 0.0f,
68                 tan_l, tan_r,
69                 handle_factors[0], handle_factors[1],
70                 &error_sq, &error_sq_index);
71
72         sub_v3_v3(handle_factors[0], points[0]);
73         r_handle_factors[0] = dot_v3v3(tan_l, handle_factors[0]);
74
75         sub_v3_v3(handle_factors[1], points[points_len - 1]);
76         r_handle_factors[1] = dot_v3v3(tan_r, handle_factors[1]);
77
78         return error_sq;
79 }
80
81 static void knot_remove_error_recalculate(
82         Heap *heap, const float (*points)[3], const uint points_len,
83         struct Knot *k, const float error_sq_max)
84 {
85         BLI_assert(k->can_remove);
86         float handles[2];
87
88 #ifndef NDEBUG
89         BLI_assert(equals_v3v3(points[k->prev->point_index], k->prev->co));
90         BLI_assert(equals_v3v3(points[k->next->point_index], k->next->co));
91 #endif
92
93         const float (*points_offset)[3];
94         uint points_offset_len;
95
96         if (k->prev->point_index < k->next->point_index) {
97                 points_offset = &points[k->prev->point_index];
98                 points_offset_len = (k->next->point_index - k->prev->point_index) + 1;
99         }
100         else {
101                 points_offset = &points[k->prev->point_index];
102                 points_offset_len = ((k->next->point_index + points_len) - k->prev->point_index) + 1;
103         }
104
105         const float cost_sq = knot_remove_error_value(
106                 k->prev->tan[1], k->next->tan[0],
107                 points_offset, points_offset_len,
108                 handles);
109
110         if (cost_sq < error_sq_max) {
111                 struct Removal *r;
112                 if (k->heap_node) {
113                         r = BLI_heap_node_ptr(k->heap_node);
114                 }
115                 else {
116                         r = MEM_mallocN(sizeof(*r), __func__);
117                         r->knot_index = k->knot_index;
118                 }
119
120                 copy_v2_v2(r->handles, handles);
121
122                 BLI_heap_insert_or_update(heap, &k->heap_node, cost_sq, r);
123         }
124         else {
125                 if (k->heap_node) {
126                         struct Removal *r;
127                         r = BLI_heap_node_ptr(k->heap_node);
128                         BLI_heap_remove(heap, k->heap_node);
129
130                         MEM_freeN(r);
131
132                         k->heap_node = NULL;
133                 }
134         }
135 }
136
137 static void curve_decimate(
138         const float (*points)[3], const uint points_len,
139         struct Knot *knots, const uint knots_len,
140         float error_sq_max, const uint error_target_len)
141 {
142         Heap *heap = BLI_heap_new_ex(knots_len);
143         for (uint i = 0; i < knots_len; i++) {
144                 struct Knot *k = &knots[i];
145                 if (k->can_remove) {
146                         knot_remove_error_recalculate(heap, points, points_len, k, error_sq_max);
147                 }
148         }
149
150         uint knots_len_remaining = knots_len;
151
152         while ((knots_len_remaining > error_target_len) &&
153                (BLI_heap_is_empty(heap) == false))
154         {
155                 struct Knot *k;
156
157                 {
158                         struct Removal *r = BLI_heap_pop_min(heap);
159                         k = &knots[r->knot_index];
160                         k->heap_node = NULL;
161                         k->prev->handles[1] = r->handles[0];
162                         k->next->handles[0] = r->handles[1];
163                         MEM_freeN(r);
164                 }
165
166                 struct Knot *k_prev = k->prev;
167                 struct Knot *k_next = k->next;
168
169                 /* remove ourselves */
170                 k_next->prev = k_prev;
171                 k_prev->next = k_next;
172
173                 k->next = NULL;
174                 k->prev = NULL;
175                 k->is_removed = true;
176
177                 if (k_prev->can_remove) {
178                         knot_remove_error_recalculate(heap, points, points_len, k_prev, error_sq_max);
179                 }
180
181                 if (k_next->can_remove) {
182                         knot_remove_error_recalculate(heap, points, points_len, k_next, error_sq_max);
183                 }
184
185                 knots_len_remaining -= 1;
186         }
187
188         BLI_heap_free(heap, MEM_freeN);
189 }
190
191
192 uint BKE_curve_decimate_bezt_array(
193         BezTriple *bezt_array, const uint bezt_array_len,
194         const uint resolu, const bool is_cyclic,
195         const char flag_test, const char flag_set,
196         const float error_sq_max, const uint error_target_len)
197 {
198         const uint bezt_array_last = bezt_array_len - 1;
199         const uint points_len = BKE_curve_calc_coords_axis_len(bezt_array_len, resolu, is_cyclic, true);
200
201         float (*points)[3] = MEM_mallocN((sizeof(float[3]) * points_len * (is_cyclic ? 2 : 1)), __func__);
202
203         BKE_curve_calc_coords_axis(bezt_array, bezt_array_len, resolu, is_cyclic, false, 0, sizeof(float[3]), &points[0][0]);
204         BKE_curve_calc_coords_axis(bezt_array, bezt_array_len, resolu, is_cyclic, false, 1, sizeof(float[3]), &points[0][1]);
205         BKE_curve_calc_coords_axis(bezt_array, bezt_array_len, resolu, is_cyclic, false, 2, sizeof(float[3]), &points[0][2]);
206
207         const uint knots_len = bezt_array_len;
208         struct Knot *knots = MEM_mallocN((sizeof(*knots) * bezt_array_len), __func__);
209
210         if (is_cyclic) {
211                 memcpy(points[points_len], points[0], sizeof(float[3]) * points_len);
212         }
213
214         for (uint i = 0; i < bezt_array_len; i++) {
215                 knots[i].heap_node = NULL;
216                 knots[i].can_remove = (bezt_array[i].f2 & flag_test) != 0;
217                 knots[i].is_removed = false;
218                 knots[i].next = &knots[i + 1];
219                 knots[i].prev = &knots[i - 1];
220                 knots[i].point_index = i * resolu;
221                 knots[i].knot_index = i;
222
223                 sub_v3_v3v3(knots[i].tan[0], bezt_array[i].vec[0], bezt_array[i].vec[1]);
224                 knots[i].handles[0] = normalize_v3(knots[i].tan[0]);
225
226                 sub_v3_v3v3(knots[i].tan[1], bezt_array[i].vec[1], bezt_array[i].vec[2]);
227                 knots[i].handles[1] = -normalize_v3(knots[i].tan[1]);
228
229 #ifndef NDEBUG
230                 knots[i].co = bezt_array[i].vec[1];
231                 BLI_assert(equals_v3v3(knots[i].co, points[knots[i].point_index]));
232 #endif
233         }
234
235         if (is_cyclic) {
236                 knots[0].prev = &knots[bezt_array_last];
237                 knots[bezt_array_last].next = &knots[0];
238         }
239         else {
240                 knots[0].prev = NULL;
241                 knots[bezt_array_last].next = NULL;
242
243                 /* always keep end-points */
244                 knots[0].can_remove = false;
245                 knots[bezt_array_last].can_remove = false;
246         }
247
248         curve_decimate(points, points_len, knots, knots_len, error_sq_max, error_target_len);
249
250         MEM_freeN(points);
251
252         uint knots_len_decimated = knots_len;
253
254         /* Update handle type on modifications. */
255 #define HANDLE_UPDATE(a, b) \
256         { \
257                 if (a == HD_VECT) { \
258                         a = HD_FREE; \
259                 } \
260                 else if (a == HD_AUTO) { \
261                         a = HD_ALIGN; \
262                 } \
263                 /* opposite handle */ \
264                 if (b == HD_AUTO) { \
265                         b = HD_ALIGN; \
266                 } \
267         } ((void)0)
268
269         for (uint i = 0; i < bezt_array_len; i++) {
270                 if (knots[i].is_removed) {
271                         /* caller must remove */
272                         bezt_array[i].f2 |= flag_set;
273                         knots_len_decimated--;
274                 }
275                 else {
276                         bezt_array[i].f2 &= (char)~flag_set;
277                         if (is_cyclic || i != 0) {
278                                 uint i_prev = (i != 0) ? i - 1 : bezt_array_last;
279                                 if (knots[i_prev].is_removed) {
280                                         madd_v3_v3v3fl(bezt_array[i].vec[0], bezt_array[i].vec[1], knots[i].tan[0], knots[i].handles[0]);
281                                         HANDLE_UPDATE(bezt_array[i].h1, bezt_array[i].h2);
282                                 }
283                         }
284                         if (is_cyclic || i != bezt_array_last) {
285                                 uint i_next = (i != bezt_array_last) ? i + 1 : 0;
286                                 if (knots[i_next].is_removed) {
287                                         madd_v3_v3v3fl(bezt_array[i].vec[2], bezt_array[i].vec[1], knots[i].tan[1], knots[i].handles[1]);
288                                         HANDLE_UPDATE(bezt_array[i].h2, bezt_array[i].h1);
289                                 }
290                         }
291                 }
292         }
293
294 #undef HANDLE_UPDATE
295
296         MEM_freeN(knots);
297
298         return knots_len_decimated;
299 }
300 #define SELECT 1
301
302
303 void BKE_curve_decimate_nurb(
304         Nurb *nu, const uint resolu,
305         const float error_sq_max, const uint error_target_len)
306 {
307         const char flag_test = BEZT_FLAG_TEMP_TAG;
308
309         const uint pntsu_dst = BKE_curve_decimate_bezt_array(
310                 nu->bezt, (uint)nu->pntsu, resolu, (nu->flagu & CU_NURB_CYCLIC) != 0,
311                 SELECT, flag_test,
312                 error_sq_max, error_target_len);
313
314         if (pntsu_dst == (uint)nu->pntsu) {
315                 return;
316         }
317
318         BezTriple *bezt_src = nu->bezt;
319         BezTriple *bezt_dst = MEM_mallocN(sizeof(BezTriple) * pntsu_dst, __func__);
320
321         int i_src = 0, i_dst = 0;
322
323         while (i_src < nu->pntsu) {
324                 if ((bezt_src[i_src].f2 & flag_test) == 0) {
325                         bezt_dst[i_dst] = bezt_src[i_src];
326                         i_dst++;
327                 }
328                 i_src++;
329         }
330
331         MEM_freeN(bezt_src);
332
333         nu->bezt = bezt_dst;
334         nu->pntsu = i_dst;
335 }