BMesh: calc normals, use area weighted center
[blender.git] / source / blender / bmesh / operators / bmo_normals.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, Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/bmesh/operators/bmo_normals.c
24  *  \ingroup bmesh
25  *
26  * normal recalculation.
27  */
28
29 #include "MEM_guardedalloc.h"
30
31 #include "BLI_math.h"
32 #include "BLI_linklist_stack.h"
33
34 #include "bmesh.h"
35
36 #include "intern/bmesh_operators_private.h" /* own include */
37
38 /********* righthand faces implementation ****** */
39
40 #define FACE_FLAG       (1 << 0)
41 #define FACE_FLIP       (1 << 1)
42 #define FACE_TEMP       (1 << 2)
43
44 static bool bmo_recalc_normal_edge_filter_cb(BMElem *ele, void *UNUSED(user_data))
45 {
46         return BM_edge_is_manifold((BMEdge *)ele);
47 }
48
49 /**
50  * Given an array of faces, recalculate their normals.
51  * this functions assumes all faces in the array are connected by edges.
52  *
53  * \param bm
54  * \param faces  Array of connected faces.
55  * \param faces_len  Length of \a faces
56  * \param oflag  Flag to check before doing the actual face flipping.
57  */
58 static void bmo_recalc_face_normals_array(BMesh *bm, BMFace **faces, const int faces_len, const short oflag)
59 {
60         float cent[3], tvec[3];
61         float (*faces_center)[3] = MEM_mallocN(sizeof(*faces_center) * faces_len, __func__);
62         float *faces_area = MEM_mallocN(sizeof(*faces_area) * faces_len, __func__);
63         const float cent_fac = 1.0f / (float)faces_len;
64         int i, f_start_index;
65         const short oflag_flip = oflag | FACE_FLIP;
66
67         float cent_area_accum = 0.0f;
68         float f_len_best_sq;
69         BMFace *f;
70
71         BLI_LINKSTACK_DECLARE(fstack, BMFace *);
72
73         zero_v3(cent);
74
75         /* first calculate the center */
76         for (i = 0; i < faces_len; i++) {
77                 float *f_cent = faces_center[i];
78                 const float f_area = BM_face_calc_area(faces[i]);
79                 BM_face_calc_center_mean_weighted(faces[i], f_cent);
80                 madd_v3_v3fl(cent, f_cent, cent_fac * f_area);
81                 cent_area_accum += f_area;
82                 faces_area[i] = f_area;
83
84                 BLI_assert(BMO_elem_flag_test(bm, faces[i], FACE_TEMP) == 0);
85                 BLI_assert(BM_face_is_normal_valid(faces[i]));
86         }
87
88         if (cent_area_accum != 0.0f) {
89                 mul_v3_fl(cent, 1.0f / cent_area_accum);
90         }
91
92         f_len_best_sq = -FLT_MAX;
93         /* used in degenerate cases only */
94         f_start_index = 0;
95
96         for (i = 0; i < faces_len; i++) {
97                 float f_len_test_sq;
98
99                 if (faces_area[i] > FLT_EPSILON) {
100                         if ((f_len_test_sq = len_squared_v3v3(faces_center[i], cent)) > f_len_best_sq) {
101                                 f_len_best_sq = f_len_test_sq;
102                                 f_start_index = i;
103                         }
104                 }
105         }
106
107
108         /* make sure the starting face has the correct winding */
109         sub_v3_v3v3(tvec, faces_center[f_start_index], cent);
110         MEM_freeN(faces_center);
111         MEM_freeN(faces_area);
112
113         if (dot_v3v3(tvec, faces[f_start_index]->no) < 0.0f) {
114                 BMO_elem_flag_enable(bm, faces[f_start_index], FACE_FLIP);
115         }
116
117         /* now that we've found our starting face, make all connected faces
118          * have the same winding.  this is done recursively, using a manual
119          * stack (if we use simple function recursion, we'd end up overloading
120          * the stack on large meshes). */
121         BLI_LINKSTACK_INIT(fstack);
122
123         BLI_LINKSTACK_PUSH(fstack, faces[f_start_index]);
124         BMO_elem_flag_enable(bm, faces[f_start_index], FACE_TEMP);
125
126         while ((f = BLI_LINKSTACK_POP(fstack))) {
127                 const bool flip_state = BMO_elem_flag_test_bool(bm, f, FACE_FLIP);
128                 BMLoop *l_iter, *l_first;
129
130                 l_iter = l_first = BM_FACE_FIRST_LOOP(f);
131                 do {
132                         BMLoop *l_other = l_iter->radial_next;
133
134                         if ((l_other != l_iter) && bmo_recalc_normal_edge_filter_cb((BMElem *)l_iter->e, NULL)) {
135                                 if (!BMO_elem_flag_test(bm, l_other->f, FACE_TEMP)) {
136                                         BMO_elem_flag_enable(bm, l_other->f, FACE_TEMP);
137                                         BMO_elem_flag_set(bm, l_other->f, FACE_FLIP, (l_other->v == l_iter->v) != flip_state);
138                                         BLI_LINKSTACK_PUSH(fstack, l_other->f);
139                                 }
140                         }
141                 } while ((l_iter = l_iter->next) != l_first);
142         }
143
144         BLI_LINKSTACK_FREE(fstack);
145
146         /* apply flipping to oflag'd faces */
147         for (i = 0; i < faces_len; i++) {
148                 if (BMO_elem_flag_test(bm, faces[i], oflag_flip) == oflag_flip) {
149                         BM_face_normal_flip(bm, faces[i]);
150                 }
151                 BMO_elem_flag_disable(bm, faces[i], FACE_TEMP);
152         }
153 }
154
155 /*
156  * put normal to the outside, and set the first direction flags in edges
157  *
158  * then check the object, and set directions / direction-flags: but only for edges with 1 or 2 faces
159  * this is in fact the 'select connected'
160  *
161  * in case all faces were not done: start over with 'find the ultimate ...' */
162
163 void bmo_recalc_face_normals_exec(BMesh *bm, BMOperator *op)
164 {
165         int *groups_array = MEM_mallocN(sizeof(*groups_array) * bm->totface, __func__);
166         BMFace **faces_grp = MEM_mallocN(sizeof(*faces_grp) * bm->totface, __func__);
167
168         int (*group_index)[2];
169         const int group_tot = BM_mesh_calc_face_groups(bm, groups_array, &group_index,
170                                                        bmo_recalc_normal_edge_filter_cb, NULL,
171                                                        0, BM_EDGE);
172         int i;
173
174         BMO_slot_buffer_flag_enable(bm, op->slots_in, "faces", BM_FACE, FACE_FLAG);
175
176         BM_mesh_elem_table_ensure(bm, BM_FACE);
177
178         for (i = 0; i < group_tot; i++) {
179                 const int fg_sta = group_index[i][0];
180                 const int fg_len = group_index[i][1];
181                 int j;
182                 bool is_calc = false;
183
184                 for (j = 0; j < fg_len; j++) {
185                         faces_grp[j] = BM_face_at_index(bm, groups_array[fg_sta + j]);
186
187                         if (is_calc == false) {
188                                 is_calc = BMO_elem_flag_test_bool(bm, faces_grp[j], FACE_FLAG);
189                         }
190                 }
191
192                 if (is_calc) {
193                         bmo_recalc_face_normals_array(bm, faces_grp, fg_len, FACE_FLAG);
194                 }
195         }
196
197         MEM_freeN(faces_grp);
198
199         MEM_freeN(groups_array);
200         MEM_freeN(group_index);
201 }