Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / bmesh / intern / bmesh_mesh_conv.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 \ingroup bmesh
18  *
19  * BM mesh conversion functions.
20  *
21  * \section bm_mesh_conv_shapekey Converting Shape Keys
22  *
23  * When converting to/from a Mesh/BMesh you can optionally pass a shape key to edit.
24  * This has the effect of editing the shape key-block rather then the original mesh vertex coords
25  * (although additional geometry is still allowed and uses fallback locations on converting).
26  *
27  * While this works for any mesh/bmesh this is made use of by entering and exiting edit-mode.
28  *
29  * There are comments in code but this should help explain the general
30  * intention as to how this works converting from/to bmesh.
31  * \subsection user_pov User Perspective
32  *
33  * - Editmode operations when a shape key-block is active edits only that key-block.
34  * - The first Basis key-block always matches the Mesh verts.
35  * - Changing vertex locations of _any_ Basis will apply offsets to those shape keys using this as their Basis.
36  * \subsection enter_editmode Entering EditMode - #BM_mesh_bm_from_me
37  *
38  * - the active key-block is used for BMesh vertex locations on entering edit-mode.
39  * So obviously the meshes vertex locations remain unchanged and the shape key its self is not being edited directly.
40  * Simply the #BMVert.co is a initialized from active shape key (when its set).
41  * - all key-blocks are added as CustomData layers (read code for details).
42  * \subsection exit_editmode Exiting EditMode - #BM_mesh_bm_to_me
43  *
44  * This is where the most confusing code is! Won't attempt to document the details here, for that read the code.
45  * But basics are as follows.
46  *
47  * - Vertex locations (possibly modified from initial active key-block) are copied directly into #MVert.co
48  * (special confusing note that these may be restored later, when editing the 'Basis', read on).
49  * - if the 'Key' is relative, and the active key-block is the basis for ANY other key-blocks - get an array of offsets
50  * between the new vertex locations and the original shape key (before entering edit-mode),
51  * these offsets get applied later on to inactive key-blocks using the active one (which we are editing) as their Basis.
52  *
53  * Copying the locations back to the shape keys is quite confusing...
54  * One main area of confusion is that when editing a 'Basis' key-block 'me->key->refkey'
55  * The coords are written into the mesh, from the users perspective the Basis coords are written into the mesh
56  * when exiting edit-mode.
57  *
58  * When _not_ editing the 'Basis', the original vertex locations (stored in the mesh and unchanged during edit-mode),
59  * are copied back into the mesh.
60  *
61  * This has the effect from the users POV of leaving the mesh un-touched, and only editing the active shape key-block.
62  */
63
64 #include "DNA_mesh_types.h"
65 #include "DNA_meshdata_types.h"
66 #include "DNA_object_types.h"
67 #include "DNA_modifier_types.h"
68 #include "DNA_key_types.h"
69
70 #include "MEM_guardedalloc.h"
71
72 #include "BLI_listbase.h"
73 #include "BLI_alloca.h"
74 #include "BLI_math_vector.h"
75
76 #include "BKE_mesh.h"
77 #include "BKE_mesh_runtime.h"
78 #include "BKE_customdata.h"
79 #include "BKE_multires.h"
80
81 #include "BKE_main.h"
82 #include "BKE_key.h"
83
84 #include "bmesh.h"
85 #include "intern/bmesh_private.h" /* for element checking */
86
87 void BM_mesh_cd_flag_ensure(BMesh *bm, Mesh *mesh, const char cd_flag)
88 {
89         const char cd_flag_all = BM_mesh_cd_flag_from_bmesh(bm) | cd_flag;
90         BM_mesh_cd_flag_apply(bm, cd_flag_all);
91         if (mesh) {
92                 mesh->cd_flag = cd_flag_all;
93         }
94 }
95
96 void BM_mesh_cd_flag_apply(BMesh *bm, const char cd_flag)
97 {
98         /* CustomData_bmesh_init_pool() must run first */
99         BLI_assert(bm->vdata.totlayer == 0 || bm->vdata.pool != NULL);
100         BLI_assert(bm->edata.totlayer == 0 || bm->edata.pool != NULL);
101         BLI_assert(bm->pdata.totlayer == 0 || bm->pdata.pool != NULL);
102
103         if (cd_flag & ME_CDFLAG_VERT_BWEIGHT) {
104                 if (!CustomData_has_layer(&bm->vdata, CD_BWEIGHT)) {
105                         BM_data_layer_add(bm, &bm->vdata, CD_BWEIGHT);
106                 }
107         }
108         else {
109                 if (CustomData_has_layer(&bm->vdata, CD_BWEIGHT)) {
110                         BM_data_layer_free(bm, &bm->vdata, CD_BWEIGHT);
111                 }
112         }
113
114         if (cd_flag & ME_CDFLAG_EDGE_BWEIGHT) {
115                 if (!CustomData_has_layer(&bm->edata, CD_BWEIGHT)) {
116                         BM_data_layer_add(bm, &bm->edata, CD_BWEIGHT);
117                 }
118         }
119         else {
120                 if (CustomData_has_layer(&bm->edata, CD_BWEIGHT)) {
121                         BM_data_layer_free(bm, &bm->edata, CD_BWEIGHT);
122                 }
123         }
124
125         if (cd_flag & ME_CDFLAG_EDGE_CREASE) {
126                 if (!CustomData_has_layer(&bm->edata, CD_CREASE)) {
127                         BM_data_layer_add(bm, &bm->edata, CD_CREASE);
128                 }
129         }
130         else {
131                 if (CustomData_has_layer(&bm->edata, CD_CREASE)) {
132                         BM_data_layer_free(bm, &bm->edata, CD_CREASE);
133                 }
134         }
135 }
136
137 char BM_mesh_cd_flag_from_bmesh(BMesh *bm)
138 {
139         char cd_flag = 0;
140         if (CustomData_has_layer(&bm->vdata, CD_BWEIGHT)) {
141                 cd_flag |= ME_CDFLAG_VERT_BWEIGHT;
142         }
143         if (CustomData_has_layer(&bm->edata, CD_BWEIGHT)) {
144                 cd_flag |= ME_CDFLAG_EDGE_BWEIGHT;
145         }
146         if (CustomData_has_layer(&bm->edata, CD_CREASE)) {
147                 cd_flag |= ME_CDFLAG_EDGE_CREASE;
148         }
149         return cd_flag;
150 }
151
152 /* Static function for alloc (duplicate in modifiers_bmesh.c) */
153 static BMFace *bm_face_create_from_mpoly(
154         MPoly *mp, MLoop *ml,
155         BMesh *bm, BMVert **vtable, BMEdge **etable)
156 {
157         BMVert **verts = BLI_array_alloca(verts, mp->totloop);
158         BMEdge **edges = BLI_array_alloca(edges, mp->totloop);
159         int j;
160
161         for (j = 0; j < mp->totloop; j++, ml++) {
162                 verts[j] = vtable[ml->v];
163                 edges[j] = etable[ml->e];
164         }
165
166         return BM_face_create(bm, verts, edges, mp->totloop, NULL, BM_CREATE_SKIP_CD);
167 }
168
169
170 /**
171  * \brief Mesh -> BMesh
172  * \param bm: The mesh to write into, while this is typically a newly created BMesh,
173  * merging into existing data is supported.
174  * Note the custom-data layout isn't used.
175  * If more comprehensive merging is needed we should move this into a separate function
176  * since this should be kept fast for edit-mode switching and storing undo steps.
177  *
178  * \warning This function doesn't calculate face normals.
179  */
180 void BM_mesh_bm_from_me(
181         BMesh *bm, const Mesh *me,
182         const struct BMeshFromMeshParams *params)
183 {
184         const bool is_new =
185                 !(bm->totvert ||
186                   (bm->vdata.totlayer || bm->edata.totlayer || bm->pdata.totlayer || bm->ldata.totlayer));
187         MVert *mvert;
188         MEdge *medge;
189         MLoop *mloop;
190         MPoly *mp;
191         KeyBlock *actkey, *block;
192         BMVert *v, **vtable = NULL;
193         BMEdge *e, **etable = NULL;
194         BMFace *f, **ftable = NULL;
195         float (*keyco)[3] = NULL;
196         int totloops, i;
197         const int64_t mask = CD_MASK_BMESH | params->cd_mask_extra;
198         const int64_t mask_loop_only = mask & ~CD_MASK_ORIGINDEX;
199
200         if (!me || !me->totvert) {
201                 if (me && is_new) { /*no verts? still copy customdata layout*/
202                         CustomData_copy(&me->vdata, &bm->vdata, mask, CD_ASSIGN, 0);
203                         CustomData_copy(&me->edata, &bm->edata, mask, CD_ASSIGN, 0);
204                         CustomData_copy(&me->ldata, &bm->ldata, mask_loop_only, CD_ASSIGN, 0);
205                         CustomData_copy(&me->pdata, &bm->pdata, mask, CD_ASSIGN, 0);
206
207                         CustomData_bmesh_init_pool(&bm->vdata, me->totvert, BM_VERT);
208                         CustomData_bmesh_init_pool(&bm->edata, me->totedge, BM_EDGE);
209                         CustomData_bmesh_init_pool(&bm->ldata, me->totloop, BM_LOOP);
210                         CustomData_bmesh_init_pool(&bm->pdata, me->totpoly, BM_FACE);
211                 }
212                 return; /* sanity check */
213         }
214
215         if (is_new) {
216                 CustomData_copy(&me->vdata, &bm->vdata, mask, CD_CALLOC, 0);
217                 CustomData_copy(&me->edata, &bm->edata, mask, CD_CALLOC, 0);
218                 CustomData_copy(&me->ldata, &bm->ldata, mask_loop_only, CD_CALLOC, 0);
219                 CustomData_copy(&me->pdata, &bm->pdata, mask, CD_CALLOC, 0);
220         }
221
222         /* -------------------------------------------------------------------- */
223         /* Shape Key */
224         int tot_shape_keys = me->key ? BLI_listbase_count(&me->key->block) : 0;
225         if (is_new == false) {
226                 tot_shape_keys = min_ii(tot_shape_keys, CustomData_number_of_layers(&bm->vdata, CD_SHAPEKEY));
227         }
228         const float (**shape_key_table)[3] = tot_shape_keys ? BLI_array_alloca(shape_key_table, tot_shape_keys) : NULL;
229
230         if ((params->active_shapekey != 0) && (me->key != NULL)) {
231                 actkey = BLI_findlink(&me->key->block, params->active_shapekey - 1);
232         }
233         else {
234                 actkey = NULL;
235         }
236
237         if (is_new) {
238                 if (tot_shape_keys || params->add_key_index) {
239                         CustomData_add_layer(&bm->vdata, CD_SHAPE_KEYINDEX, CD_ASSIGN, NULL, 0);
240                 }
241         }
242
243         if (tot_shape_keys) {
244                 if (is_new) {
245                         /* check if we need to generate unique ids for the shapekeys.
246                          * this also exists in the file reading code, but is here for
247                          * a sanity check */
248                         if (!me->key->uidgen) {
249                                 fprintf(stderr,
250                                         "%s had to generate shape key uid's in a situation we shouldn't need to! "
251                                         "(bmesh internal error)\n",
252                                         __func__);
253
254                                 me->key->uidgen = 1;
255                                 for (block = me->key->block.first; block; block = block->next) {
256                                         block->uid = me->key->uidgen++;
257                                 }
258                         }
259                 }
260
261                 if (actkey && actkey->totelem == me->totvert) {
262                         keyco = params->use_shapekey ? actkey->data : NULL;
263                         if (is_new) {
264                                 bm->shapenr = params->active_shapekey;
265                         }
266                 }
267
268                 for (i = 0, block = me->key->block.first; i < tot_shape_keys; block = block->next, i++) {
269                         if (is_new) {
270                                 CustomData_add_layer_named(&bm->vdata, CD_SHAPEKEY,
271                                                            CD_ASSIGN, NULL, 0, block->name);
272                                 int j = CustomData_get_layer_index_n(&bm->vdata, CD_SHAPEKEY, i);
273                                 bm->vdata.layers[j].uid = block->uid;
274                         }
275                         shape_key_table[i] = (const float (*)[3])block->data;
276                 }
277         }
278
279         if (is_new) {
280                 CustomData_bmesh_init_pool(&bm->vdata, me->totvert, BM_VERT);
281                 CustomData_bmesh_init_pool(&bm->edata, me->totedge, BM_EDGE);
282                 CustomData_bmesh_init_pool(&bm->ldata, me->totloop, BM_LOOP);
283                 CustomData_bmesh_init_pool(&bm->pdata, me->totpoly, BM_FACE);
284
285                 BM_mesh_cd_flag_apply(bm, me->cd_flag);
286         }
287
288         const int cd_vert_bweight_offset = CustomData_get_offset(&bm->vdata, CD_BWEIGHT);
289         const int cd_edge_bweight_offset = CustomData_get_offset(&bm->edata, CD_BWEIGHT);
290         const int cd_edge_crease_offset  = CustomData_get_offset(&bm->edata, CD_CREASE);
291         const int cd_shape_key_offset = me->key ? CustomData_get_offset(&bm->vdata, CD_SHAPEKEY) : -1;
292         const int cd_shape_keyindex_offset = is_new && (tot_shape_keys || params->add_key_index) ?
293                   CustomData_get_offset(&bm->vdata, CD_SHAPE_KEYINDEX) : -1;
294
295         vtable = MEM_mallocN(sizeof(BMVert **) * me->totvert, __func__);
296
297         for (i = 0, mvert = me->mvert; i < me->totvert; i++, mvert++) {
298                 v = vtable[i] = BM_vert_create(bm, keyco ? keyco[i] : mvert->co, NULL, BM_CREATE_SKIP_CD);
299                 BM_elem_index_set(v, i); /* set_ok */
300
301                 /* transfer flag */
302                 v->head.hflag = BM_vert_flag_from_mflag(mvert->flag & ~SELECT);
303
304                 /* this is necessary for selection counts to work properly */
305                 if (mvert->flag & SELECT) {
306                         BM_vert_select_set(bm, v, true);
307                 }
308
309                 normal_short_to_float_v3(v->no, mvert->no);
310
311                 /* Copy Custom Data */
312                 CustomData_to_bmesh_block(&me->vdata, &bm->vdata, i, &v->head.data, true);
313
314                 if (cd_vert_bweight_offset != -1) BM_ELEM_CD_SET_FLOAT(v, cd_vert_bweight_offset, (float)mvert->bweight / 255.0f);
315
316                 /* set shape key original index */
317                 if (cd_shape_keyindex_offset != -1) BM_ELEM_CD_SET_INT(v, cd_shape_keyindex_offset, i);
318
319                 /* set shapekey data */
320                 if (tot_shape_keys) {
321                         float (*co_dst)[3] = BM_ELEM_CD_GET_VOID_P(v, cd_shape_key_offset);
322                         for (int j = 0; j < tot_shape_keys; j++, co_dst++) {
323                                 copy_v3_v3(*co_dst, shape_key_table[j][i]);
324                         }
325                 }
326         }
327         if (is_new) {
328                 bm->elem_index_dirty &= ~BM_VERT; /* added in order, clear dirty flag */
329         }
330
331         etable = MEM_mallocN(sizeof(BMEdge **) * me->totedge, __func__);
332
333         medge = me->medge;
334         for (i = 0; i < me->totedge; i++, medge++) {
335                 e = etable[i] = BM_edge_create(bm, vtable[medge->v1], vtable[medge->v2], NULL, BM_CREATE_SKIP_CD);
336                 BM_elem_index_set(e, i); /* set_ok */
337
338                 /* transfer flags */
339                 e->head.hflag = BM_edge_flag_from_mflag(medge->flag & ~SELECT);
340
341                 /* this is necessary for selection counts to work properly */
342                 if (medge->flag & SELECT) {
343                         BM_edge_select_set(bm, e, true);
344                 }
345
346                 /* Copy Custom Data */
347                 CustomData_to_bmesh_block(&me->edata, &bm->edata, i, &e->head.data, true);
348
349                 if (cd_edge_bweight_offset != -1) BM_ELEM_CD_SET_FLOAT(e, cd_edge_bweight_offset, (float)medge->bweight / 255.0f);
350                 if (cd_edge_crease_offset  != -1) BM_ELEM_CD_SET_FLOAT(e, cd_edge_crease_offset,  (float)medge->crease  / 255.0f);
351
352         }
353         if (is_new) {
354                 bm->elem_index_dirty &= ~BM_EDGE; /* added in order, clear dirty flag */
355         }
356
357         /* only needed for selection. */
358         if (me->mselect && me->totselect != 0) {
359                 ftable = MEM_mallocN(sizeof(BMFace **) * me->totpoly, __func__);
360         }
361
362         mloop = me->mloop;
363         mp = me->mpoly;
364         for (i = 0, totloops = 0; i < me->totpoly; i++, mp++) {
365                 BMLoop *l_iter;
366                 BMLoop *l_first;
367
368                 f = bm_face_create_from_mpoly(mp, mloop + mp->loopstart,
369                                               bm, vtable, etable);
370                 if (ftable != NULL) {
371                         ftable[i] = f;
372                 }
373
374                 if (UNLIKELY(f == NULL)) {
375                         printf("%s: Warning! Bad face in mesh"
376                                " \"%s\" at index %d!, skipping\n",
377                                __func__, me->id.name + 2, i);
378                         continue;
379                 }
380
381                 /* don't use 'i' since we may have skipped the face */
382                 BM_elem_index_set(f, bm->totface - 1); /* set_ok */
383
384                 /* transfer flag */
385                 f->head.hflag = BM_face_flag_from_mflag(mp->flag & ~ME_FACE_SEL);
386
387                 /* this is necessary for selection counts to work properly */
388                 if (mp->flag & ME_FACE_SEL) {
389                         BM_face_select_set(bm, f, true);
390                 }
391
392                 f->mat_nr = mp->mat_nr;
393                 if (i == me->act_face) bm->act_face = f;
394
395                 int j = mp->loopstart;
396                 l_iter = l_first = BM_FACE_FIRST_LOOP(f);
397                 do {
398                         /* don't use 'j' since we may have skipped some faces, hence some loops. */
399                         BM_elem_index_set(l_iter, totloops++); /* set_ok */
400
401                         /* Save index of correspsonding MLoop */
402                         CustomData_to_bmesh_block(&me->ldata, &bm->ldata, j++, &l_iter->head.data, true);
403                 } while ((l_iter = l_iter->next) != l_first);
404
405                 /* Copy Custom Data */
406                 CustomData_to_bmesh_block(&me->pdata, &bm->pdata, i, &f->head.data, true);
407
408                 if (params->calc_face_normal) {
409                         BM_face_normal_update(f);
410                 }
411         }
412         if (is_new) {
413                 bm->elem_index_dirty &= ~(BM_FACE | BM_LOOP); /* added in order, clear dirty flag */
414         }
415
416         /* -------------------------------------------------------------------- */
417         /* MSelect clears the array elements (avoid adding multiple times).
418          *
419          * Take care to keep this last and not use (v/e/ftable) after this.
420          */
421
422         if (me->mselect && me->totselect != 0) {
423                 MSelect *msel;
424                 for (i = 0, msel = me->mselect; i < me->totselect; i++, msel++) {
425                         BMElem **ele_p;
426                         switch (msel->type) {
427                                 case ME_VSEL:
428                                         ele_p = (BMElem **)&vtable[msel->index];
429                                         break;
430                                 case ME_ESEL:
431                                         ele_p = (BMElem **)&etable[msel->index];
432                                         break;
433                                 case ME_FSEL:
434                                         ele_p = (BMElem **)&ftable[msel->index];
435                                         break;
436                                 default:
437                                         continue;
438                         }
439
440                         if (*ele_p != NULL) {
441                                 BM_select_history_store_notest(bm, *ele_p);
442                                 *ele_p = NULL;
443                         }
444                 }
445         }
446         else {
447                 BM_select_history_clear(bm);
448         }
449
450         MEM_freeN(vtable);
451         MEM_freeN(etable);
452         if (ftable) {
453                 MEM_freeN(ftable);
454         }
455 }
456
457
458 /**
459  * \brief BMesh -> Mesh
460  */
461 static BMVert **bm_to_mesh_vertex_map(BMesh *bm, int ototvert)
462 {
463         const int cd_shape_keyindex_offset = CustomData_get_offset(&bm->vdata, CD_SHAPE_KEYINDEX);
464         BMVert **vertMap = NULL;
465         BMVert *eve;
466         int i = 0;
467         BMIter iter;
468
469         /* caller needs to ensure this */
470         BLI_assert(ototvert > 0);
471
472         vertMap = MEM_callocN(sizeof(*vertMap) * ototvert, "vertMap");
473         if (cd_shape_keyindex_offset != -1) {
474                 BM_ITER_MESH_INDEX (eve, &iter, bm, BM_VERTS_OF_MESH, i) {
475                         const int keyi = BM_ELEM_CD_GET_INT(eve, cd_shape_keyindex_offset);
476                         if ((keyi != ORIGINDEX_NONE) &&
477                             (keyi < ototvert) &&
478                             /* not fool-proof, but chances are if we have many verts with the same index,
479                              * we will want to use the first one, since the second is more likely to be a duplicate. */
480                             (vertMap[keyi] == NULL))
481                         {
482                                 vertMap[keyi] = eve;
483                         }
484                 }
485         }
486         else {
487                 BM_ITER_MESH_INDEX (eve, &iter, bm, BM_VERTS_OF_MESH, i) {
488                         if (i < ototvert) {
489                                 vertMap[i] = eve;
490                         }
491                         else {
492                                 break;
493                         }
494                 }
495         }
496
497         return vertMap;
498 }
499
500 /**
501  * returns customdata shapekey index from a keyblock or -1
502  * \note could split this out into a more generic function */
503 static int bm_to_mesh_shape_layer_index_from_kb(BMesh *bm, KeyBlock *currkey)
504 {
505         int i;
506         int j = 0;
507
508         for (i = 0; i < bm->vdata.totlayer; i++) {
509                 if (bm->vdata.layers[i].type == CD_SHAPEKEY) {
510                         if (currkey->uid == bm->vdata.layers[i].uid) {
511                                 return j;
512                         }
513                         j++;
514                 }
515         }
516         return -1;
517 }
518
519 BLI_INLINE void bmesh_quick_edgedraw_flag(MEdge *med, BMEdge *e)
520 {
521         /* this is a cheap way to set the edge draw, its not precise and will
522          * pick the first 2 faces an edge uses.
523          * The dot comparison is a little arbitrary, but set so that a 5 subd
524          * IcoSphere won't vanish but subd 6 will (as with pre-bmesh blender) */
525
526
527         if ( /* (med->flag & ME_EDGEDRAW) && */ /* assume to be true */
528              (e->l && (e->l != e->l->radial_next)) &&
529              (dot_v3v3(e->l->f->no, e->l->radial_next->f->no) > 0.9995f))
530         {
531                 med->flag &= ~ME_EDGEDRAW;
532         }
533         else {
534                 med->flag |= ME_EDGEDRAW;
535         }
536 }
537
538 /**
539  *
540  * \param bmain: May be NULL in case \a calc_object_remap parameter option is not set.
541  */
542 void BM_mesh_bm_to_me(
543         Main *bmain, BMesh *bm, Mesh *me,
544         const struct BMeshToMeshParams *params)
545 {
546         MLoop *mloop;
547         MPoly *mpoly;
548         MVert *mvert, *oldverts;
549         MEdge *med, *medge;
550         BMVert *v, *eve;
551         BMEdge *e;
552         BMFace *f;
553         BMIter iter;
554         int i, j, ototvert;
555
556         const int cd_vert_bweight_offset = CustomData_get_offset(&bm->vdata, CD_BWEIGHT);
557         const int cd_edge_bweight_offset = CustomData_get_offset(&bm->edata, CD_BWEIGHT);
558         const int cd_edge_crease_offset  = CustomData_get_offset(&bm->edata, CD_CREASE);
559
560         ototvert = me->totvert;
561
562         /* new vertex block */
563         if (bm->totvert == 0) mvert = NULL;
564         else mvert = MEM_callocN(bm->totvert * sizeof(MVert), "loadeditbMesh vert");
565
566         /* new edge block */
567         if (bm->totedge == 0) medge = NULL;
568         else medge = MEM_callocN(bm->totedge * sizeof(MEdge), "loadeditbMesh edge");
569
570         /* new ngon face block */
571         if (bm->totface == 0) mpoly = NULL;
572         else mpoly = MEM_callocN(bm->totface * sizeof(MPoly), "loadeditbMesh poly");
573
574         /* new loop block */
575         if (bm->totloop == 0) mloop = NULL;
576         else mloop = MEM_callocN(bm->totloop * sizeof(MLoop), "loadeditbMesh loop");
577
578         /* lets save the old verts just in case we are actually working on
579          * a key ... we now do processing of the keys at the end */
580         oldverts = me->mvert;
581
582         /* don't free this yet */
583         if (oldverts) {
584                 CustomData_set_layer(&me->vdata, CD_MVERT, NULL);
585         }
586
587         /* free custom data */
588         CustomData_free(&me->vdata, me->totvert);
589         CustomData_free(&me->edata, me->totedge);
590         CustomData_free(&me->fdata, me->totface);
591         CustomData_free(&me->ldata, me->totloop);
592         CustomData_free(&me->pdata, me->totpoly);
593
594         /* add new custom data */
595         me->totvert = bm->totvert;
596         me->totedge = bm->totedge;
597         me->totloop = bm->totloop;
598         me->totpoly = bm->totface;
599         /* will be overwritten with a valid value if 'dotess' is set, otherwise we
600          * end up with 'me->totface' and me->mface == NULL which can crash [#28625]
601          */
602         me->totface = 0;
603         me->act_face = -1;
604
605         {
606                 const CustomDataMask mask = CD_MASK_MESH | params->cd_mask_extra;
607                 CustomData_copy(&bm->vdata, &me->vdata, mask, CD_CALLOC, me->totvert);
608                 CustomData_copy(&bm->edata, &me->edata, mask, CD_CALLOC, me->totedge);
609                 CustomData_copy(&bm->ldata, &me->ldata, mask, CD_CALLOC, me->totloop);
610                 CustomData_copy(&bm->pdata, &me->pdata, mask, CD_CALLOC, me->totpoly);
611         }
612
613         CustomData_add_layer(&me->vdata, CD_MVERT, CD_ASSIGN, mvert, me->totvert);
614         CustomData_add_layer(&me->edata, CD_MEDGE, CD_ASSIGN, medge, me->totedge);
615         CustomData_add_layer(&me->ldata, CD_MLOOP, CD_ASSIGN, mloop, me->totloop);
616         CustomData_add_layer(&me->pdata, CD_MPOLY, CD_ASSIGN, mpoly, me->totpoly);
617
618         me->cd_flag = BM_mesh_cd_flag_from_bmesh(bm);
619
620         /* this is called again, 'dotess' arg is used there */
621         BKE_mesh_update_customdata_pointers(me, 0);
622
623         i = 0;
624         BM_ITER_MESH (v, &iter, bm, BM_VERTS_OF_MESH) {
625                 copy_v3_v3(mvert->co, v->co);
626                 normal_float_to_short_v3(mvert->no, v->no);
627
628                 mvert->flag = BM_vert_flag_to_mflag(v);
629
630                 BM_elem_index_set(v, i); /* set_inline */
631
632                 /* copy over customdat */
633                 CustomData_from_bmesh_block(&bm->vdata, &me->vdata, v->head.data, i);
634
635                 if (cd_vert_bweight_offset != -1) mvert->bweight = BM_ELEM_CD_GET_FLOAT_AS_UCHAR(v, cd_vert_bweight_offset);
636
637                 i++;
638                 mvert++;
639
640                 BM_CHECK_ELEMENT(v);
641         }
642         bm->elem_index_dirty &= ~BM_VERT;
643
644         med = medge;
645         i = 0;
646         BM_ITER_MESH (e, &iter, bm, BM_EDGES_OF_MESH) {
647                 med->v1 = BM_elem_index_get(e->v1);
648                 med->v2 = BM_elem_index_get(e->v2);
649
650                 med->flag = BM_edge_flag_to_mflag(e);
651
652                 BM_elem_index_set(e, i); /* set_inline */
653
654                 /* copy over customdata */
655                 CustomData_from_bmesh_block(&bm->edata, &me->edata, e->head.data, i);
656
657                 bmesh_quick_edgedraw_flag(med, e);
658
659                 if (cd_edge_crease_offset  != -1) med->crease  = BM_ELEM_CD_GET_FLOAT_AS_UCHAR(e, cd_edge_crease_offset);
660                 if (cd_edge_bweight_offset != -1) med->bweight = BM_ELEM_CD_GET_FLOAT_AS_UCHAR(e, cd_edge_bweight_offset);
661
662                 i++;
663                 med++;
664                 BM_CHECK_ELEMENT(e);
665         }
666         bm->elem_index_dirty &= ~BM_EDGE;
667
668         i = 0;
669         j = 0;
670         BM_ITER_MESH (f, &iter, bm, BM_FACES_OF_MESH) {
671                 BMLoop *l_iter, *l_first;
672                 mpoly->loopstart = j;
673                 mpoly->totloop = f->len;
674                 mpoly->mat_nr = f->mat_nr;
675                 mpoly->flag = BM_face_flag_to_mflag(f);
676
677                 l_iter = l_first = BM_FACE_FIRST_LOOP(f);
678                 do {
679                         mloop->e = BM_elem_index_get(l_iter->e);
680                         mloop->v = BM_elem_index_get(l_iter->v);
681
682                         /* copy over customdata */
683                         CustomData_from_bmesh_block(&bm->ldata, &me->ldata, l_iter->head.data, j);
684
685                         j++;
686                         mloop++;
687                         BM_CHECK_ELEMENT(l_iter);
688                         BM_CHECK_ELEMENT(l_iter->e);
689                         BM_CHECK_ELEMENT(l_iter->v);
690                 } while ((l_iter = l_iter->next) != l_first);
691
692                 if (f == bm->act_face) me->act_face = i;
693
694                 /* copy over customdata */
695                 CustomData_from_bmesh_block(&bm->pdata, &me->pdata, f->head.data, i);
696
697                 i++;
698                 mpoly++;
699                 BM_CHECK_ELEMENT(f);
700         }
701
702         /* patch hook indices and vertex parents */
703         if (params->calc_object_remap && (ototvert > 0)) {
704                 BLI_assert(bmain != NULL);
705                 Object *ob;
706                 ModifierData *md;
707                 BMVert **vertMap = NULL;
708
709                 for (ob = bmain->object.first; ob; ob = ob->id.next) {
710                         if ((ob->parent) && (ob->parent->data == me) && ELEM(ob->partype, PARVERT1, PARVERT3)) {
711
712                                 if (vertMap == NULL) {
713                                         vertMap = bm_to_mesh_vertex_map(bm, ototvert);
714                                 }
715
716                                 if (ob->par1 < ototvert) {
717                                         eve = vertMap[ob->par1];
718                                         if (eve) ob->par1 = BM_elem_index_get(eve);
719                                 }
720                                 if (ob->par2 < ototvert) {
721                                         eve = vertMap[ob->par2];
722                                         if (eve) ob->par2 = BM_elem_index_get(eve);
723                                 }
724                                 if (ob->par3 < ototvert) {
725                                         eve = vertMap[ob->par3];
726                                         if (eve) ob->par3 = BM_elem_index_get(eve);
727                                 }
728
729                         }
730                         if (ob->data == me) {
731                                 for (md = ob->modifiers.first; md; md = md->next) {
732                                         if (md->type == eModifierType_Hook) {
733                                                 HookModifierData *hmd = (HookModifierData *) md;
734
735                                                 if (vertMap == NULL) {
736                                                         vertMap = bm_to_mesh_vertex_map(bm, ototvert);
737                                                 }
738
739                                                 for (i = j = 0; i < hmd->totindex; i++) {
740                                                         if (hmd->indexar[i] < ototvert) {
741                                                                 eve = vertMap[hmd->indexar[i]];
742
743                                                                 if (eve) {
744                                                                         hmd->indexar[j++] = BM_elem_index_get(eve);
745                                                                 }
746                                                         }
747                                                         else {
748                                                                 j++;
749                                                         }
750                                                 }
751
752                                                 hmd->totindex = j;
753                                         }
754                                 }
755                         }
756                 }
757
758                 if (vertMap) MEM_freeN(vertMap);
759         }
760
761         BKE_mesh_update_customdata_pointers(me, false);
762
763         {
764                 BMEditSelection *selected;
765                 me->totselect = BLI_listbase_count(&(bm->selected));
766
767                 MEM_SAFE_FREE(me->mselect);
768                 if (me->totselect != 0) {
769                         me->mselect = MEM_mallocN(sizeof(MSelect) * me->totselect, "Mesh selection history");
770                 }
771
772                 for (i = 0, selected = bm->selected.first; selected; i++, selected = selected->next) {
773                         if (selected->htype == BM_VERT) {
774                                 me->mselect[i].type = ME_VSEL;
775
776                         }
777                         else if (selected->htype == BM_EDGE) {
778                                 me->mselect[i].type = ME_ESEL;
779
780                         }
781                         else if (selected->htype == BM_FACE) {
782                                 me->mselect[i].type = ME_FSEL;
783                         }
784
785                         me->mselect[i].index = BM_elem_index_get(selected->ele);
786                 }
787         }
788
789         /* see comment below, this logic is in twice */
790
791         if (me->key) {
792                 const int cd_shape_keyindex_offset = CustomData_get_offset(&bm->vdata, CD_SHAPE_KEYINDEX);
793
794                 KeyBlock *currkey;
795                 KeyBlock *actkey = BLI_findlink(&me->key->block, bm->shapenr - 1);
796
797                 float (*ofs)[3] = NULL;
798
799                 /* go through and find any shapekey customdata layers
800                  * that might not have corresponding KeyBlocks, and add them if
801                  * necessary */
802                 j = 0;
803                 for (i = 0; i < bm->vdata.totlayer; i++) {
804                         if (bm->vdata.layers[i].type != CD_SHAPEKEY)
805                                 continue;
806
807                         for (currkey = me->key->block.first; currkey; currkey = currkey->next) {
808                                 if (currkey->uid == bm->vdata.layers[i].uid)
809                                         break;
810                         }
811
812                         if (!currkey) {
813                                 currkey = BKE_keyblock_add(me->key, bm->vdata.layers[i].name);
814                                 currkey->uid = bm->vdata.layers[i].uid;
815                         }
816
817                         j++;
818                 }
819
820
821                 /* editing the base key should update others */
822                 if ((me->key->type == KEY_RELATIVE) && /* only need offsets for relative shape keys */
823                     (actkey != NULL) &&                /* unlikely, but the active key may not be valid if the
824                                                         * bmesh and the mesh are out of sync */
825                     (oldverts != NULL))                /* not used here, but 'oldverts' is used later for applying 'ofs' */
826                 {
827                         const bool act_is_basis = BKE_keyblock_is_basis(me->key, bm->shapenr - 1);
828
829                         /* active key is a base */
830                         if (act_is_basis && (cd_shape_keyindex_offset != -1)) {
831                                 float (*fp)[3] = actkey->data;
832
833                                 ofs = MEM_callocN(sizeof(float) * 3 * bm->totvert,  "currkey->data");
834                                 mvert = me->mvert;
835                                 BM_ITER_MESH_INDEX (eve, &iter, bm, BM_VERTS_OF_MESH, i) {
836                                         const int keyi = BM_ELEM_CD_GET_INT(eve, cd_shape_keyindex_offset);
837
838                                         if (keyi != ORIGINDEX_NONE) {
839                                                 sub_v3_v3v3(ofs[i], mvert->co, fp[keyi]);
840                                         }
841                                         else {
842                                                 /* if there are new vertices in the mesh, we can't propagate the offset
843                                                  * because it will only work for the existing vertices and not the new
844                                                  * ones, creating a mess when doing e.g. subdivide + translate */
845                                                 MEM_freeN(ofs);
846                                                 ofs = NULL;
847                                                 break;
848                                         }
849
850                                         mvert++;
851                                 }
852                         }
853                 }
854
855                 for (currkey = me->key->block.first; currkey; currkey = currkey->next) {
856                         const bool apply_offset = (ofs && (currkey != actkey) && (bm->shapenr - 1 == currkey->relative));
857                         int cd_shape_offset;
858                         int keyi;
859                         float (*ofs_pt)[3] = ofs;
860                         float *newkey, (*oldkey)[3], *fp;
861
862                         j = bm_to_mesh_shape_layer_index_from_kb(bm, currkey);
863                         cd_shape_offset = CustomData_get_n_offset(&bm->vdata, CD_SHAPEKEY, j);
864
865
866                         fp = newkey = MEM_callocN(me->key->elemsize * bm->totvert,  "currkey->data");
867                         oldkey = currkey->data;
868
869                         mvert = me->mvert;
870                         BM_ITER_MESH (eve, &iter, bm, BM_VERTS_OF_MESH) {
871
872                                 if (currkey == actkey) {
873                                         copy_v3_v3(fp, eve->co);
874
875                                         if (actkey != me->key->refkey) { /* important see bug [#30771] */
876                                                 if (cd_shape_keyindex_offset != -1) {
877                                                         if (oldverts) {
878                                                                 keyi = BM_ELEM_CD_GET_INT(eve, cd_shape_keyindex_offset);
879                                                                 if (keyi != ORIGINDEX_NONE && keyi < currkey->totelem) { /* valid old vertex */
880                                                                         copy_v3_v3(mvert->co, oldverts[keyi].co);
881                                                                 }
882                                                         }
883                                                 }
884                                         }
885                                 }
886                                 else if (j != -1) {
887                                         /* in most cases this runs */
888                                         copy_v3_v3(fp, BM_ELEM_CD_GET_VOID_P(eve, cd_shape_offset));
889                                 }
890                                 else if ((oldkey != NULL) &&
891                                          (cd_shape_keyindex_offset != -1) &&
892                                          ((keyi = BM_ELEM_CD_GET_INT(eve, cd_shape_keyindex_offset)) != ORIGINDEX_NONE) &&
893                                          (keyi < currkey->totelem))
894                                 {
895                                         /* old method of reconstructing keys via vertice's original key indices,
896                                          * currently used if the new method above fails (which is theoretically
897                                          * possible in certain cases of undo) */
898                                         copy_v3_v3(fp, oldkey[keyi]);
899                                 }
900                                 else {
901                                         /* fail! fill in with dummy value */
902                                         copy_v3_v3(fp, mvert->co);
903                                 }
904
905                                 /* propagate edited basis offsets to other shapes */
906                                 if (apply_offset) {
907                                         add_v3_v3(fp, *ofs_pt++);
908                                         /* Apply back new coordinates of offsetted shapekeys into BMesh.
909                                          * Otherwise, in case we call again BM_mesh_bm_to_me on same BMesh, we'll apply diff from previous
910                                          * call to BM_mesh_bm_to_me, to shapekey values from *original creation of the BMesh*. See T50524. */
911                                         copy_v3_v3(BM_ELEM_CD_GET_VOID_P(eve, cd_shape_offset), fp);
912                                 }
913
914                                 fp += 3;
915                                 mvert++;
916                         }
917
918                         currkey->totelem = bm->totvert;
919                         if (currkey->data) {
920                                 MEM_freeN(currkey->data);
921                         }
922                         currkey->data = newkey;
923                 }
924
925                 if (ofs) MEM_freeN(ofs);
926         }
927
928         if (oldverts) MEM_freeN(oldverts);
929
930         /* topology could be changed, ensure mdisps are ok */
931         multires_topology_changed(me);
932
933         /* to be removed as soon as COW is enabled by default. */
934         BKE_mesh_runtime_clear_geometry(me);
935 }
936
937 /**
938  * A version of #BM_mesh_bm_to_me intended for getting the mesh to pass to the modifier stack for evaluation,
939  * instad of mode switching (where we make sure all data is kept and do expensive lookups to maintain shape keys).
940  *
941  * Key differences:
942  *
943  * - Don't support merging with existing mesh.
944  * - Ignore shape-keys.
945  * - Ignore vertex-parents.
946  * - Ignore selection history.
947  * - Uses simpler method to calculate #ME_EDGEDRAW
948  * - Uses #CD_MASK_DERIVEDMESH instead of #CD_MASK_MESH.
949  *
950  * \note Was `cddm_from_bmesh_ex` in 2.7x, removed `MFace` support.
951  */
952 void BM_mesh_bm_to_me_for_eval(BMesh *bm, Mesh *me, const int64_t cd_mask_extra)
953 {
954         /* must be an empty mesh. */
955         BLI_assert(me->totvert == 0);
956         BLI_assert((cd_mask_extra & CD_MASK_SHAPEKEY) == 0);
957
958         me->totvert = bm->totvert;
959         me->totedge = bm->totedge;
960         me->totface = 0;
961         me->totloop = bm->totloop;
962         me->totpoly = bm->totface;
963
964         CustomData_add_layer(&me->vdata, CD_ORIGINDEX, CD_CALLOC, NULL, bm->totvert);
965         CustomData_add_layer(&me->edata, CD_ORIGINDEX, CD_CALLOC, NULL, bm->totedge);
966         CustomData_add_layer(&me->pdata, CD_ORIGINDEX, CD_CALLOC, NULL, bm->totface);
967
968         CustomData_add_layer(&me->vdata, CD_MVERT, CD_CALLOC, NULL, bm->totvert);
969         CustomData_add_layer(&me->edata, CD_MEDGE, CD_CALLOC, NULL, bm->totedge);
970         CustomData_add_layer(&me->ldata, CD_MLOOP, CD_CALLOC, NULL, bm->totloop);
971         CustomData_add_layer(&me->pdata, CD_MPOLY, CD_CALLOC, NULL, bm->totface);
972
973         /* don't process shapekeys, we only feed them through the modifier stack as needed,
974          * e.g. for applying modifiers or the like*/
975         const CustomDataMask mask = (CD_MASK_DERIVEDMESH | cd_mask_extra) & ~CD_MASK_SHAPEKEY;
976         CustomData_merge(&bm->vdata, &me->vdata, mask, CD_CALLOC, me->totvert);
977         CustomData_merge(&bm->edata, &me->edata, mask, CD_CALLOC, me->totedge);
978         CustomData_merge(&bm->ldata, &me->ldata, mask, CD_CALLOC, me->totloop);
979         CustomData_merge(&bm->pdata, &me->pdata, mask, CD_CALLOC, me->totpoly);
980
981         BKE_mesh_update_customdata_pointers(me, false);
982
983         BMIter iter;
984         BMVert *eve;
985         BMEdge *eed;
986         BMFace *efa;
987         MVert *mvert = me->mvert;
988         MEdge *medge = me->medge;
989         MLoop *mloop = me->mloop;
990         MPoly *mpoly = me->mpoly;
991         int *index, add_orig;
992         unsigned int i, j;
993
994         const int cd_vert_bweight_offset = CustomData_get_offset(&bm->vdata, CD_BWEIGHT);
995         const int cd_edge_bweight_offset = CustomData_get_offset(&bm->edata, CD_BWEIGHT);
996         const int cd_edge_crease_offset  = CustomData_get_offset(&bm->edata, CD_CREASE);
997
998         me->runtime.deformed_only = true;
999
1000         /* don't add origindex layer if one already exists */
1001         add_orig = !CustomData_has_layer(&bm->pdata, CD_ORIGINDEX);
1002
1003         index = CustomData_get_layer(&me->vdata, CD_ORIGINDEX);
1004
1005         BM_ITER_MESH_INDEX (eve, &iter, bm, BM_VERTS_OF_MESH, i) {
1006                 MVert *mv = &mvert[i];
1007
1008                 copy_v3_v3(mv->co, eve->co);
1009
1010                 BM_elem_index_set(eve, i); /* set_inline */
1011
1012                 normal_float_to_short_v3(mv->no, eve->no);
1013
1014                 mv->flag = BM_vert_flag_to_mflag(eve);
1015
1016                 if (cd_vert_bweight_offset != -1) mv->bweight = BM_ELEM_CD_GET_FLOAT_AS_UCHAR(eve, cd_vert_bweight_offset);
1017
1018                 if (add_orig) *index++ = i;
1019
1020                 CustomData_from_bmesh_block(&bm->vdata, &me->vdata, eve->head.data, i);
1021         }
1022         bm->elem_index_dirty &= ~BM_VERT;
1023
1024         index = CustomData_get_layer(&me->edata, CD_ORIGINDEX);
1025         BM_ITER_MESH_INDEX (eed, &iter, bm, BM_EDGES_OF_MESH, i) {
1026                 MEdge *med = &medge[i];
1027
1028                 BM_elem_index_set(eed, i); /* set_inline */
1029
1030                 med->v1 = BM_elem_index_get(eed->v1);
1031                 med->v2 = BM_elem_index_get(eed->v2);
1032
1033                 med->flag = BM_edge_flag_to_mflag(eed);
1034
1035                 /* handle this differently to editmode switching,
1036                  * only enable draw for single user edges rather then calculating angle */
1037                 if ((med->flag & ME_EDGEDRAW) == 0) {
1038                         if (eed->l && eed->l == eed->l->radial_next) {
1039                                 med->flag |= ME_EDGEDRAW;
1040                         }
1041                 }
1042
1043                 if (cd_edge_crease_offset  != -1) med->crease  = BM_ELEM_CD_GET_FLOAT_AS_UCHAR(eed, cd_edge_crease_offset);
1044                 if (cd_edge_bweight_offset != -1) med->bweight = BM_ELEM_CD_GET_FLOAT_AS_UCHAR(eed, cd_edge_bweight_offset);
1045
1046                 CustomData_from_bmesh_block(&bm->edata, &me->edata, eed->head.data, i);
1047                 if (add_orig) *index++ = i;
1048         }
1049         bm->elem_index_dirty &= ~BM_EDGE;
1050
1051         index = CustomData_get_layer(&me->pdata, CD_ORIGINDEX);
1052         j = 0;
1053         BM_ITER_MESH_INDEX (efa, &iter, bm, BM_FACES_OF_MESH, i) {
1054                 BMLoop *l_iter;
1055                 BMLoop *l_first;
1056                 MPoly *mp = &mpoly[i];
1057
1058                 BM_elem_index_set(efa, i); /* set_inline */
1059
1060                 mp->totloop = efa->len;
1061                 mp->flag = BM_face_flag_to_mflag(efa);
1062                 mp->loopstart = j;
1063                 mp->mat_nr = efa->mat_nr;
1064
1065                 l_iter = l_first = BM_FACE_FIRST_LOOP(efa);
1066                 do {
1067                         mloop->v = BM_elem_index_get(l_iter->v);
1068                         mloop->e = BM_elem_index_get(l_iter->e);
1069                         CustomData_from_bmesh_block(&bm->ldata, &me->ldata, l_iter->head.data, j);
1070
1071                         BM_elem_index_set(l_iter, j); /* set_inline */
1072
1073                         j++;
1074                         mloop++;
1075                 } while ((l_iter = l_iter->next) != l_first);
1076
1077                 CustomData_from_bmesh_block(&bm->pdata, &me->pdata, efa->head.data, i);
1078
1079                 if (add_orig) *index++ = i;
1080         }
1081         bm->elem_index_dirty &= ~(BM_FACE | BM_LOOP);
1082
1083         me->cd_flag = BM_mesh_cd_flag_from_bmesh(bm);
1084 }