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