Speedup for ngon normal calculation
[blender.git] / source / blender / bmesh / intern / bmesh_mesh.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): Geoffrey Bantle.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/bmesh/intern/bmesh_mesh.c
24  *  \ingroup bmesh
25  *
26  * BM mesh level functions.
27  */
28
29 #include "MEM_guardedalloc.h"
30
31 #include "DNA_listBase.h"
32 #include "DNA_object_types.h"
33
34 #include "BLI_listbase.h"
35 #include "BLI_math.h"
36 #include "BLI_utildefines.h"
37
38 #include "BKE_cdderivedmesh.h"
39 #include "BKE_tessmesh.h"
40 #include "BKE_multires.h"
41
42 #include "ED_mesh.h"
43
44 #include "intern/bmesh_private.h"
45
46 /* used as an extern, defined in bmesh.h */
47 BMAllocTemplate bm_mesh_allocsize_default = {512, 1024, 2048, 512};
48 BMAllocTemplate bm_mesh_chunksize_default = {512, 1024, 2048, 512};
49
50 static void bm_mempool_init(BMesh *bm, const BMAllocTemplate *allocsize)
51 {
52         bm->vpool = BLI_mempool_create(sizeof(BMVert), allocsize->totvert, bm_mesh_chunksize_default.totvert, BLI_MEMPOOL_ALLOW_ITER);
53         bm->epool = BLI_mempool_create(sizeof(BMEdge), allocsize->totedge, bm_mesh_chunksize_default.totedge, BLI_MEMPOOL_ALLOW_ITER);
54         bm->lpool = BLI_mempool_create(sizeof(BMLoop), allocsize->totloop, bm_mesh_chunksize_default.totloop, 0);
55         bm->fpool = BLI_mempool_create(sizeof(BMFace), allocsize->totface, bm_mesh_chunksize_default.totface, BLI_MEMPOOL_ALLOW_ITER);
56
57 #ifdef USE_BMESH_HOLES
58         bm->looplistpool = BLI_mempool_create(sizeof(BMLoopList), allocsize[3], allocsize[3], FALSE, FALSE);
59 #endif
60
61         /* allocate one flag pool that we dont get rid of. */
62         bm->toolflagpool = BLI_mempool_create(sizeof(BMFlagLayer), 512, 512, 0);
63 }
64
65 /**
66  * \brief BMesh Make Mesh
67  *
68  * Allocates a new BMesh structure.
69  *
70  * \return The New bmesh
71  *
72  * \note ob is needed by multires
73  */
74 BMesh *BM_mesh_create(struct Object *ob, BMAllocTemplate *allocsize)
75 {
76         /* allocate the structure */
77         BMesh *bm = MEM_callocN(sizeof(BMesh), __func__);
78
79         bm->ob = ob;
80         
81         /* allocate the memory pools for the mesh elements */
82         bm_mempool_init(bm, allocsize);
83
84         /* allocate one flag pool that we dont get rid of. */
85         bm->stackdepth = 1;
86         bm->totflags = 1;
87
88         return bm;
89 }
90
91 /**
92  * \brief BMesh Free Mesh Data
93  *
94  *      Frees a BMesh structure.
95  *
96  * \note frees mesh, but not actual BMesh struct
97  */
98 void BM_mesh_data_free(BMesh *bm)
99 {
100         BMVert *v;
101         BMEdge *e;
102         BMLoop *l;
103         BMFace *f;
104         
105
106         BMIter verts;
107         BMIter edges;
108         BMIter faces;
109         BMIter loops;
110         
111         for (v = BM_iter_new(&verts, bm, BM_VERTS_OF_MESH, bm); v; v = BM_iter_step(&verts)) {
112                 CustomData_bmesh_free_block(&(bm->vdata), &(v->head.data));
113         }
114         for (e = BM_iter_new(&edges, bm, BM_EDGES_OF_MESH, bm); e; e = BM_iter_step(&edges)) {
115                 CustomData_bmesh_free_block(&(bm->edata), &(e->head.data));
116         }
117         for (f = BM_iter_new(&faces, bm, BM_FACES_OF_MESH, bm); f; f = BM_iter_step(&faces)) {
118                 CustomData_bmesh_free_block(&(bm->pdata), &(f->head.data));
119                 for (l = BM_iter_new(&loops, bm, BM_LOOPS_OF_FACE, f); l; l = BM_iter_step(&loops)) {
120                         CustomData_bmesh_free_block(&(bm->ldata), &(l->head.data));
121                 }
122         }
123
124         /* Free custom data pools, This should probably go in CustomData_free? */
125         if (bm->vdata.totlayer) BLI_mempool_destroy(bm->vdata.pool);
126         if (bm->edata.totlayer) BLI_mempool_destroy(bm->edata.pool);
127         if (bm->ldata.totlayer) BLI_mempool_destroy(bm->ldata.pool);
128         if (bm->pdata.totlayer) BLI_mempool_destroy(bm->pdata.pool);
129
130         /* free custom data */
131         CustomData_free(&bm->vdata, 0);
132         CustomData_free(&bm->edata, 0);
133         CustomData_free(&bm->ldata, 0);
134         CustomData_free(&bm->pdata, 0);
135
136         /* destroy element pools */
137         BLI_mempool_destroy(bm->vpool);
138         BLI_mempool_destroy(bm->epool);
139         BLI_mempool_destroy(bm->lpool);
140         BLI_mempool_destroy(bm->fpool);
141
142         /* destroy flag pool */
143         BLI_mempool_destroy(bm->toolflagpool);
144
145 #ifdef USE_BMESH_HOLES
146         BLI_mempool_destroy(bm->looplistpool);
147 #endif
148
149         /* These tables aren't used yet, so it's not strictly necessary
150          * to 'end' them (with 'e' param) but if someone tries to start
151          * using them, having these in place will save a lot of pain */
152         mesh_octree_table(NULL, NULL, NULL, 'e');
153         mesh_mirrtopo_table(NULL, 'e');
154
155         BLI_freelistN(&bm->selected);
156
157         if (bm->py_handle) {
158                 extern void bpy_bm_generic_invalidate(void *self);
159
160                 bpy_bm_generic_invalidate(bm->py_handle);
161                 bm->py_handle = NULL;
162         }
163
164         BMO_error_clear(bm);
165 }
166
167 /**
168  * \brief BMesh Clear Mesh
169  *
170  * Clear all data in bm
171  */
172 void BM_mesh_clear(BMesh *bm)
173 {
174         Object *ob = bm->ob;
175         
176         /* free old mesh */
177         BM_mesh_data_free(bm);
178         memset(bm, 0, sizeof(BMesh));
179         
180         /* re-initialize mesh */
181         bm->ob = ob;
182         
183         /* allocate the memory pools for the mesh elements */
184         bm_mempool_init(bm, &bm_mesh_allocsize_default);
185
186         bm->stackdepth = 1;
187         bm->totflags = 1;
188 }
189
190 /**
191  * \brief BMesh Free Mesh
192  *
193  *      Frees a BMesh data and its structure.
194  */
195 void BM_mesh_free(BMesh *bm)
196 {
197         BM_mesh_data_free(bm);
198         MEM_freeN(bm);
199 }
200
201 /**
202  * \brief BMesh Compute Normals
203  *
204  * Updates the normals of a mesh.
205  */
206 void BM_mesh_normals_update(BMesh *bm, const short skip_hidden)
207 {
208         BMVert *v;
209         BMFace *f;
210         BMLoop *l;
211         BMEdge *e;
212         BMIter verts;
213         BMIter faces;
214         BMIter loops;
215         BMIter edges;
216         int index;
217         float (*edgevec)[3];
218         
219         /* calculate all face normals */
220         BM_ITER(f, &faces, bm, BM_FACES_OF_MESH, NULL) {
221                 if (skip_hidden && BM_elem_flag_test(f, BM_ELEM_HIDDEN))
222                         continue;
223 #if 0   /* UNUSED */
224                 if (f->head.flag & BM_NONORMCALC)
225                         continue;
226 #endif
227
228                 bmesh_face_normal_update(bm, f, f->no);
229         }
230         
231         /* Zero out vertex normals */
232         BM_ITER(v, &verts, bm, BM_VERTS_OF_MESH, NULL) {
233                 if (skip_hidden && BM_elem_flag_test(v, BM_ELEM_HIDDEN))
234                         continue;
235
236                 zero_v3(v->no);
237         }
238
239         /* compute normalized direction vectors for each edge. directions will be
240          * used below for calculating the weights of the face normals on the vertex
241          * normals */
242         index = 0;
243         edgevec = MEM_callocN(sizeof(float) * 3 * bm->totedge, "BM normal computation array");
244         BM_ITER(e, &edges, bm, BM_EDGES_OF_MESH, NULL) {
245                 BM_elem_index_set(e, index); /* set_inline */
246
247                 if (e->l) {
248                         sub_v3_v3v3(edgevec[index], e->v2->co, e->v1->co);
249                         normalize_v3(edgevec[index]);
250                 }
251                 else {
252                         /* the edge vector will not be needed when the edge has no radial */
253                 }
254
255                 index++;
256         }
257         bm->elem_index_dirty &= ~BM_EDGE;
258
259         /* add weighted face normals to vertices */
260         BM_ITER(f, &faces, bm, BM_FACES_OF_MESH, NULL) {
261
262                 if (skip_hidden && BM_elem_flag_test(f, BM_ELEM_HIDDEN))
263                         continue;
264
265                 BM_ITER(l, &loops, bm, BM_LOOPS_OF_FACE, f) {
266                         float *e1diff, *e2diff;
267                         float dotprod;
268                         float fac;
269
270                         /* calculate the dot product of the two edges that
271                          * meet at the loop's vertex */
272                         e1diff = edgevec[BM_elem_index_get(l->prev->e)];
273                         e2diff = edgevec[BM_elem_index_get(l->e)];
274                         dotprod = dot_v3v3(e1diff, e2diff);
275
276                         /* edge vectors are calculated from e->v1 to e->v2, so
277                          * adjust the dot product if one but not both loops
278                          * actually runs from from e->v2 to e->v1 */
279                         if ((l->prev->e->v1 == l->prev->v) ^ (l->e->v1 == l->v)) {
280                                 dotprod = -dotprod;
281                         }
282
283                         fac = saacos(-dotprod);
284
285                         /* accumulate weighted face normal into the vertex's normal */
286                         madd_v3_v3fl(l->v->no, f->no, fac);
287                 }
288         }
289         
290         /* normalize the accumulated vertex normals */
291         BM_ITER(v, &verts, bm, BM_VERTS_OF_MESH, NULL) {
292                 if (skip_hidden && BM_elem_flag_test(v, BM_ELEM_HIDDEN))
293                         continue;
294
295                 if (normalize_v3(v->no) == 0.0f) {
296                         normalize_v3_v3(v->no, v->co);
297                 }
298         }
299         
300         MEM_freeN(edgevec);
301 }
302
303 /*
304  * This function ensures correct normals for the mesh, but
305  * sets the flag BM_ELEM_TAG in flipped faces, to allow restoration
306  * of original normals.
307  *
308  * if undo is 0: calculate right normals
309  * if undo is 1: restore original normals
310  */
311
312 //keep in sycn with utils.c!
313 #define FACE_FLIP       8
314 static void bm_rationalize_normals(BMesh *bm, int undo)
315 {
316         BMOperator bmop;
317         BMFace *f;
318         BMIter iter;
319         
320         if (undo) {
321                 BM_ITER(f, &iter, bm, BM_FACES_OF_MESH, NULL) {
322                         if (BM_elem_flag_test(f, BM_ELEM_TAG)) {
323                                 BM_face_normal_flip(bm, f);
324                         }
325                         BM_elem_flag_disable(f, BM_ELEM_TAG);
326                 }
327                 
328                 return;
329         }
330         
331         BMO_op_initf(bm, &bmop, "righthandfaces faces=%af do_flip=%b", FALSE);
332         
333         BMO_push(bm, &bmop);
334         bmo_righthandfaces_exec(bm, &bmop);
335         
336         BM_ITER(f, &iter, bm, BM_FACES_OF_MESH, NULL) {
337                 BM_elem_flag_set(f, BM_ELEM_TAG, BMO_elem_flag_test(bm, f, FACE_FLIP));
338         }
339
340         BMO_pop(bm);
341         BMO_op_finish(bm, &bmop);
342 }
343
344 static void UNUSED_FUNCTION(bm_mdisps_space_set)(BMesh *bm, int from, int to)
345 {
346         /* switch multires data out of tangent space */
347         if (CustomData_has_layer(&bm->ldata, CD_MDISPS)) {
348                 Object *ob = bm->ob;
349                 BMEditMesh *em = BMEdit_Create(bm, FALSE);
350                 DerivedMesh *dm = CDDM_from_BMEditMesh(em, NULL, TRUE, FALSE);
351                 MDisps *mdisps;
352                 BMFace *f;
353                 BMIter iter;
354                 // int i = 0; // UNUSED
355                 
356                 multires_set_space(dm, ob, from, to);
357                 
358                 mdisps = CustomData_get_layer(&dm->loopData, CD_MDISPS);
359                 
360                 BM_ITER(f, &iter, bm, BM_FACES_OF_MESH, NULL) {
361                         BMLoop *l;
362                         BMIter liter;
363                         BM_ITER(l, &liter, bm, BM_LOOPS_OF_FACE, f) {
364                                 MDisps *lmd = CustomData_bmesh_get(&bm->ldata, l->head.data, CD_MDISPS);
365                                 
366                                 if (!lmd->disps) {
367                                         printf("%s: warning - 'lmd->disps' == NULL\n", __func__);
368                                 }
369                                 
370                                 if (lmd->disps && lmd->totdisp == mdisps->totdisp) {
371                                         memcpy(lmd->disps, mdisps->disps, sizeof(float) * 3 * lmd->totdisp);
372                                 }
373                                 else if (mdisps->disps) {
374                                         if (lmd->disps)
375                                                 MEM_freeN(lmd->disps);
376                                         
377                                         lmd->disps = MEM_dupallocN(mdisps->disps);
378                                         lmd->totdisp = mdisps->totdisp;
379                                 }
380                                 
381                                 mdisps++;
382                                 // i += 1;
383                         }
384                 }
385                 
386                 dm->needsFree = 1;
387                 dm->release(dm);
388                 
389                 /* setting this to NULL prevents BMEdit_Free from freeing it */
390                 em->bm = NULL;
391                 BMEdit_Free(em);
392                 MEM_freeN(em);
393         }
394 }
395
396 /**
397  * \brief BMesh Begin Edit
398  *
399  * Functions for setting up a mesh for editing and cleaning up after
400  * the editing operations are done. These are called by the tools/operator
401  * API for each time a tool is executed.
402  */
403 void bmesh_edit_begin(BMesh *bm, int flag)
404 {
405         bm->opflag = flag;
406         
407         /* Most operators seem to be using BMO_OP_FLAG_UNTAN_MULTIRES to change the MDisps to
408          * absolute space during mesh edits. With this enabled, changes to the topology
409          * (loop cuts, edge subdivides, etc) are not reflected in the higher levels of
410          * the mesh at all, which doesn't seem right. Turning off completely for now,
411          * until this is shown to be better for certain types of mesh edits. */
412 #if BMOP_UNTAN_MULTIRES_ENABLED
413         /* switch multires data out of tangent space */
414         if ((flag & BMO_OP_FLAG_UNTAN_MULTIRES) && CustomData_has_layer(&bm->ldata, CD_MDISPS)) {
415                 bmesh_mdisps_space_set(bm, MULTIRES_SPACE_TANGENT, MULTIRES_SPACE_ABSOLUTE);
416
417                 /* ensure correct normals, if possible */
418                 bmesh_rationalize_normals(bm, 0);
419                 BM_mesh_normals_update(bm);
420         }
421         else if (flag & BMO_OP_FLAG_RATIONALIZE_NORMALS) {
422                 bmesh_rationalize_normals(bm, 0);
423         }
424 #else
425         if (flag & BMO_OP_FLAG_RATIONALIZE_NORMALS) {
426                 bm_rationalize_normals(bm, 0);
427         }
428 #endif
429 }
430
431 /**
432  * \brief BMesh End Edit
433  */
434 void bmesh_edit_end(BMesh *bm, int flag)
435 {
436         /* BMO_OP_FLAG_UNTAN_MULTIRES disabled for now, see comment above in bmesh_edit_begin. */
437 #if BMOP_UNTAN_MULTIRES_ENABLED
438         /* switch multires data into tangent space */
439         if ((flag & BMO_OP_FLAG_UNTAN_MULTIRES) && CustomData_has_layer(&bm->ldata, CD_MDISPS)) {
440                 /* set normals to their previous winding */
441                 bmesh_rationalize_normals(bm, 1);
442                 bmesh_mdisps_space_set(bm, MULTIRES_SPACE_ABSOLUTE, MULTIRES_SPACE_TANGENT);
443         }
444         else if (flag & BMO_OP_FLAG_RATIONALIZE_NORMALS) {
445                 bmesh_rationalize_normals(bm, 1);
446         }
447 #else
448         if (flag & BMO_OP_FLAG_RATIONALIZE_NORMALS) {
449                 bm_rationalize_normals(bm, 1);
450         }
451 #endif
452
453         bm->opflag = 0;
454
455         /* compute normals, clear temp flags and flush selections */
456         BM_mesh_normals_update(bm, TRUE);
457         BM_mesh_select_mode_flush(bm);
458 }
459
460 void BM_mesh_elem_index_ensure(BMesh *bm, const char hflag)
461 {
462         BMIter iter;
463         BMElem *ele;
464
465 #ifdef DEBUG
466         BM_ELEM_INDEX_VALIDATE(bm, "Should Never Fail!", __func__);
467 #endif
468
469         if (hflag & BM_VERT) {
470                 if (bm->elem_index_dirty & BM_VERT) {
471                         int index = 0;
472                         BM_ITER(ele, &iter, bm, BM_VERTS_OF_MESH, NULL) {
473                                 BM_elem_index_set(ele, index); /* set_ok */
474                                 index++;
475                         }
476                         bm->elem_index_dirty &= ~BM_VERT;
477                         BLI_assert(index == bm->totvert);
478                 }
479                 else {
480                         // printf("%s: skipping vert index calc!\n", __func__);
481                 }
482         }
483
484         if (hflag & BM_EDGE) {
485                 if (bm->elem_index_dirty & BM_EDGE) {
486                         int index = 0;
487                         BM_ITER(ele, &iter, bm, BM_EDGES_OF_MESH, NULL) {
488                                 BM_elem_index_set(ele, index); /* set_ok */
489                                 index++;
490                         }
491                         bm->elem_index_dirty &= ~BM_EDGE;
492                         BLI_assert(index == bm->totedge);
493                 }
494                 else {
495                         // printf("%s: skipping edge index calc!\n", __func__);
496                 }
497         }
498
499         if (hflag & BM_FACE) {
500                 if (bm->elem_index_dirty & BM_FACE) {
501                         int index = 0;
502                         BM_ITER(ele, &iter, bm, BM_FACES_OF_MESH, NULL) {
503                                 BM_elem_index_set(ele, index); /* set_ok */
504                                 index++;
505                         }
506                         bm->elem_index_dirty &= ~BM_FACE;
507                         BLI_assert(index == bm->totface);
508                 }
509                 else {
510                         // printf("%s: skipping face index calc!\n", __func__);
511                 }
512         }
513 }
514
515
516 /**
517  * Array checking/setting macros
518  *
519  * Currently vert/edge/loop/face index data is being abused, in a few areas of the code.
520  *
521  * To avoid correcting them afterwards, set 'bm->elem_index_dirty' however its possible
522  * this flag is set incorrectly which could crash blender.
523  *
524  * These functions ensure its correct and are called more often in debug mode.
525  */
526
527 void BM_mesh_elem_index_validate(BMesh *bm, const char *location, const char *func,
528                                  const char *msg_a, const char *msg_b)
529 {
530         const char iter_types[3] = {BM_VERTS_OF_MESH,
531                                     BM_EDGES_OF_MESH,
532                                     BM_FACES_OF_MESH};
533
534         const char flag_types[3] = {BM_VERT, BM_EDGE, BM_FACE};
535         const char *type_names[3] = {"vert", "edge", "face"};
536
537         BMIter iter;
538         BMElem *ele;
539         int i;
540         int is_any_error = 0;
541
542         for (i = 0; i < 3; i++) {
543                 const int is_dirty = (flag_types[i] & bm->elem_index_dirty);
544                 int index = 0;
545                 int is_error = FALSE;
546                 int err_val = 0;
547                 int err_idx = 0;
548
549                 BM_ITER(ele, &iter, bm, iter_types[i], NULL) {
550                         if (!is_dirty) {
551                                 if (BM_elem_index_get(ele) != index) {
552                                         err_val = BM_elem_index_get(ele);
553                                         err_idx = index;
554                                         is_error = TRUE;
555                                 }
556                         }
557
558                         BM_elem_index_set(ele, index); /* set_ok */
559                         index++;
560                 }
561
562                 if ((is_error == TRUE) && (is_dirty == FALSE)) {
563                         is_any_error = TRUE;
564                         fprintf(stderr,
565                                 "Invalid Index: at %s, %s, %s[%d] invalid index %d, '%s', '%s'\n",
566                                 location, func, type_names[i], err_idx, err_val, msg_a, msg_b);
567                 }
568                 else if ((is_error == FALSE) && (is_dirty == TRUE)) {
569
570 #if 0           /* mostly annoying */
571
572                         /* dirty may have been incorrectly set */
573                         fprintf(stderr,
574                                 "Invalid Dirty: at %s, %s (%s), dirty flag was set but all index values are correct, '%s', '%s'\n",
575                                 location, func, type_names[i], msg_a, msg_b);
576 #endif
577                 }
578         }
579
580 #if 0 /* mostly annoying, even in debug mode */
581 #ifdef DEBUG
582         if (is_any_error == 0) {
583                 fprintf(stderr,
584                         "Valid Index Success: at %s, %s, '%s', '%s'\n",
585                         location, func, msg_a, msg_b);
586         }
587 #endif
588 #endif
589         (void) is_any_error; /* shut up the compiler */
590
591 }
592
593 BMVert *BM_vert_at_index(BMesh *bm, const int index)
594 {
595         return BLI_mempool_findelem(bm->vpool, index);
596 }
597
598 BMEdge *BM_edge_at_index(BMesh *bm, const int index)
599 {
600         return BLI_mempool_findelem(bm->epool, index);
601 }
602
603 BMFace *BM_face_at_index(BMesh *bm, const int index)
604 {
605         return BLI_mempool_findelem(bm->fpool, index);
606 }