Modifiers: Port mesh_calc_modifiers from DerivedMesh to Mesh
[blender.git] / source / blender / blenkernel / intern / DerivedMesh.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  * The Original Code is Copyright (C) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/DerivedMesh.c
29  *  \ingroup bke
30  */
31
32
33 #include <string.h>
34 #include <limits.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "DNA_cloth_types.h"
39 #include "DNA_key_types.h"
40 #include "DNA_material_types.h"
41 #include "DNA_mesh_types.h"
42 #include "DNA_meshdata_types.h"
43 #include "DNA_object_types.h"
44 #include "DNA_scene_types.h"
45
46 #include "BLI_array.h"
47 #include "BLI_blenlib.h"
48 #include "BLI_bitmap.h"
49 #include "BLI_math.h"
50 #include "BLI_utildefines.h"
51 #include "BLI_linklist.h"
52 #include "BLI_task.h"
53
54 #include "BKE_cdderivedmesh.h"
55 #include "BKE_colorband.h"
56 #include "BKE_editmesh.h"
57 #include "BKE_key.h"
58 #include "BKE_layer.h"
59 #include "BKE_library.h"
60 #include "BKE_material.h"
61 #include "BKE_modifier.h"
62 #include "BKE_mesh.h"
63 #include "BKE_mesh_mapping.h"
64 #include "BKE_mesh_tangent.h"
65 #include "BKE_object.h"
66 #include "BKE_object_deform.h"
67 #include "BKE_paint.h"
68 #include "BKE_multires.h"
69 #include "BKE_bvhutils.h"
70 #include "BKE_deform.h"
71 #include "BKE_global.h" /* For debug flag, DM_update_tessface_data() func. */
72
73 #include "BLI_sys_types.h" /* for intptr_t support */
74
75 #include "DEG_depsgraph.h"
76 #include "DEG_depsgraph_query.h"
77
78 #ifdef WITH_OPENSUBDIV
79 #  include "DNA_userdef_types.h"
80 #endif
81
82 /* very slow! enable for testing only! */
83 //#define USE_MODIFIER_VALIDATE
84
85 #ifdef USE_MODIFIER_VALIDATE
86 #  define ASSERT_IS_VALID_DM(dm) (BLI_assert((dm == NULL) || (DM_is_valid(dm) == true)))
87 #  define ASSERT_IS_VALID_MESH(mesh) (BLI_assert((mesh == NULL) || (BKE_mesh_is_valid(mesh) == true)))
88 #else
89 #  define ASSERT_IS_VALID_DM(dm)
90 #  define ASSERT_IS_VALID_MESH(mesh)
91 #endif
92
93
94 static ThreadRWMutex loops_cache_lock = PTHREAD_RWLOCK_INITIALIZER;
95
96
97 static void add_shapekey_layers(DerivedMesh *dm, Mesh *me, Object *ob);
98 static void shapekey_layers_to_keyblocks(DerivedMesh *dm, Mesh *me, int actshape_uid);
99
100 static void mesh_init_origspace(Mesh *mesh);
101
102
103 /* -------------------------------------------------------------------- */
104
105 static MVert *dm_getVertArray(DerivedMesh *dm)
106 {
107         MVert *mvert = CustomData_get_layer(&dm->vertData, CD_MVERT);
108
109         if (!mvert) {
110                 mvert = CustomData_add_layer(&dm->vertData, CD_MVERT, CD_CALLOC, NULL,
111                                              dm->getNumVerts(dm));
112                 CustomData_set_layer_flag(&dm->vertData, CD_MVERT, CD_FLAG_TEMPORARY);
113                 dm->copyVertArray(dm, mvert);
114         }
115
116         return mvert;
117 }
118
119 static MEdge *dm_getEdgeArray(DerivedMesh *dm)
120 {
121         MEdge *medge = CustomData_get_layer(&dm->edgeData, CD_MEDGE);
122
123         if (!medge) {
124                 medge = CustomData_add_layer(&dm->edgeData, CD_MEDGE, CD_CALLOC, NULL,
125                                              dm->getNumEdges(dm));
126                 CustomData_set_layer_flag(&dm->edgeData, CD_MEDGE, CD_FLAG_TEMPORARY);
127                 dm->copyEdgeArray(dm, medge);
128         }
129
130         return medge;
131 }
132
133 static MFace *dm_getTessFaceArray(DerivedMesh *dm)
134 {
135         MFace *mface = CustomData_get_layer(&dm->faceData, CD_MFACE);
136
137         if (!mface) {
138                 int numTessFaces = dm->getNumTessFaces(dm);
139                 
140                 if (!numTessFaces) {
141                         /* Do not add layer if there's no elements in it, this leads to issues later when
142                          * this layer is needed with non-zero size, but currently CD stuff does not check
143                          * for requested layer size on creation and just returns layer which was previously
144                          * added (sergey) */
145                         return NULL;
146                 }
147                 
148                 mface = CustomData_add_layer(&dm->faceData, CD_MFACE, CD_CALLOC, NULL, numTessFaces);
149                 CustomData_set_layer_flag(&dm->faceData, CD_MFACE, CD_FLAG_TEMPORARY);
150                 dm->copyTessFaceArray(dm, mface);
151         }
152
153         return mface;
154 }
155
156 static MLoop *dm_getLoopArray(DerivedMesh *dm)
157 {
158         MLoop *mloop = CustomData_get_layer(&dm->loopData, CD_MLOOP);
159
160         if (!mloop) {
161                 mloop = CustomData_add_layer(&dm->loopData, CD_MLOOP, CD_CALLOC, NULL,
162                                              dm->getNumLoops(dm));
163                 CustomData_set_layer_flag(&dm->loopData, CD_MLOOP, CD_FLAG_TEMPORARY);
164                 dm->copyLoopArray(dm, mloop);
165         }
166
167         return mloop;
168 }
169
170 static MPoly *dm_getPolyArray(DerivedMesh *dm)
171 {
172         MPoly *mpoly = CustomData_get_layer(&dm->polyData, CD_MPOLY);
173
174         if (!mpoly) {
175                 mpoly = CustomData_add_layer(&dm->polyData, CD_MPOLY, CD_CALLOC, NULL,
176                                              dm->getNumPolys(dm));
177                 CustomData_set_layer_flag(&dm->polyData, CD_MPOLY, CD_FLAG_TEMPORARY);
178                 dm->copyPolyArray(dm, mpoly);
179         }
180
181         return mpoly;
182 }
183
184 static MVert *dm_dupVertArray(DerivedMesh *dm)
185 {
186         MVert *tmp = MEM_malloc_arrayN(dm->getNumVerts(dm), sizeof(*tmp),
187                                  "dm_dupVertArray tmp");
188
189         if (tmp) dm->copyVertArray(dm, tmp);
190
191         return tmp;
192 }
193
194 static MEdge *dm_dupEdgeArray(DerivedMesh *dm)
195 {
196         MEdge *tmp = MEM_malloc_arrayN(dm->getNumEdges(dm), sizeof(*tmp),
197                                  "dm_dupEdgeArray tmp");
198
199         if (tmp) dm->copyEdgeArray(dm, tmp);
200
201         return tmp;
202 }
203
204 static MFace *dm_dupFaceArray(DerivedMesh *dm)
205 {
206         MFace *tmp = MEM_malloc_arrayN(dm->getNumTessFaces(dm), sizeof(*tmp),
207                                  "dm_dupFaceArray tmp");
208
209         if (tmp) dm->copyTessFaceArray(dm, tmp);
210
211         return tmp;
212 }
213
214 static MLoop *dm_dupLoopArray(DerivedMesh *dm)
215 {
216         MLoop *tmp = MEM_malloc_arrayN(dm->getNumLoops(dm), sizeof(*tmp),
217                                  "dm_dupLoopArray tmp");
218
219         if (tmp) dm->copyLoopArray(dm, tmp);
220
221         return tmp;
222 }
223
224 static MPoly *dm_dupPolyArray(DerivedMesh *dm)
225 {
226         MPoly *tmp = MEM_malloc_arrayN(dm->getNumPolys(dm), sizeof(*tmp),
227                                  "dm_dupPolyArray tmp");
228
229         if (tmp) dm->copyPolyArray(dm, tmp);
230
231         return tmp;
232 }
233
234 static int dm_getNumLoopTri(DerivedMesh *dm)
235 {
236         const int numlooptris = poly_to_tri_count(dm->getNumPolys(dm), dm->getNumLoops(dm));
237         BLI_assert(ELEM(dm->looptris.num, 0, numlooptris));
238         return numlooptris;
239 }
240
241 static const MLoopTri *dm_getLoopTriArray(DerivedMesh *dm)
242 {
243         MLoopTri *looptri;
244
245         BLI_rw_mutex_lock(&loops_cache_lock, THREAD_LOCK_READ);
246         looptri = dm->looptris.array;
247         BLI_rw_mutex_unlock(&loops_cache_lock);
248
249         if (looptri != NULL) {
250                 BLI_assert(dm->getNumLoopTri(dm) == dm->looptris.num);
251         }
252         else {
253                 BLI_rw_mutex_lock(&loops_cache_lock, THREAD_LOCK_WRITE);
254                 /* We need to ensure array is still NULL inside mutex-protected code, some other thread might have already
255                  * recomputed those looptris. */
256                 if (dm->looptris.array == NULL) {
257                         dm->recalcLoopTri(dm);
258                 }
259                 looptri = dm->looptris.array;
260                 BLI_rw_mutex_unlock(&loops_cache_lock);
261         }
262         return looptri;
263 }
264
265 static CustomData *dm_getVertCData(DerivedMesh *dm)
266 {
267         return &dm->vertData;
268 }
269
270 static CustomData *dm_getEdgeCData(DerivedMesh *dm)
271 {
272         return &dm->edgeData;
273 }
274
275 static CustomData *dm_getTessFaceCData(DerivedMesh *dm)
276 {
277         return &dm->faceData;
278 }
279
280 static CustomData *dm_getLoopCData(DerivedMesh *dm)
281 {
282         return &dm->loopData;
283 }
284
285 static CustomData *dm_getPolyCData(DerivedMesh *dm)
286 {
287         return &dm->polyData;
288 }
289
290 /**
291  * Utility function to initialize a DerivedMesh's function pointers to
292  * the default implementation (for those functions which have a default)
293  */
294 void DM_init_funcs(DerivedMesh *dm)
295 {
296         /* default function implementations */
297         dm->getVertArray = dm_getVertArray;
298         dm->getEdgeArray = dm_getEdgeArray;
299         dm->getTessFaceArray = dm_getTessFaceArray;
300         dm->getLoopArray = dm_getLoopArray;
301         dm->getPolyArray = dm_getPolyArray;
302         dm->dupVertArray = dm_dupVertArray;
303         dm->dupEdgeArray = dm_dupEdgeArray;
304         dm->dupTessFaceArray = dm_dupFaceArray;
305         dm->dupLoopArray = dm_dupLoopArray;
306         dm->dupPolyArray = dm_dupPolyArray;
307
308         dm->getLoopTriArray = dm_getLoopTriArray;
309
310         /* subtypes handle getting actual data */
311         dm->getNumLoopTri = dm_getNumLoopTri;
312
313         dm->getVertDataLayout = dm_getVertCData;
314         dm->getEdgeDataLayout = dm_getEdgeCData;
315         dm->getTessFaceDataLayout = dm_getTessFaceCData;
316         dm->getLoopDataLayout = dm_getLoopCData;
317         dm->getPolyDataLayout = dm_getPolyCData;
318
319         dm->getVertData = DM_get_vert_data;
320         dm->getEdgeData = DM_get_edge_data;
321         dm->getTessFaceData = DM_get_tessface_data;
322         dm->getPolyData = DM_get_poly_data;
323         dm->getVertDataArray = DM_get_vert_data_layer;
324         dm->getEdgeDataArray = DM_get_edge_data_layer;
325         dm->getTessFaceDataArray = DM_get_tessface_data_layer;
326         dm->getPolyDataArray = DM_get_poly_data_layer;
327         dm->getLoopDataArray = DM_get_loop_data_layer;
328
329         dm->bvhCache = NULL;
330 }
331
332 /**
333  * Utility function to initialize a DerivedMesh for the desired number
334  * of vertices, edges and faces (doesn't allocate memory for them, just
335  * sets up the custom data layers)
336  */
337 void DM_init(
338         DerivedMesh *dm, DerivedMeshType type, int numVerts, int numEdges,
339         int numTessFaces, int numLoops, int numPolys)
340 {
341         dm->type = type;
342         dm->numVertData = numVerts;
343         dm->numEdgeData = numEdges;
344         dm->numTessFaceData = numTessFaces;
345         dm->numLoopData = numLoops;
346         dm->numPolyData = numPolys;
347
348         DM_init_funcs(dm);
349         
350         dm->needsFree = 1;
351         dm->dirty = 0;
352
353         /* don't use CustomData_reset(...); because we dont want to touch customdata */
354         copy_vn_i(dm->vertData.typemap, CD_NUMTYPES, -1);
355         copy_vn_i(dm->edgeData.typemap, CD_NUMTYPES, -1);
356         copy_vn_i(dm->faceData.typemap, CD_NUMTYPES, -1);
357         copy_vn_i(dm->loopData.typemap, CD_NUMTYPES, -1);
358         copy_vn_i(dm->polyData.typemap, CD_NUMTYPES, -1);
359 }
360
361 /**
362  * Utility function to initialize a DerivedMesh for the desired number
363  * of vertices, edges and faces, with a layer setup copied from source
364  */
365 void DM_from_template_ex(
366         DerivedMesh *dm, DerivedMesh *source, DerivedMeshType type,
367         int numVerts, int numEdges, int numTessFaces,
368         int numLoops, int numPolys,
369         CustomDataMask mask)
370 {
371         CustomData_copy(&source->vertData, &dm->vertData, mask, CD_CALLOC, numVerts);
372         CustomData_copy(&source->edgeData, &dm->edgeData, mask, CD_CALLOC, numEdges);
373         CustomData_copy(&source->faceData, &dm->faceData, mask, CD_CALLOC, numTessFaces);
374         CustomData_copy(&source->loopData, &dm->loopData, mask, CD_CALLOC, numLoops);
375         CustomData_copy(&source->polyData, &dm->polyData, mask, CD_CALLOC, numPolys);
376
377         dm->cd_flag = source->cd_flag;
378
379         dm->type = type;
380         dm->numVertData = numVerts;
381         dm->numEdgeData = numEdges;
382         dm->numTessFaceData = numTessFaces;
383         dm->numLoopData = numLoops;
384         dm->numPolyData = numPolys;
385
386         DM_init_funcs(dm);
387
388         dm->needsFree = 1;
389         dm->dirty = 0;
390 }
391 void DM_from_template(
392         DerivedMesh *dm, DerivedMesh *source, DerivedMeshType type,
393         int numVerts, int numEdges, int numTessFaces,
394         int numLoops, int numPolys)
395 {
396         DM_from_template_ex(
397                 dm, source, type,
398                 numVerts, numEdges, numTessFaces,
399                 numLoops, numPolys,
400                 CD_MASK_DERIVEDMESH);
401 }
402
403 int DM_release(DerivedMesh *dm)
404 {
405         if (dm->needsFree) {
406                 bvhcache_free(&dm->bvhCache);
407                 CustomData_free(&dm->vertData, dm->numVertData);
408                 CustomData_free(&dm->edgeData, dm->numEdgeData);
409                 CustomData_free(&dm->faceData, dm->numTessFaceData);
410                 CustomData_free(&dm->loopData, dm->numLoopData);
411                 CustomData_free(&dm->polyData, dm->numPolyData);
412
413                 if (dm->mat) {
414                         MEM_freeN(dm->mat);
415                         dm->mat = NULL;
416                         dm->totmat = 0;
417                 }
418
419                 MEM_SAFE_FREE(dm->looptris.array);
420                 dm->looptris.num = 0;
421                 dm->looptris.num_alloc = 0;
422
423                 return 1;
424         }
425         else {
426                 CustomData_free_temporary(&dm->vertData, dm->numVertData);
427                 CustomData_free_temporary(&dm->edgeData, dm->numEdgeData);
428                 CustomData_free_temporary(&dm->faceData, dm->numTessFaceData);
429                 CustomData_free_temporary(&dm->loopData, dm->numLoopData);
430                 CustomData_free_temporary(&dm->polyData, dm->numPolyData);
431
432                 return 0;
433         }
434 }
435
436 void DM_DupPolys(DerivedMesh *source, DerivedMesh *target)
437 {
438         CustomData_free(&target->loopData, source->numLoopData);
439         CustomData_free(&target->polyData, source->numPolyData);
440
441         CustomData_copy(&source->loopData, &target->loopData, CD_MASK_DERIVEDMESH, CD_DUPLICATE, source->numLoopData);
442         CustomData_copy(&source->polyData, &target->polyData, CD_MASK_DERIVEDMESH, CD_DUPLICATE, source->numPolyData);
443
444         target->numLoopData = source->numLoopData;
445         target->numPolyData = source->numPolyData;
446
447         if (!CustomData_has_layer(&target->polyData, CD_MPOLY)) {
448                 MPoly *mpoly;
449                 MLoop *mloop;
450
451                 mloop = source->dupLoopArray(source);
452                 mpoly = source->dupPolyArray(source);
453                 CustomData_add_layer(&target->loopData, CD_MLOOP, CD_ASSIGN, mloop, source->numLoopData);
454                 CustomData_add_layer(&target->polyData, CD_MPOLY, CD_ASSIGN, mpoly, source->numPolyData);
455         }
456 }
457
458 void DM_ensure_normals(DerivedMesh *dm)
459 {
460         if (dm->dirty & DM_DIRTY_NORMALS) {
461                 dm->calcNormals(dm);
462         }
463         BLI_assert((dm->dirty & DM_DIRTY_NORMALS) == 0);
464 }
465
466 static void DM_calc_loop_normals(DerivedMesh *dm, const bool use_split_normals, float split_angle)
467 {
468         dm->calcLoopNormals(dm, use_split_normals, split_angle);
469         dm->dirty |= DM_DIRTY_TESS_CDLAYERS;
470 }
471
472 /* note: until all modifiers can take MPoly's as input,
473  * use this at the start of modifiers  */
474 void DM_ensure_tessface(DerivedMesh *dm)
475 {
476         const int numTessFaces = dm->getNumTessFaces(dm);
477         const int numPolys =     dm->getNumPolys(dm);
478
479         if ((numTessFaces == 0) && (numPolys != 0)) {
480                 dm->recalcTessellation(dm);
481
482                 if (dm->getNumTessFaces(dm) != 0) {
483                         /* printf("info %s: polys -> ngons calculated\n", __func__); */
484                 }
485                 else {
486                         printf("warning %s: could not create tessfaces from %d polygons, dm->type=%u\n",
487                                __func__, numPolys, dm->type);
488                 }
489         }
490
491         else if (dm->dirty & DM_DIRTY_TESS_CDLAYERS) {
492                 BLI_assert(CustomData_has_layer(&dm->faceData, CD_ORIGINDEX) || numTessFaces == 0);
493                 DM_update_tessface_data(dm);
494         }
495
496         dm->dirty &= ~DM_DIRTY_TESS_CDLAYERS;
497 }
498
499 /**
500  * Ensure the array is large enough
501  *
502  * /note This function must always be thread-protected by caller. It should only be used by internal code.
503  */
504 void DM_ensure_looptri_data(DerivedMesh *dm)
505 {
506         const unsigned int totpoly = dm->numPolyData;
507         const unsigned int totloop = dm->numLoopData;
508         const int looptris_num = poly_to_tri_count(totpoly, totloop);
509
510         BLI_assert(dm->looptris.array_wip == NULL);
511
512         SWAP(MLoopTri *, dm->looptris.array, dm->looptris.array_wip);
513
514         if ((looptris_num > dm->looptris.num_alloc) ||
515             (looptris_num < dm->looptris.num_alloc * 2) ||
516             (totpoly == 0))
517         {
518                 MEM_SAFE_FREE(dm->looptris.array_wip);
519                 dm->looptris.num_alloc = 0;
520                 dm->looptris.num = 0;
521         }
522
523         if (totpoly) {
524                 if (dm->looptris.array_wip == NULL) {
525                         dm->looptris.array_wip = MEM_malloc_arrayN(looptris_num, sizeof(*dm->looptris.array_wip), __func__);
526                         dm->looptris.num_alloc = looptris_num;
527                 }
528
529                 dm->looptris.num = looptris_num;
530         }
531 }
532
533 void DM_verttri_from_looptri(MVertTri *verttri, const MLoop *mloop, const MLoopTri *looptri, int looptri_num)
534 {
535         int i;
536         for (i = 0; i < looptri_num; i++) {
537                 verttri[i].tri[0] = mloop[looptri[i].tri[0]].v;
538                 verttri[i].tri[1] = mloop[looptri[i].tri[1]].v;
539                 verttri[i].tri[2] = mloop[looptri[i].tri[2]].v;
540         }
541 }
542
543 /* Update tessface CD data from loop/poly ones. Needed when not retessellating after modstack evaluation. */
544 /* NOTE: Assumes dm has valid tessellated data! */
545 void DM_update_tessface_data(DerivedMesh *dm)
546 {
547         MFace *mf, *mface = dm->getTessFaceArray(dm);
548         MPoly *mp = dm->getPolyArray(dm);
549         MLoop *ml = dm->getLoopArray(dm);
550
551         CustomData *fdata = dm->getTessFaceDataLayout(dm);
552         CustomData *ldata = dm->getLoopDataLayout(dm);
553
554         const int totface = dm->getNumTessFaces(dm);
555         int mf_idx;
556
557         int *polyindex = CustomData_get_layer(fdata, CD_ORIGINDEX);
558         unsigned int (*loopindex)[4];
559
560         /* Should never occure, but better abort than segfault! */
561         if (!polyindex)
562                 return;
563
564         CustomData_from_bmeshpoly(fdata, ldata, totface);
565
566         if (CustomData_has_layer(fdata, CD_MTFACE) ||
567             CustomData_has_layer(fdata, CD_MCOL) ||
568             CustomData_has_layer(fdata, CD_PREVIEW_MCOL) ||
569             CustomData_has_layer(fdata, CD_ORIGSPACE) ||
570             CustomData_has_layer(fdata, CD_TESSLOOPNORMAL) ||
571             CustomData_has_layer(fdata, CD_TANGENT))
572         {
573                 loopindex = MEM_malloc_arrayN(totface, sizeof(*loopindex), __func__);
574
575                 for (mf_idx = 0, mf = mface; mf_idx < totface; mf_idx++, mf++) {
576                         const int mf_len = mf->v4 ? 4 : 3;
577                         unsigned int *ml_idx = loopindex[mf_idx];
578                         int i, not_done;
579
580                         /* Find out loop indices. */
581                         /* NOTE: This assumes tessface are valid and in sync with loop/poly... Else, most likely, segfault! */
582                         for (i = mp[polyindex[mf_idx]].loopstart, not_done = mf_len; not_done; i++) {
583                                 const int tf_v = BKE_MESH_TESSFACE_VINDEX_ORDER(mf, ml[i].v);
584                                 if (tf_v != -1) {
585                                         ml_idx[tf_v] = i;
586                                         not_done--;
587                                 }
588                         }
589                 }
590
591                 /* NOTE: quad detection issue - fourth vertidx vs fourth loopidx:
592                  * Here, our tfaces' fourth vertex index is never 0 for a quad. However, we know our fourth loop index may be
593                  * 0 for quads (because our quads may have been rotated compared to their org poly, see tessellation code).
594                  * So we pass the MFace's, and BKE_mesh_loops_to_tessdata will use MFace->v4 index as quad test.
595                  */
596                 BKE_mesh_loops_to_tessdata(fdata, ldata, mface, polyindex, loopindex, totface);
597
598                 MEM_freeN(loopindex);
599         }
600
601         if (G.debug & G_DEBUG)
602                 printf("%s: Updated tessellated customdata of dm %p\n", __func__, dm);
603
604         dm->dirty &= ~DM_DIRTY_TESS_CDLAYERS;
605 }
606
607 void DM_generate_tangent_tessface_data(DerivedMesh *dm, bool generate)
608 {
609         MFace *mf, *mface = dm->getTessFaceArray(dm);
610         MPoly *mp = dm->getPolyArray(dm);
611         MLoop *ml = dm->getLoopArray(dm);
612
613         CustomData *fdata = dm->getTessFaceDataLayout(dm);
614         CustomData *ldata = dm->getLoopDataLayout(dm);
615
616         const int totface = dm->getNumTessFaces(dm);
617         int mf_idx;
618
619         int *polyindex = CustomData_get_layer(fdata, CD_ORIGINDEX);
620         unsigned int (*loopindex)[4] = NULL;
621
622         /* Should never occure, but better abort than segfault! */
623         if (!polyindex)
624                 return;
625
626         if (generate) {
627                 for (int j = 0; j < ldata->totlayer; j++) {
628                         if (ldata->layers[j].type == CD_TANGENT) {
629                                 CustomData_add_layer_named(fdata, CD_TANGENT, CD_CALLOC, NULL, totface, ldata->layers[j].name);
630                                 CustomData_bmesh_update_active_layers(fdata, ldata);
631
632                                 if (!loopindex) {
633                                         loopindex = MEM_malloc_arrayN(totface, sizeof(*loopindex), __func__);
634                                         for (mf_idx = 0, mf = mface; mf_idx < totface; mf_idx++, mf++) {
635                                                 const int mf_len = mf->v4 ? 4 : 3;
636                                                 unsigned int *ml_idx = loopindex[mf_idx];
637
638                                                 /* Find out loop indices. */
639                                                 /* NOTE: This assumes tessface are valid and in sync with loop/poly... Else, most likely, segfault! */
640                                                 for (int i = mp[polyindex[mf_idx]].loopstart, not_done = mf_len; not_done; i++) {
641                                                         const int tf_v = BKE_MESH_TESSFACE_VINDEX_ORDER(mf, ml[i].v);
642                                                         if (tf_v != -1) {
643                                                                 ml_idx[tf_v] = i;
644                                                                 not_done--;
645                                                         }
646                                                 }
647                                         }
648                                 }
649
650                                 /* NOTE: quad detection issue - fourth vertidx vs fourth loopidx:
651                                  * Here, our tfaces' fourth vertex index is never 0 for a quad. However, we know our fourth loop index may be
652                                  * 0 for quads (because our quads may have been rotated compared to their org poly, see tessellation code).
653                                  * So we pass the MFace's, and BKE_mesh_loops_to_tessdata will use MFace->v4 index as quad test.
654                                  */
655                                 BKE_mesh_tangent_loops_to_tessdata(fdata, ldata, mface, polyindex, loopindex, totface, ldata->layers[j].name);
656                         }
657                 }
658                 if (loopindex)
659                         MEM_freeN(loopindex);
660                 BLI_assert(CustomData_from_bmeshpoly_test(fdata, ldata, true));
661         }
662
663         if (G.debug & G_DEBUG)
664                 printf("%s: Updated tessellated tangents of dm %p\n", __func__, dm);
665 }
666
667
668 void DM_update_materials(DerivedMesh *dm, Object *ob)
669 {
670         int i, totmat = ob->totcol + 1; /* materials start from 1, default material is 0 */
671
672         if (dm->totmat != totmat) {
673                 dm->totmat = totmat;
674                 /* invalidate old materials */
675                 if (dm->mat)
676                         MEM_freeN(dm->mat);
677
678                 dm->mat = MEM_malloc_arrayN(totmat, sizeof(*dm->mat), "DerivedMesh.mat");
679         }
680
681         /* we leave last material as empty - rationale here is being able to index
682          * the materials by using the mf->mat_nr directly and leaving the last
683          * material as NULL in case no materials exist on mesh, so indexing will not fail */
684         for (i = 0; i < totmat - 1; i++) {
685                 dm->mat[i] = give_current_material(ob, i + 1);
686         }
687         dm->mat[i] = NULL;
688 }
689
690 MLoopUV *DM_paint_uvlayer_active_get(DerivedMesh *dm, int mat_nr)
691 {
692         MLoopUV *uv_base;
693
694         BLI_assert(mat_nr < dm->totmat);
695
696         if (dm->mat[mat_nr] && dm->mat[mat_nr]->texpaintslot &&
697             dm->mat[mat_nr]->texpaintslot[dm->mat[mat_nr]->paint_active_slot].uvname)
698         {
699                 uv_base = CustomData_get_layer_named(&dm->loopData, CD_MLOOPUV,
700                                                      dm->mat[mat_nr]->texpaintslot[dm->mat[mat_nr]->paint_active_slot].uvname);
701                 /* This can fail if we have changed the name in the UV layer list and have assigned the old name in the material
702                  * texture slot.*/
703                 if (!uv_base)
704                         uv_base = CustomData_get_layer(&dm->loopData, CD_MLOOPUV);
705         }
706         else {
707                 uv_base = CustomData_get_layer(&dm->loopData, CD_MLOOPUV);
708         }
709
710         return uv_base;
711 }
712
713 void DM_to_mesh(DerivedMesh *dm, Mesh *me, Object *ob, CustomDataMask mask, bool take_ownership)
714 {
715         /* dm might depend on me, so we need to do everything with a local copy */
716         Mesh tmp = *me;
717         int totvert, totedge /*, totface */ /* UNUSED */, totloop, totpoly;
718         int did_shapekeys = 0;
719         int alloctype = CD_DUPLICATE;
720
721         if (take_ownership && dm->type == DM_TYPE_CDDM && dm->needsFree) {
722                 bool has_any_referenced_layers =
723                         CustomData_has_referenced(&dm->vertData) ||
724                         CustomData_has_referenced(&dm->edgeData) ||
725                         CustomData_has_referenced(&dm->loopData) ||
726                         CustomData_has_referenced(&dm->faceData) ||
727                         CustomData_has_referenced(&dm->polyData);
728                 if (!has_any_referenced_layers) {
729                         alloctype = CD_ASSIGN;
730                 }
731         }
732
733         CustomData_reset(&tmp.vdata);
734         CustomData_reset(&tmp.edata);
735         CustomData_reset(&tmp.fdata);
736         CustomData_reset(&tmp.ldata);
737         CustomData_reset(&tmp.pdata);
738
739         DM_ensure_normals(dm);
740
741         totvert = tmp.totvert = dm->getNumVerts(dm);
742         totedge = tmp.totedge = dm->getNumEdges(dm);
743         totloop = tmp.totloop = dm->getNumLoops(dm);
744         totpoly = tmp.totpoly = dm->getNumPolys(dm);
745         tmp.totface = 0;
746
747         CustomData_copy(&dm->vertData, &tmp.vdata, mask, alloctype, totvert);
748         CustomData_copy(&dm->edgeData, &tmp.edata, mask, alloctype, totedge);
749         CustomData_copy(&dm->loopData, &tmp.ldata, mask, alloctype, totloop);
750         CustomData_copy(&dm->polyData, &tmp.pdata, mask, alloctype, totpoly);
751         tmp.cd_flag = dm->cd_flag;
752
753         if (CustomData_has_layer(&dm->vertData, CD_SHAPEKEY)) {
754                 KeyBlock *kb;
755                 int uid;
756                 
757                 if (ob) {
758                         kb = BLI_findlink(&me->key->block, ob->shapenr - 1);
759                         if (kb) {
760                                 uid = kb->uid;
761                         }
762                         else {
763                                 printf("%s: error - could not find active shapekey %d!\n",
764                                        __func__, ob->shapenr - 1);
765
766                                 uid = INT_MAX;
767                         }
768                 }
769                 else {
770                         /* if no object, set to INT_MAX so we don't mess up any shapekey layers */
771                         uid = INT_MAX;
772                 }
773
774                 shapekey_layers_to_keyblocks(dm, me, uid);
775                 did_shapekeys = 1;
776         }
777
778         /* copy texture space */
779         if (ob) {
780                 BKE_mesh_texspace_copy_from_object(&tmp, ob);
781         }
782         
783         /* not all DerivedMeshes store their verts/edges/faces in CustomData, so
784          * we set them here in case they are missing */
785         if (!CustomData_has_layer(&tmp.vdata, CD_MVERT)) {
786                 CustomData_add_layer(&tmp.vdata, CD_MVERT, CD_ASSIGN,
787                                      (alloctype == CD_ASSIGN) ? dm->getVertArray(dm) : dm->dupVertArray(dm),
788                                      totvert);
789         }
790         if (!CustomData_has_layer(&tmp.edata, CD_MEDGE)) {
791                 CustomData_add_layer(&tmp.edata, CD_MEDGE, CD_ASSIGN,
792                                      (alloctype == CD_ASSIGN) ? dm->getEdgeArray(dm) : dm->dupEdgeArray(dm),
793                                      totedge);
794         }
795         if (!CustomData_has_layer(&tmp.pdata, CD_MPOLY)) {
796                 tmp.mloop = (alloctype == CD_ASSIGN) ? dm->getLoopArray(dm) : dm->dupLoopArray(dm);
797                 tmp.mpoly = (alloctype == CD_ASSIGN) ? dm->getPolyArray(dm) : dm->dupPolyArray(dm);
798
799                 CustomData_add_layer(&tmp.ldata, CD_MLOOP, CD_ASSIGN, tmp.mloop, tmp.totloop);
800                 CustomData_add_layer(&tmp.pdata, CD_MPOLY, CD_ASSIGN, tmp.mpoly, tmp.totpoly);
801         }
802
803         /* object had got displacement layer, should copy this layer to save sculpted data */
804         /* NOTE: maybe some other layers should be copied? nazgul */
805         if (CustomData_has_layer(&me->ldata, CD_MDISPS)) {
806                 if (totloop == me->totloop) {
807                         MDisps *mdisps = CustomData_get_layer(&me->ldata, CD_MDISPS);
808                         CustomData_add_layer(&tmp.ldata, CD_MDISPS, alloctype, mdisps, totloop);
809                 }
810         }
811
812         /* yes, must be before _and_ after tessellate */
813         BKE_mesh_update_customdata_pointers(&tmp, false);
814
815         /* since 2.65 caller must do! */
816         // BKE_mesh_tessface_calc(&tmp);
817
818         CustomData_free(&me->vdata, me->totvert);
819         CustomData_free(&me->edata, me->totedge);
820         CustomData_free(&me->fdata, me->totface);
821         CustomData_free(&me->ldata, me->totloop);
822         CustomData_free(&me->pdata, me->totpoly);
823
824         /* ok, this should now use new CD shapekey data,
825          * which should be fed through the modifier
826          * stack */
827         if (tmp.totvert != me->totvert && !did_shapekeys && me->key) {
828                 printf("%s: YEEK! this should be recoded! Shape key loss!: ID '%s'\n", __func__, tmp.id.name);
829                 if (tmp.key)
830                         id_us_min(&tmp.key->id);
831                 tmp.key = NULL;
832         }
833
834         /* Clear selection history */
835         MEM_SAFE_FREE(tmp.mselect);
836         tmp.totselect = 0;
837         BLI_assert(ELEM(tmp.bb, NULL, me->bb));
838         if (me->bb) {
839                 MEM_freeN(me->bb);
840                 tmp.bb = NULL;
841         }
842
843         /* skip the listbase */
844         MEMCPY_STRUCT_OFS(me, &tmp, id.prev);
845
846         if (take_ownership) {
847                 if (alloctype == CD_ASSIGN) {
848                         CustomData_free_typemask(&dm->vertData, dm->numVertData, ~mask);
849                         CustomData_free_typemask(&dm->edgeData, dm->numEdgeData, ~mask);
850                         CustomData_free_typemask(&dm->loopData, dm->numLoopData, ~mask);
851                         CustomData_free_typemask(&dm->polyData, dm->numPolyData, ~mask);
852                 }
853                 dm->release(dm);
854         }
855 }
856
857 void DM_to_meshkey(DerivedMesh *dm, Mesh *me, KeyBlock *kb)
858 {
859         int a, totvert = dm->getNumVerts(dm);
860         float *fp;
861         MVert *mvert;
862         
863         if (totvert == 0 || me->totvert == 0 || me->totvert != totvert) {
864                 return;
865         }
866         
867         if (kb->data) MEM_freeN(kb->data);
868         kb->data = MEM_malloc_arrayN(me->key->elemsize, me->totvert, "kb->data");
869         kb->totelem = totvert;
870         
871         fp = kb->data;
872         mvert = dm->getVertDataArray(dm, CD_MVERT);
873         
874         for (a = 0; a < kb->totelem; a++, fp += 3, mvert++) {
875                 copy_v3_v3(fp, mvert->co);
876         }
877 }
878
879 /**
880  * set the CD_FLAG_NOCOPY flag in custom data layers where the mask is
881  * zero for the layer type, so only layer types specified by the mask
882  * will be copied
883  */
884 void DM_set_only_copy(DerivedMesh *dm, CustomDataMask mask)
885 {
886         CustomData_set_only_copy(&dm->vertData, mask);
887         CustomData_set_only_copy(&dm->edgeData, mask);
888         CustomData_set_only_copy(&dm->faceData, mask);
889         /* this wasn't in 2.63 and is disabled for 2.64 because it gives problems with
890          * weight paint mode when there are modifiers applied, needs further investigation,
891          * see replies to r50969, Campbell */
892 #if 0
893         CustomData_set_only_copy(&dm->loopData, mask);
894         CustomData_set_only_copy(&dm->polyData, mask);
895 #endif
896 }
897
898 void mesh_set_only_copy(Mesh *mesh, CustomDataMask mask)
899 {
900         CustomData_set_only_copy(&mesh->vdata, mask);
901         CustomData_set_only_copy(&mesh->edata, mask);
902         CustomData_set_only_copy(&mesh->fdata, mask);
903         /* this wasn't in 2.63 and is disabled for 2.64 because it gives problems with
904          * weight paint mode when there are modifiers applied, needs further investigation,
905          * see replies to r50969, Campbell */
906 #if 0
907         CustomData_set_only_copy(&mesh->ldata, mask);
908         CustomData_set_only_copy(&mesh->pdata, mask);
909 #endif
910 }
911
912 void DM_add_vert_layer(DerivedMesh *dm, int type, int alloctype, void *layer)
913 {
914         CustomData_add_layer(&dm->vertData, type, alloctype, layer, dm->numVertData);
915 }
916
917 void DM_add_edge_layer(DerivedMesh *dm, int type, int alloctype, void *layer)
918 {
919         CustomData_add_layer(&dm->edgeData, type, alloctype, layer, dm->numEdgeData);
920 }
921
922 void DM_add_tessface_layer(DerivedMesh *dm, int type, int alloctype, void *layer)
923 {
924         CustomData_add_layer(&dm->faceData, type, alloctype, layer, dm->numTessFaceData);
925 }
926
927 void DM_add_loop_layer(DerivedMesh *dm, int type, int alloctype, void *layer)
928 {
929         CustomData_add_layer(&dm->loopData, type, alloctype, layer, dm->numLoopData);
930 }
931
932 void DM_add_poly_layer(DerivedMesh *dm, int type, int alloctype, void *layer)
933 {
934         CustomData_add_layer(&dm->polyData, type, alloctype, layer, dm->numPolyData);
935 }
936
937 void *DM_get_vert_data(DerivedMesh *dm, int index, int type)
938 {
939         BLI_assert(index >= 0 && index < dm->getNumVerts(dm));
940         return CustomData_get(&dm->vertData, index, type);
941 }
942
943 void *DM_get_edge_data(DerivedMesh *dm, int index, int type)
944 {
945         BLI_assert(index >= 0 && index < dm->getNumEdges(dm));
946         return CustomData_get(&dm->edgeData, index, type);
947 }
948
949 void *DM_get_tessface_data(DerivedMesh *dm, int index, int type)
950 {
951         BLI_assert(index >= 0 && index < dm->getNumTessFaces(dm));
952         return CustomData_get(&dm->faceData, index, type);
953 }
954
955 void *DM_get_poly_data(DerivedMesh *dm, int index, int type)
956 {
957         BLI_assert(index >= 0 && index < dm->getNumPolys(dm));
958         return CustomData_get(&dm->polyData, index, type);
959 }
960
961
962 void *DM_get_vert_data_layer(DerivedMesh *dm, int type)
963 {
964         if (type == CD_MVERT)
965                 return dm->getVertArray(dm);
966
967         return CustomData_get_layer(&dm->vertData, type);
968 }
969
970 void *DM_get_edge_data_layer(DerivedMesh *dm, int type)
971 {
972         if (type == CD_MEDGE)
973                 return dm->getEdgeArray(dm);
974
975         return CustomData_get_layer(&dm->edgeData, type);
976 }
977
978 void *DM_get_tessface_data_layer(DerivedMesh *dm, int type)
979 {
980         if (type == CD_MFACE)
981                 return dm->getTessFaceArray(dm);
982
983         return CustomData_get_layer(&dm->faceData, type);
984 }
985
986 void *DM_get_poly_data_layer(DerivedMesh *dm, int type)
987 {
988         return CustomData_get_layer(&dm->polyData, type);
989 }
990
991 void *DM_get_loop_data_layer(DerivedMesh *dm, int type)
992 {
993         return CustomData_get_layer(&dm->loopData, type);
994 }
995
996 void DM_set_vert_data(DerivedMesh *dm, int index, int type, void *data)
997 {
998         CustomData_set(&dm->vertData, index, type, data);
999 }
1000
1001 void DM_set_edge_data(DerivedMesh *dm, int index, int type, void *data)
1002 {
1003         CustomData_set(&dm->edgeData, index, type, data);
1004 }
1005
1006 void DM_set_tessface_data(DerivedMesh *dm, int index, int type, void *data)
1007 {
1008         CustomData_set(&dm->faceData, index, type, data);
1009 }
1010
1011 void DM_copy_vert_data(DerivedMesh *source, DerivedMesh *dest,
1012                        int source_index, int dest_index, int count)
1013 {
1014         CustomData_copy_data(&source->vertData, &dest->vertData,
1015                              source_index, dest_index, count);
1016 }
1017
1018 void DM_copy_edge_data(DerivedMesh *source, DerivedMesh *dest,
1019                        int source_index, int dest_index, int count)
1020 {
1021         CustomData_copy_data(&source->edgeData, &dest->edgeData,
1022                              source_index, dest_index, count);
1023 }
1024
1025 void DM_copy_tessface_data(DerivedMesh *source, DerivedMesh *dest,
1026                            int source_index, int dest_index, int count)
1027 {
1028         CustomData_copy_data(&source->faceData, &dest->faceData,
1029                              source_index, dest_index, count);
1030 }
1031
1032 void DM_copy_loop_data(DerivedMesh *source, DerivedMesh *dest,
1033                        int source_index, int dest_index, int count)
1034 {
1035         CustomData_copy_data(&source->loopData, &dest->loopData,
1036                              source_index, dest_index, count);
1037 }
1038
1039 void DM_copy_poly_data(DerivedMesh *source, DerivedMesh *dest,
1040                        int source_index, int dest_index, int count)
1041 {
1042         CustomData_copy_data(&source->polyData, &dest->polyData,
1043                              source_index, dest_index, count);
1044 }
1045
1046 void DM_free_vert_data(struct DerivedMesh *dm, int index, int count)
1047 {
1048         CustomData_free_elem(&dm->vertData, index, count);
1049 }
1050
1051 void DM_free_edge_data(struct DerivedMesh *dm, int index, int count)
1052 {
1053         CustomData_free_elem(&dm->edgeData, index, count);
1054 }
1055
1056 void DM_free_tessface_data(struct DerivedMesh *dm, int index, int count)
1057 {
1058         CustomData_free_elem(&dm->faceData, index, count);
1059 }
1060
1061 void DM_free_loop_data(struct DerivedMesh *dm, int index, int count)
1062 {
1063         CustomData_free_elem(&dm->loopData, index, count);
1064 }
1065
1066 void DM_free_poly_data(struct DerivedMesh *dm, int index, int count)
1067 {
1068         CustomData_free_elem(&dm->polyData, index, count);
1069 }
1070
1071 /**
1072  * interpolates vertex data from the vertices indexed by src_indices in the
1073  * source mesh using the given weights and stores the result in the vertex
1074  * indexed by dest_index in the dest mesh
1075  */
1076 void DM_interp_vert_data(
1077         DerivedMesh *source, DerivedMesh *dest,
1078         int *src_indices, float *weights,
1079         int count, int dest_index)
1080 {
1081         CustomData_interp(&source->vertData, &dest->vertData, src_indices,
1082                           weights, NULL, count, dest_index);
1083 }
1084
1085 /**
1086  * interpolates edge data from the edges indexed by src_indices in the
1087  * source mesh using the given weights and stores the result in the edge indexed
1088  * by dest_index in the dest mesh.
1089  * if weights is NULL, all weights default to 1.
1090  * if vert_weights is non-NULL, any per-vertex edge data is interpolated using
1091  * vert_weights[i] multiplied by weights[i].
1092  */
1093 void DM_interp_edge_data(
1094         DerivedMesh *source, DerivedMesh *dest,
1095         int *src_indices,
1096         float *weights, EdgeVertWeight *vert_weights,
1097         int count, int dest_index)
1098 {
1099         CustomData_interp(&source->edgeData, &dest->edgeData, src_indices,
1100                           weights, (float *)vert_weights, count, dest_index);
1101 }
1102
1103 /**
1104  * interpolates face data from the faces indexed by src_indices in the
1105  * source mesh using the given weights and stores the result in the face indexed
1106  * by dest_index in the dest mesh.
1107  * if weights is NULL, all weights default to 1.
1108  * if vert_weights is non-NULL, any per-vertex face data is interpolated using
1109  * vert_weights[i] multiplied by weights[i].
1110  */
1111 void DM_interp_tessface_data(
1112         DerivedMesh *source, DerivedMesh *dest,
1113         int *src_indices,
1114         float *weights, FaceVertWeight *vert_weights,
1115         int count, int dest_index)
1116 {
1117         CustomData_interp(&source->faceData, &dest->faceData, src_indices,
1118                           weights, (float *)vert_weights, count, dest_index);
1119 }
1120
1121 void DM_swap_tessface_data(DerivedMesh *dm, int index, const int *corner_indices)
1122 {
1123         CustomData_swap_corners(&dm->faceData, index, corner_indices);
1124 }
1125
1126 void DM_interp_loop_data(
1127         DerivedMesh *source, DerivedMesh *dest,
1128         int *src_indices,
1129         float *weights, int count, int dest_index)
1130 {
1131         CustomData_interp(&source->loopData, &dest->loopData, src_indices,
1132                           weights, NULL, count, dest_index);
1133 }
1134
1135 void DM_interp_poly_data(
1136         DerivedMesh *source, DerivedMesh *dest,
1137         int *src_indices,
1138         float *weights, int count, int dest_index)
1139 {
1140         CustomData_interp(&source->polyData, &dest->polyData, src_indices,
1141                           weights, NULL, count, dest_index);
1142 }
1143
1144 DerivedMesh *mesh_create_derived(Mesh *me, float (*vertCos)[3])
1145 {
1146         DerivedMesh *dm = CDDM_from_mesh(me);
1147         
1148         if (!dm)
1149                 return NULL;
1150         
1151         if (vertCos) {
1152                 CDDM_apply_vert_coords(dm, vertCos);
1153         }
1154
1155         return dm;
1156 }
1157
1158 DerivedMesh *mesh_create_derived_for_modifier(
1159         struct Depsgraph *depsgraph, Scene *scene, Object *ob,
1160         ModifierData *md, int build_shapekey_layers)
1161 {
1162         Mesh *me = ob->data;
1163         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
1164         DerivedMesh *dm;
1165         KeyBlock *kb;
1166         ModifierEvalContext mectx = {depsgraph, ob, 0};
1167
1168         md->scene = scene;
1169         
1170         if (!(md->mode & eModifierMode_Realtime)) {
1171                 return NULL;
1172         }
1173
1174         if (mti->isDisabled && mti->isDisabled(md, 0)) {
1175                 return NULL;
1176         }
1177         
1178         if (build_shapekey_layers && me->key && (kb = BLI_findlink(&me->key->block, ob->shapenr - 1))) {
1179                 BKE_keyblock_convert_to_mesh(kb, me);
1180         }
1181         
1182         if (mti->type == eModifierTypeType_OnlyDeform) {
1183                 int numVerts;
1184                 /* Always get the vertex coordinates from the original mesh. Otherwise
1185                  * there is the risk of deforming already-deformed coordinates. */
1186                 Mesh *mesh_orig_id = (Mesh *)DEG_get_original_id(&me->id);
1187                 float (*deformedVerts)[3] = BKE_mesh_vertexCos_get(mesh_orig_id, &numVerts);
1188
1189                 modwrap_deformVerts(md, &mectx, NULL, deformedVerts, numVerts);
1190                 dm = mesh_create_derived(me, deformedVerts);
1191
1192                 if (build_shapekey_layers)
1193                         add_shapekey_layers(dm, me, ob);
1194                 
1195                 MEM_freeN(deformedVerts);
1196         }
1197         else {
1198                 DerivedMesh *tdm = mesh_create_derived(me, NULL);
1199
1200                 if (build_shapekey_layers)
1201                         add_shapekey_layers(tdm, me, ob);
1202                 
1203                 dm = modwrap_applyModifier(md, &mectx, tdm);
1204                 ASSERT_IS_VALID_DM(dm);
1205
1206                 if (tdm != dm) tdm->release(tdm);
1207         }
1208
1209         return dm;
1210 }
1211
1212 static float (*get_editbmesh_orco_verts(BMEditMesh *em))[3]
1213 {
1214         BMIter iter;
1215         BMVert *eve;
1216         float (*orco)[3];
1217         int i;
1218
1219         /* these may not really be the orco's, but it's only for preview.
1220          * could be solver better once, but isn't simple */
1221         
1222         orco = MEM_malloc_arrayN(em->bm->totvert, sizeof(float) * 3, "BMEditMesh Orco");
1223
1224         BM_ITER_MESH_INDEX (eve, &iter, em->bm, BM_VERTS_OF_MESH, i) {
1225                 copy_v3_v3(orco[i], eve->co);
1226         }
1227         
1228         return orco;
1229 }
1230
1231 /* orco custom data layer */
1232 static float (*get_orco_coords_dm(Object *ob, BMEditMesh *em, int layer, int *free))[3]
1233 {
1234         *free = 0;
1235
1236         if (layer == CD_ORCO) {
1237                 /* get original coordinates */
1238                 *free = 1;
1239
1240                 if (em)
1241                         return get_editbmesh_orco_verts(em);
1242                 else
1243                         return BKE_mesh_orco_verts_get(ob);
1244         }
1245         else if (layer == CD_CLOTH_ORCO) {
1246                 /* apply shape key for cloth, this should really be solved
1247                  * by a more flexible customdata system, but not simple */
1248                 if (!em) {
1249                         ClothModifierData *clmd = (ClothModifierData *)modifiers_findByType(ob, eModifierType_Cloth);
1250                         KeyBlock *kb = BKE_keyblock_from_key(BKE_key_from_object(ob), clmd->sim_parms->shapekey_rest);
1251
1252                         if (kb && kb->data) {
1253                                 return kb->data;
1254                         }
1255                 }
1256
1257                 return NULL;
1258         }
1259
1260         return NULL;
1261 }
1262
1263 static DerivedMesh *create_orco_dm(Object *ob, Mesh *me, BMEditMesh *em, int layer)
1264 {
1265         DerivedMesh *dm;
1266         float (*orco)[3];
1267         int free;
1268
1269         if (em) {
1270                 dm = CDDM_from_editbmesh(em, false, false);
1271         }
1272         else {
1273                 dm = CDDM_from_mesh(me);
1274         }
1275
1276         orco = get_orco_coords_dm(ob, em, layer, &free);
1277
1278         if (orco) {
1279                 CDDM_apply_vert_coords(dm, orco);
1280                 if (free) MEM_freeN(orco);
1281         }
1282
1283         return dm;
1284 }
1285
1286 static Mesh *create_orco_mesh(Object *ob, Mesh *me, BMEditMesh *em, int layer)
1287 {
1288         Mesh *mesh;
1289         float (*orco)[3];
1290         int free;
1291
1292         if (em) {
1293                 mesh = BKE_bmesh_to_mesh_nomain(em->bm, &(struct BMeshToMeshParams){0});
1294         }
1295         else {
1296                 BKE_id_copy_ex(NULL, &me->id, (ID**)&mesh,
1297                         LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_USER_REFCOUNT | LIB_ID_CREATE_NO_DEG_TAG, false);
1298         }
1299
1300         orco = get_orco_coords_dm(ob, em, layer, &free);
1301
1302         if (orco) {
1303                 BKE_mesh_apply_vert_coords(mesh, orco);
1304                 if (free) MEM_freeN(orco);
1305         }
1306
1307         return mesh;
1308 }
1309
1310 static void add_orco_dm(
1311         Object *ob, BMEditMesh *em, DerivedMesh *dm,
1312         DerivedMesh *orcodm, int layer)
1313 {
1314         float (*orco)[3], (*layerorco)[3];
1315         int totvert, free;
1316
1317         totvert = dm->getNumVerts(dm);
1318
1319         if (orcodm) {
1320                 orco = MEM_calloc_arrayN(totvert, sizeof(float[3]), "dm orco");
1321                 free = 1;
1322
1323                 if (orcodm->getNumVerts(orcodm) == totvert)
1324                         orcodm->getVertCos(orcodm, orco);
1325                 else
1326                         dm->getVertCos(dm, orco);
1327         }
1328         else {
1329                 /* TODO(sybren): totvert should potentially change here, as ob->data
1330                  * or em may have a different number of vertices than dm. */
1331                 orco = get_orco_coords_dm(ob, em, layer, &free);
1332         }
1333
1334         if (orco) {
1335                 if (layer == CD_ORCO)
1336                         BKE_mesh_orco_verts_transform(ob->data, orco, totvert, 0);
1337
1338                 if (!(layerorco = DM_get_vert_data_layer(dm, layer))) {
1339                         DM_add_vert_layer(dm, layer, CD_CALLOC, NULL);
1340                         layerorco = DM_get_vert_data_layer(dm, layer);
1341                 }
1342
1343                 memcpy(layerorco, orco, sizeof(float) * 3 * totvert);
1344                 if (free) MEM_freeN(orco);
1345         }
1346 }
1347
1348 static void add_orco_mesh(
1349         Object *ob, BMEditMesh *em, Mesh *mesh,
1350         Mesh *orco_mesh, int layer)
1351 {
1352         float (*orco)[3], (*layerorco)[3];
1353         int totvert, free;
1354
1355         totvert = mesh->totvert;
1356
1357         if (orco_mesh) {
1358                 free = 1;
1359
1360                 if (orco_mesh->totvert == totvert) {
1361                         orco = BKE_mesh_vertexCos_get(orco_mesh, NULL);
1362                 }
1363                 else {
1364                         orco = BKE_mesh_vertexCos_get(mesh, NULL);
1365                 }
1366         }
1367         else {
1368                 /* TODO(sybren): totvert should potentially change here, as ob->data
1369                  * or em may have a different number of vertices than dm. */
1370                 orco = get_orco_coords_dm(ob, em, layer, &free);
1371         }
1372
1373         if (orco) {
1374                 if (layer == CD_ORCO) {
1375                         BKE_mesh_orco_verts_transform(ob->data, orco, totvert, 0);
1376                 }
1377
1378                 if (!(layerorco = CustomData_get_layer(&mesh->vdata, layer))) {
1379                         CustomData_add_layer(&mesh->vdata, layer, CD_CALLOC, NULL, mesh->totvert);
1380                         BKE_mesh_update_customdata_pointers(mesh, false);
1381
1382                         layerorco = CustomData_get_layer(&mesh->vdata, layer);
1383                 }
1384
1385                 memcpy(layerorco, orco, sizeof(float) * 3 * totvert);
1386                 if (free) MEM_freeN(orco);
1387         }
1388 }
1389
1390 /* weight paint colors */
1391
1392 /* Something of a hack, at the moment deal with weightpaint
1393  * by tucking into colors during modifier eval, only in
1394  * wpaint mode. Works ok but need to make sure recalc
1395  * happens on enter/exit wpaint.
1396  */
1397
1398 void weight_to_rgb(float r_rgb[3], const float weight)
1399 {
1400         const float blend = ((weight / 2.0f) + 0.5f);
1401
1402         if (weight <= 0.25f) {    /* blue->cyan */
1403                 r_rgb[0] = 0.0f;
1404                 r_rgb[1] = blend * weight * 4.0f;
1405                 r_rgb[2] = blend;
1406         }
1407         else if (weight <= 0.50f) {  /* cyan->green */
1408                 r_rgb[0] = 0.0f;
1409                 r_rgb[1] = blend;
1410                 r_rgb[2] = blend * (1.0f - ((weight - 0.25f) * 4.0f));
1411         }
1412         else if (weight <= 0.75f) {  /* green->yellow */
1413                 r_rgb[0] = blend * ((weight - 0.50f) * 4.0f);
1414                 r_rgb[1] = blend;
1415                 r_rgb[2] = 0.0f;
1416         }
1417         else if (weight <= 1.0f) {  /* yellow->red */
1418                 r_rgb[0] = blend;
1419                 r_rgb[1] = blend * (1.0f - ((weight - 0.75f) * 4.0f));
1420                 r_rgb[2] = 0.0f;
1421         }
1422         else {
1423                 /* exceptional value, unclamped or nan,
1424                  * avoid uninitialized memory use */
1425                 r_rgb[0] = 1.0f;
1426                 r_rgb[1] = 0.0f;
1427                 r_rgb[2] = 1.0f;
1428         }
1429 }
1430
1431 /* draw_flag's for calc_weightpaint_vert_color */
1432 enum {
1433         /* only one of these should be set, keep first (for easy bit-shifting) */
1434         CALC_WP_GROUP_USER_ACTIVE   = (1 << 1),
1435         CALC_WP_GROUP_USER_ALL      = (1 << 2),
1436
1437         CALC_WP_MULTIPAINT          = (1 << 3),
1438         CALC_WP_AUTO_NORMALIZE      = (1 << 4),
1439         CALC_WP_MIRROR_X            = (1 << 5),
1440 };
1441
1442 typedef struct DMWeightColorInfo {
1443         const ColorBand *coba;
1444         const char *alert_color;
1445 } DMWeightColorInfo;
1446
1447
1448 static int dm_drawflag_calc(const ToolSettings *ts, const Mesh *me)
1449 {
1450         return ((ts->multipaint ? CALC_WP_MULTIPAINT : 0) |
1451                 /* CALC_WP_GROUP_USER_ACTIVE or CALC_WP_GROUP_USER_ALL */
1452                 (1 << ts->weightuser) |
1453                 (ts->auto_normalize ? CALC_WP_AUTO_NORMALIZE : 0) |
1454                 ((me->editflag & ME_EDIT_MIRROR_X) ? CALC_WP_MIRROR_X : 0));
1455 }
1456
1457 static void weightpaint_color(unsigned char r_col[4], DMWeightColorInfo *dm_wcinfo, const float input)
1458 {
1459         float colf[4];
1460
1461         if (dm_wcinfo && dm_wcinfo->coba) {
1462                 BKE_colorband_evaluate(dm_wcinfo->coba, input, colf);
1463         }
1464         else {
1465                 weight_to_rgb(colf, input);
1466         }
1467
1468         /* don't use rgb_float_to_uchar() here because
1469          * the resulting float doesn't need 0-1 clamp check */
1470         r_col[0] = (unsigned char)(colf[0] * 255.0f);
1471         r_col[1] = (unsigned char)(colf[1] * 255.0f);
1472         r_col[2] = (unsigned char)(colf[2] * 255.0f);
1473         r_col[3] = 255;
1474 }
1475
1476
1477 static void calc_weightpaint_vert_color(
1478         unsigned char r_col[4],
1479         const MDeformVert *dv,
1480         DMWeightColorInfo *dm_wcinfo,
1481         const int defbase_tot, const int defbase_act,
1482         const bool *defbase_sel, const int defbase_sel_tot,
1483         const int draw_flag)
1484 {
1485         float input = 0.0f;
1486         
1487         bool show_alert_color = false;
1488
1489         if ((defbase_sel_tot > 1) && (draw_flag & CALC_WP_MULTIPAINT)) {
1490                 /* Multi-Paint feature */
1491                 input = BKE_defvert_multipaint_collective_weight(
1492                         dv, defbase_tot, defbase_sel, defbase_sel_tot, (draw_flag & CALC_WP_AUTO_NORMALIZE) != 0);
1493
1494                 /* make it black if the selected groups have no weight on a vertex */
1495                 if (input == 0.0f) {
1496                         show_alert_color = true;
1497                 }
1498         }
1499         else {
1500                 /* default, non tricky behavior */
1501                 input = defvert_find_weight(dv, defbase_act);
1502
1503                 if (draw_flag & CALC_WP_GROUP_USER_ACTIVE) {
1504                         if (input == 0.0f) {
1505                                 show_alert_color = true;
1506                         }
1507                 }
1508                 else if (draw_flag & CALC_WP_GROUP_USER_ALL) {
1509                         if (input == 0.0f) {
1510                                 show_alert_color = defvert_is_weight_zero(dv, defbase_tot);
1511                         }
1512                 }
1513         }
1514
1515         if (show_alert_color == false) {
1516                 CLAMP(input, 0.0f, 1.0f);
1517                 weightpaint_color(r_col, dm_wcinfo, input);
1518         }
1519         else {
1520                 copy_v3_v3_char((char *)r_col, dm_wcinfo->alert_color);
1521                 r_col[3] = 255;
1522         }
1523 }
1524
1525 static DMWeightColorInfo G_dm_wcinfo;
1526
1527 void vDM_ColorBand_store(const ColorBand *coba, const char alert_color[4])
1528 {
1529         G_dm_wcinfo.coba        = coba;
1530         G_dm_wcinfo.alert_color = alert_color;
1531 }
1532
1533 /**
1534  * return an array of vertex weight colors, caller must free.
1535  *
1536  * \note that we could save some memory and allocate RGB only but then we'd need to
1537  * re-arrange the colors when copying to the face since MCol has odd ordering,
1538  * so leave this as is - campbell
1539  */
1540 static void calc_weightpaint_vert_array(
1541         Object *ob, DerivedMesh *dm, int const draw_flag, DMWeightColorInfo *dm_wcinfo,
1542         unsigned char (*r_wtcol_v)[4])
1543 {
1544         BMEditMesh *em = (dm->type == DM_TYPE_EDITBMESH) ? BKE_editmesh_from_object(ob) : NULL;
1545         const int numVerts = dm->getNumVerts(dm);
1546
1547         if ((ob->actdef != 0) &&
1548             (CustomData_has_layer(em ? &em->bm->vdata : &dm->vertData, CD_MDEFORMVERT)))
1549         {
1550                 unsigned char (*wc)[4] = r_wtcol_v;
1551                 unsigned int i;
1552
1553                 /* variables for multipaint */
1554                 const int defbase_tot = BLI_listbase_count(&ob->defbase);
1555                 const int defbase_act = ob->actdef - 1;
1556
1557                 int defbase_sel_tot = 0;
1558                 bool *defbase_sel = NULL;
1559
1560                 if (draw_flag & CALC_WP_MULTIPAINT) {
1561                         defbase_sel = BKE_object_defgroup_selected_get(ob, defbase_tot, &defbase_sel_tot);
1562
1563                         if (defbase_sel_tot > 1 && (draw_flag & CALC_WP_MIRROR_X)) {
1564                                 BKE_object_defgroup_mirror_selection(ob, defbase_tot, defbase_sel, defbase_sel, &defbase_sel_tot);
1565                         }
1566                 }
1567
1568                 /* editmesh won't have deform verts unless modifiers require it,
1569                  * avoid having to create an array of deform-verts only for drawing
1570                  * by reading from the bmesh directly. */
1571                 if (em) {
1572                         BMIter iter;
1573                         BMVert *eve;
1574                         const int cd_dvert_offset = CustomData_get_offset(&em->bm->vdata, CD_MDEFORMVERT);
1575                         BLI_assert(cd_dvert_offset != -1);
1576
1577                         BM_ITER_MESH_INDEX (eve, &iter, em->bm, BM_VERTS_OF_MESH, i) {
1578                                 const MDeformVert *dv = BM_ELEM_CD_GET_VOID_P(eve, cd_dvert_offset);
1579                                 calc_weightpaint_vert_color(
1580                                         (unsigned char *)wc, dv, dm_wcinfo,
1581                                         defbase_tot, defbase_act, defbase_sel, defbase_sel_tot, draw_flag);
1582                                 wc++;
1583                         }
1584                 }
1585                 else {
1586                         const MDeformVert *dv = DM_get_vert_data_layer(dm, CD_MDEFORMVERT);
1587                         for (i = numVerts; i != 0; i--, wc++, dv++) {
1588                                 calc_weightpaint_vert_color(
1589                                         (unsigned char *)wc, dv, dm_wcinfo,
1590                                         defbase_tot, defbase_act, defbase_sel, defbase_sel_tot, draw_flag);
1591                         }
1592                 }
1593
1594                 if (defbase_sel) {
1595                         MEM_freeN(defbase_sel);
1596                 }
1597         }
1598         else {
1599                 unsigned char col[4];
1600                 if ((ob->actdef == 0) && !BLI_listbase_is_empty(&ob->defbase)) {
1601                         /* color-code for missing data (full brightness isn't easy on the eye). */
1602                         ARRAY_SET_ITEMS(col, 0xa0, 0, 0xa0, 0xff);
1603                 }
1604                 else if (draw_flag & (CALC_WP_GROUP_USER_ACTIVE | CALC_WP_GROUP_USER_ALL)) {
1605                         copy_v3_v3_char((char *)col, dm_wcinfo->alert_color);
1606                         col[3] = 255;
1607                 }
1608                 else {
1609                         weightpaint_color(col, dm_wcinfo, 0.0f);
1610                 }
1611                 copy_vn_i((int *)r_wtcol_v, numVerts, *((int *)col));
1612         }
1613 }
1614
1615 static void calc_weightpaint_vert_array_mesh(
1616         Object *ob, Mesh *mesh, int const draw_flag, DMWeightColorInfo *dm_wcinfo,
1617         unsigned char (*r_wtcol_v)[4])
1618 {
1619         BMEditMesh *em = BKE_editmesh_from_object(ob);
1620         const int numVerts = mesh->totvert;
1621
1622         if ((ob->actdef != 0) &&
1623             (CustomData_has_layer(em ? &em->bm->vdata : &mesh->vdata, CD_MDEFORMVERT)))
1624         {
1625                 unsigned char (*wc)[4] = r_wtcol_v;
1626                 unsigned int i;
1627
1628                 /* variables for multipaint */
1629                 const int defbase_tot = BLI_listbase_count(&ob->defbase);
1630                 const int defbase_act = ob->actdef - 1;
1631
1632                 int defbase_sel_tot = 0;
1633                 bool *defbase_sel = NULL;
1634
1635                 if (draw_flag & CALC_WP_MULTIPAINT) {
1636                         defbase_sel = BKE_object_defgroup_selected_get(ob, defbase_tot, &defbase_sel_tot);
1637
1638                         if (defbase_sel_tot > 1 && (draw_flag & CALC_WP_MIRROR_X)) {
1639                                 BKE_object_defgroup_mirror_selection(ob, defbase_tot, defbase_sel, defbase_sel, &defbase_sel_tot);
1640                         }
1641                 }
1642
1643                 /* editmesh won't have deform verts unless modifiers require it,
1644                  * avoid having to create an array of deform-verts only for drawing
1645                  * by reading from the bmesh directly. */
1646                 if (em) {
1647                         BMIter iter;
1648                         BMVert *eve;
1649                         const int cd_dvert_offset = CustomData_get_offset(&em->bm->vdata, CD_MDEFORMVERT);
1650                         BLI_assert(cd_dvert_offset != -1);
1651
1652                         BM_ITER_MESH_INDEX (eve, &iter, em->bm, BM_VERTS_OF_MESH, i) {
1653                                 const MDeformVert *dv = BM_ELEM_CD_GET_VOID_P(eve, cd_dvert_offset);
1654                                 calc_weightpaint_vert_color(
1655                                         (unsigned char *)wc, dv, dm_wcinfo,
1656                                         defbase_tot, defbase_act, defbase_sel, defbase_sel_tot, draw_flag);
1657                                 wc++;
1658                         }
1659                 }
1660                 else {
1661                         const MDeformVert *dv = CustomData_get_layer(&mesh->vdata, CD_MDEFORMVERT);
1662                         for (i = numVerts; i != 0; i--, wc++, dv++) {
1663                                 calc_weightpaint_vert_color(
1664                                         (unsigned char *)wc, dv, dm_wcinfo,
1665                                         defbase_tot, defbase_act, defbase_sel, defbase_sel_tot, draw_flag);
1666                         }
1667                 }
1668
1669                 if (defbase_sel) {
1670                         MEM_freeN(defbase_sel);
1671                 }
1672         }
1673         else {
1674                 unsigned char col[4];
1675                 if ((ob->actdef == 0) && !BLI_listbase_is_empty(&ob->defbase)) {
1676                         /* color-code for missing data (full brightness isn't easy on the eye). */
1677                         ARRAY_SET_ITEMS(col, 0xa0, 0, 0xa0, 0xff);
1678                 }
1679                 else if (draw_flag & (CALC_WP_GROUP_USER_ACTIVE | CALC_WP_GROUP_USER_ALL)) {
1680                         copy_v3_v3_char((char *)col, dm_wcinfo->alert_color);
1681                         col[3] = 255;
1682                 }
1683                 else {
1684                         weightpaint_color(col, dm_wcinfo, 0.0f);
1685                 }
1686                 copy_vn_i((int *)r_wtcol_v, numVerts, *((int *)col));
1687         }
1688 }
1689
1690 /** return an array of vertex weight colors from given weights, caller must free.
1691  *
1692  * \note that we could save some memory and allocate RGB only but then we'd need to
1693  * re-arrange the colors when copying to the face since MCol has odd ordering,
1694  * so leave this as is - campbell
1695  */
1696 static void calc_colors_from_weights_array(
1697         const int num, const float *weights,
1698         unsigned char (*r_wtcol_v)[4])
1699 {
1700         unsigned char (*wc)[4] = r_wtcol_v;
1701         int i;
1702
1703         for (i = 0; i < num; i++, wc++, weights++) {
1704                 weightpaint_color((unsigned char *)wc, NULL, *weights);
1705         }
1706 }
1707
1708 void DM_update_weight_mcol(
1709         Object *ob, DerivedMesh *dm, int const draw_flag,
1710         float *weights, int num, const int *indices)
1711 {
1712         BMEditMesh *em = (dm->type == DM_TYPE_EDITBMESH) ? BKE_editmesh_from_object(ob) : NULL;
1713         unsigned char (*wtcol_v)[4];
1714         int numVerts = dm->getNumVerts(dm);
1715         int i;
1716
1717         if (em) {
1718                 BKE_editmesh_color_ensure(em, BM_VERT);
1719                 wtcol_v = em->derivedVertColor;
1720         }
1721         else {
1722                 wtcol_v = MEM_malloc_arrayN(numVerts, sizeof(*wtcol_v), __func__);
1723         }
1724
1725         /* Weights are given by caller. */
1726         if (weights) {
1727                 float *w = weights;
1728                 /* If indices is not NULL, it means we do not have weights for all vertices,
1729                  * so we must create them (and set them to zero)... */
1730                 if (indices) {
1731                         w = MEM_calloc_arrayN(numVerts, sizeof(float), "Temp weight array DM_update_weight_mcol");
1732                         i = num;
1733                         while (i--)
1734                                 w[indices[i]] = weights[i];
1735                 }
1736
1737                 /* Convert float weights to colors. */
1738                 calc_colors_from_weights_array(numVerts, w, wtcol_v);
1739
1740                 if (indices)
1741                         MEM_freeN(w);
1742         }
1743         else {
1744                 /* No weights given, take them from active vgroup(s). */
1745                 calc_weightpaint_vert_array(ob, dm, draw_flag, &G_dm_wcinfo, wtcol_v);
1746         }
1747
1748         if (dm->type == DM_TYPE_EDITBMESH) {
1749                 /* editmesh draw function checks specifically for this */
1750         }
1751         else {
1752                 const int dm_totpoly = dm->getNumPolys(dm);
1753                 const int dm_totloop = dm->getNumLoops(dm);
1754                 unsigned char(*wtcol_l)[4] = CustomData_get_layer(dm->getLoopDataLayout(dm), CD_PREVIEW_MLOOPCOL);
1755                 MLoop *mloop = dm->getLoopArray(dm), *ml;
1756                 MPoly *mp = dm->getPolyArray(dm);
1757                 int l_index;
1758                 int j;
1759
1760                 /* now add to loops, so the data can be passed through the modifier stack
1761                  * If no CD_PREVIEW_MLOOPCOL existed yet, we have to add a new one! */
1762                 if (!wtcol_l) {
1763                         wtcol_l = MEM_malloc_arrayN(dm_totloop, sizeof(*wtcol_l), __func__);
1764                         CustomData_add_layer(&dm->loopData, CD_PREVIEW_MLOOPCOL, CD_ASSIGN, wtcol_l, dm_totloop);
1765                 }
1766
1767                 l_index = 0;
1768                 for (i = 0; i < dm_totpoly; i++, mp++) {
1769                         ml = mloop + mp->loopstart;
1770
1771                         for (j = 0; j < mp->totloop; j++, ml++, l_index++) {
1772                                 copy_v4_v4_uchar(&wtcol_l[l_index][0],
1773                                                  &wtcol_v[ml->v][0]);
1774                         }
1775                 }
1776                 MEM_freeN(wtcol_v);
1777
1778                 dm->dirty |= DM_DIRTY_TESS_CDLAYERS;
1779         }
1780 }
1781
1782 void mesh_update_weight_mcol(
1783         Object *ob, Mesh *mesh, int const draw_flag,
1784         float *weights, int num, const int *indices)
1785 {
1786         BMEditMesh *em = BKE_editmesh_from_object(ob);
1787         unsigned char (*wtcol_v)[4];
1788         int numVerts = mesh->totvert;
1789         int i;
1790
1791         if (em) {
1792                 BKE_editmesh_color_ensure(em, BM_VERT);
1793                 wtcol_v = em->derivedVertColor;
1794         }
1795         else {
1796                 wtcol_v = MEM_malloc_arrayN(numVerts, sizeof(*wtcol_v), __func__);
1797         }
1798
1799         /* Weights are given by caller. */
1800         if (weights) {
1801                 float *w = weights;
1802                 /* If indices is not NULL, it means we do not have weights for all vertices,
1803                  * so we must create them (and set them to zero)... */
1804                 if (indices) {
1805                         w = MEM_calloc_arrayN(numVerts, sizeof(float), "Temp weight array DM_update_weight_mcol");
1806                         i = num;
1807                         while (i--)
1808                                 w[indices[i]] = weights[i];
1809                 }
1810
1811                 /* Convert float weights to colors. */
1812                 calc_colors_from_weights_array(numVerts, w, wtcol_v);
1813
1814                 if (indices)
1815                         MEM_freeN(w);
1816         }
1817         else {
1818                 /* No weights given, take them from active vgroup(s). */
1819                 calc_weightpaint_vert_array_mesh(ob, mesh, draw_flag, &G_dm_wcinfo, wtcol_v);
1820         }
1821
1822         if (em) {
1823                 /* editmesh draw function checks specifically for this */
1824         }
1825         else {
1826                 const int totpoly = mesh->totpoly;
1827                 const int totloop = mesh->totloop;
1828                 unsigned char(*wtcol_l)[4] = CustomData_get_layer(&mesh->ldata, CD_PREVIEW_MLOOPCOL);
1829                 MLoop *mloop = mesh->mloop, *ml;
1830                 MPoly *mp = mesh->mpoly;
1831                 int l_index;
1832                 int j;
1833
1834                 /* now add to loops, so the data can be passed through the modifier stack
1835                  * If no CD_PREVIEW_MLOOPCOL existed yet, we have to add a new one! */
1836                 if (!wtcol_l) {
1837                         wtcol_l = MEM_malloc_arrayN(totloop, sizeof(*wtcol_l), __func__);
1838                         CustomData_add_layer(&mesh->ldata, CD_PREVIEW_MLOOPCOL, CD_ASSIGN, wtcol_l, totloop);
1839                 }
1840
1841                 l_index = 0;
1842                 for (i = 0; i < totpoly; i++, mp++) {
1843                         ml = mloop + mp->loopstart;
1844
1845                         for (j = 0; j < mp->totloop; j++, ml++, l_index++) {
1846                                 copy_v4_v4_uchar(&wtcol_l[l_index][0],
1847                                                  &wtcol_v[ml->v][0]);
1848                         }
1849                 }
1850                 MEM_freeN(wtcol_v);
1851
1852                 //dm->dirty |= DM_DIRTY_TESS_CDLAYERS; // XXX: Does Mesh need this?
1853         }
1854 }
1855
1856 static void DM_update_statvis_color(const Scene *scene, Object *ob, DerivedMesh *dm)
1857 {
1858         BMEditMesh *em = BKE_editmesh_from_object(ob);
1859
1860         BKE_editmesh_statvis_calc(em, dm, &scene->toolsettings->statvis);
1861 }
1862
1863 static void shapekey_layers_to_keyblocks(DerivedMesh *dm, Mesh *me, int actshape_uid)
1864 {
1865         KeyBlock *kb;
1866         int i, j, tot;
1867         
1868         if (!me->key)
1869                 return;
1870         
1871         tot = CustomData_number_of_layers(&dm->vertData, CD_SHAPEKEY);
1872         for (i = 0; i < tot; i++) {
1873                 CustomDataLayer *layer = &dm->vertData.layers[CustomData_get_layer_index_n(&dm->vertData, CD_SHAPEKEY, i)];
1874                 float (*cos)[3], (*kbcos)[3];
1875                 
1876                 for (kb = me->key->block.first; kb; kb = kb->next) {
1877                         if (kb->uid == layer->uid)
1878                                 break;
1879                 }
1880                 
1881                 if (!kb) {
1882                         kb = BKE_keyblock_add(me->key, layer->name);
1883                         kb->uid = layer->uid;
1884                 }
1885                 
1886                 if (kb->data)
1887                         MEM_freeN(kb->data);
1888                 
1889                 cos = CustomData_get_layer_n(&dm->vertData, CD_SHAPEKEY, i);
1890                 kb->totelem = dm->numVertData;
1891
1892                 kb->data = kbcos = MEM_malloc_arrayN(kb->totelem, 3 * sizeof(float), "kbcos DerivedMesh.c");
1893                 if (kb->uid == actshape_uid) {
1894                         MVert *mvert = dm->getVertArray(dm);
1895                         
1896                         for (j = 0; j < dm->numVertData; j++, kbcos++, mvert++) {
1897                                 copy_v3_v3(*kbcos, mvert->co);
1898                         }
1899                 }
1900                 else {
1901                         for (j = 0; j < kb->totelem; j++, cos++, kbcos++) {
1902                                 copy_v3_v3(*kbcos, *cos);
1903                         }
1904                 }
1905         }
1906         
1907         for (kb = me->key->block.first; kb; kb = kb->next) {
1908                 if (kb->totelem != dm->numVertData) {
1909                         if (kb->data)
1910                                 MEM_freeN(kb->data);
1911                         
1912                         kb->totelem = dm->numVertData;
1913                         kb->data = MEM_calloc_arrayN(kb->totelem, 3 * sizeof(float), "kb->data derivedmesh.c");
1914                         fprintf(stderr, "%s: lost a shapekey layer: '%s'! (bmesh internal error)\n", __func__, kb->name);
1915                 }
1916         }
1917 }
1918
1919 static void add_shapekey_layers(DerivedMesh *dm, Mesh *me, Object *UNUSED(ob))
1920 {
1921         KeyBlock *kb;
1922         Key *key = me->key;
1923         int i;
1924
1925         if (!me->key)
1926                 return;
1927
1928         /* ensure we can use mesh vertex count for derived mesh custom data */
1929         if (me->totvert != dm->getNumVerts(dm)) {
1930                 fprintf(stderr,
1931                         "%s: vertex size mismatch (mesh/dm) '%s' (%d != %d)\n",
1932                         __func__, me->id.name + 2, me->totvert, dm->getNumVerts(dm));
1933                 return;
1934         }
1935
1936         for (i = 0, kb = key->block.first; kb; kb = kb->next, i++) {
1937                 int ci;
1938                 float *array;
1939
1940                 if (me->totvert != kb->totelem) {
1941                         fprintf(stderr,
1942                                 "%s: vertex size mismatch (Mesh '%s':%d != KeyBlock '%s':%d)\n",
1943                                 __func__, me->id.name + 2, me->totvert, kb->name, kb->totelem);
1944                         array = MEM_calloc_arrayN((size_t)me->totvert, 3 * sizeof(float), __func__);
1945                 }
1946                 else {
1947                         array = MEM_malloc_arrayN((size_t)me->totvert, 3 * sizeof(float), __func__);
1948                         memcpy(array, kb->data, (size_t)me->totvert * 3 * sizeof(float));
1949                 }
1950
1951                 CustomData_add_layer_named(&dm->vertData, CD_SHAPEKEY, CD_ASSIGN, array, dm->numVertData, kb->name);
1952                 ci = CustomData_get_layer_index_n(&dm->vertData, CD_SHAPEKEY, i);
1953
1954                 dm->vertData.layers[ci].uid = kb->uid;
1955         }
1956 }
1957
1958 /**
1959  * Called after calculating all modifiers.
1960  *
1961  * \note tessfaces should already be calculated.
1962  */
1963 static void dm_ensure_display_normals(DerivedMesh *dm)
1964 {
1965         /* Note: dm *may* have a poly CD_NORMAL layer (generated by a modifier needing poly normals e.g.).
1966          *       We do not use it here, though. And it should be tagged as temp!
1967          */
1968         /* BLI_assert((CustomData_has_layer(&dm->polyData, CD_NORMAL) == false)); */
1969
1970         if ((dm->type == DM_TYPE_CDDM) &&
1971             ((dm->dirty & DM_DIRTY_NORMALS) || CustomData_has_layer(&dm->polyData, CD_NORMAL) == false))
1972         {
1973                 /* if normals are dirty we want to calculate vertex normals too */
1974                 CDDM_calc_normals_mapping_ex(dm, (dm->dirty & DM_DIRTY_NORMALS) ? false : true);
1975         }
1976 }
1977
1978 static void mesh_ensure_display_normals(Mesh *mesh)
1979 {
1980         /* Note: mesh *may* have a poly CD_NORMAL layer (generated by a modifier needing poly normals e.g.).
1981          *       We do not use it here, though. And it should be tagged as temp!
1982          */
1983         /* BLI_assert((CustomData_has_layer(&mesh->pdata, CD_NORMAL) == false)); */
1984
1985         if(mesh->runtime.cd_dirty_vert & CD_MASK_NORMAL || !CustomData_has_layer(&mesh->pdata, CD_NORMAL)) {
1986                 float (*face_nors)[3] = NULL;
1987                 face_nors = MEM_malloc_arrayN(mesh->totpoly, sizeof(*face_nors), "face_nors");
1988
1989                 /* if normals are dirty we want to calculate vertex normals too */
1990                 bool only_face_normals = !(mesh->runtime.cd_dirty_vert & CD_MASK_NORMAL);
1991
1992                 /* calculate face normals */
1993                 BKE_mesh_calc_normals_poly(
1994                                 mesh->mvert, NULL, mesh->totvert, mesh->mloop, mesh->mpoly,
1995                                 mesh->totloop, mesh->totpoly, face_nors,
1996                                 only_face_normals);
1997
1998                 CustomData_add_layer(&mesh->pdata, CD_NORMAL, CD_ASSIGN, face_nors, mesh->totpoly);
1999
2000                 mesh->runtime.cd_dirty_vert &= ~CD_MASK_NORMAL;
2001         }
2002 }
2003
2004 static void mesh_calc_modifiers(
2005         struct Depsgraph *depsgraph, Scene *scene, Object *ob, float (*inputVertexCos)[3],
2006         const bool useRenderParams, int useDeform,
2007         const bool need_mapping, CustomDataMask dataMask,
2008         const int index, const bool useCache, const bool build_shapekey_layers,
2009         const bool allow_gpu,
2010         /* return args */
2011         Mesh **r_deform_mesh, Mesh **r_final_mesh)
2012 {
2013         Mesh *me = ob->data;
2014         /* Always get the vertex coordinates from the original mesh. Otherwise
2015          * there is the risk of deforming already-deformed coordinates. */
2016         Mesh *mesh_orig_id = (Mesh *)DEG_get_original_id(&me->id);
2017         ModifierData *firstmd, *md, *previewmd = NULL;
2018         CDMaskLink *datamasks, *curr;
2019         /* XXX Always copying POLYINDEX, else tessellated data are no more valid! */
2020         CustomDataMask mask, nextmask, previewmask = 0, append_mask = CD_MASK_ORIGINDEX;
2021         float (*deformedVerts)[3] = NULL;
2022         int numVerts = me->totvert;
2023         const int required_mode = useRenderParams ? eModifierMode_Render : eModifierMode_Realtime;
2024         bool isPrevDeform = false;
2025         MultiresModifierData *mmd = get_multires_modifier(scene, ob, 0);
2026         const bool has_multires = (mmd && mmd->sculptlvl != 0);
2027         bool multires_applied = false;
2028         const bool sculpt_mode = ob->mode & OB_MODE_SCULPT && ob->sculpt && !useRenderParams;
2029         const bool sculpt_dyntopo = (sculpt_mode && ob->sculpt->bm)  && !useRenderParams;
2030         const int draw_flag = dm_drawflag_calc(scene->toolsettings, me);
2031
2032         /* Generic preview only in object mode! */
2033         const bool do_mod_mcol = (ob->mode == OB_MODE_OBJECT);
2034 #if 0 /* XXX Will re-enable this when we have global mod stack options. */
2035         const bool do_final_wmcol = (scene->toolsettings->weights_preview == WP_WPREVIEW_FINAL) && do_wmcol;
2036 #endif
2037         const bool do_final_wmcol = false;
2038         const bool do_init_wmcol = ((dataMask & CD_MASK_PREVIEW_MLOOPCOL) && (ob->mode & OB_MODE_WEIGHT_PAINT) && !do_final_wmcol);
2039         /* XXX Same as above... For now, only weights preview in WPaint mode. */
2040         const bool do_mod_wmcol = do_init_wmcol;
2041
2042         const bool do_loop_normals = (me->flag & ME_AUTOSMOOTH) != 0;
2043
2044         VirtualModifierData virtualModifierData;
2045
2046         ModifierApplyFlag app_flags = useRenderParams ? MOD_APPLY_RENDER : 0;
2047         ModifierApplyFlag deform_app_flags = app_flags;
2048
2049
2050         if (useCache)
2051                 app_flags |= MOD_APPLY_USECACHE;
2052         if (allow_gpu)
2053                 app_flags |= MOD_APPLY_ALLOW_GPU;
2054         if (useDeform)
2055                 deform_app_flags |= MOD_APPLY_USECACHE;
2056
2057         /* TODO(sybren): do we really need three context objects? Or do we modify
2058          * them on the fly to change the flags where needed? */
2059         const ModifierEvalContext mectx_deform = {depsgraph, ob, deform_app_flags};
2060         const ModifierEvalContext mectx_apply = {depsgraph, ob, app_flags};
2061         const ModifierEvalContext mectx_orco = {depsgraph, ob, (app_flags & ~MOD_APPLY_USECACHE) | MOD_APPLY_ORCO};
2062
2063         md = firstmd = modifiers_getVirtualModifierList(ob, &virtualModifierData);
2064
2065         modifiers_clearErrors(ob);
2066
2067         if (do_mod_wmcol || do_mod_mcol) {
2068                 /* Find the last active modifier generating a preview, or NULL if none. */
2069                 /* XXX Currently, DPaint modifier just ignores this.
2070                  *     Needs a stupid hack...
2071                  *     The whole "modifier preview" thing has to be (re?)designed, anyway! */
2072                 previewmd = modifiers_getLastPreview(scene, md, required_mode);
2073
2074                 /* even if the modifier doesn't need the data, to make a preview it may */
2075                 if (previewmd) {
2076                         if (do_mod_wmcol) {
2077                                 previewmask = CD_MASK_MDEFORMVERT;
2078                         }
2079                 }
2080         }
2081
2082         datamasks = modifiers_calcDataMasks(scene, ob, md, dataMask, required_mode, previewmd, previewmask);
2083         curr = datamasks;
2084
2085         if (r_deform_mesh) {
2086                 *r_deform_mesh = NULL;
2087         }
2088         *r_final_mesh = NULL;
2089
2090         if (useDeform) {
2091                 if (inputVertexCos)
2092                         deformedVerts = inputVertexCos;
2093                 
2094                 /* Apply all leading deforming modifiers */
2095                 for (; md; md = md->next, curr = curr->next) {
2096                         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
2097
2098                         md->scene = scene;
2099                         
2100                         if (!modifier_isEnabled(scene, md, required_mode)) {
2101                                 continue;
2102                         }
2103
2104                         if (useDeform < 0 && mti->dependsOnTime && mti->dependsOnTime(md)) {
2105                                 continue;
2106                         }
2107
2108                         if (mti->type == eModifierTypeType_OnlyDeform && !sculpt_dyntopo) {
2109                                 if (!deformedVerts)
2110                                         deformedVerts = BKE_mesh_vertexCos_get(mesh_orig_id, &numVerts);
2111
2112                                 modifier_deformVerts_ensure_normals(md, &mectx_deform, NULL, deformedVerts, numVerts);
2113                         }
2114                         else {
2115                                 break;
2116                         }
2117                         
2118                         /* grab modifiers until index i */
2119                         if ((index != -1) && (BLI_findindex(&ob->modifiers, md) >= index))
2120                                 break;
2121                 }
2122
2123                 /* Result of all leading deforming modifiers is cached for
2124                  * places that wish to use the original mesh but with deformed
2125                  * coordinates (vpaint, etc.)
2126                  */
2127                 if (r_deform_mesh) {
2128                         BKE_id_copy_ex(NULL, &me->id, (ID**)r_deform_mesh,
2129                                 LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_USER_REFCOUNT | LIB_ID_CREATE_NO_DEG_TAG, false);
2130
2131                         /* XXX: Is build_shapekey_layers ever even true? This should have crashed long ago... */
2132                         BLI_assert(!build_shapekey_layers);
2133                         //if (build_shapekey_layers)
2134                         //      add_shapekey_layers(*r_deform_mesh, me, ob);
2135                         
2136                         if (deformedVerts) {
2137                                 BKE_mesh_apply_vert_coords(*r_deform_mesh, deformedVerts);
2138                         }
2139                 }
2140         }
2141         else {
2142                 /* default behavior for meshes */
2143                 if (inputVertexCos)
2144                         deformedVerts = inputVertexCos;
2145                 else
2146                         deformedVerts = BKE_mesh_vertexCos_get(mesh_orig_id, &numVerts);
2147         }
2148
2149
2150         /* Now apply all remaining modifiers. If useDeform is off then skip
2151          * OnlyDeform ones. 
2152          */
2153         Mesh *mesh = NULL;
2154         Mesh *orco_mesh = NULL;
2155         Mesh *cloth_orco_mesh = NULL;
2156
2157         for (; md; md = md->next, curr = curr->next) {
2158                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
2159
2160                 md->scene = scene;
2161
2162                 if (!modifier_isEnabled(scene, md, required_mode)) {
2163                         continue;
2164                 }
2165
2166                 if (mti->type == eModifierTypeType_OnlyDeform && !useDeform) {
2167                         continue;
2168                 }
2169
2170                 if ((mti->flags & eModifierTypeFlag_RequiresOriginalData) && mesh) {
2171                         modifier_setError(md, "Modifier requires original data, bad stack position");
2172                         continue;
2173                 }
2174
2175                 if (sculpt_mode &&
2176                     (!has_multires || multires_applied || sculpt_dyntopo))
2177                 {
2178                         bool unsupported = false;
2179
2180                         if (md->type == eModifierType_Multires && ((MultiresModifierData *)md)->sculptlvl == 0) {
2181                                 /* If multires is on level 0 skip it silently without warning message. */
2182                                 if (!sculpt_dyntopo) {
2183                                         continue;
2184                                 }
2185                         }
2186
2187                         if (sculpt_dyntopo && !useRenderParams)
2188                                 unsupported = true;
2189
2190                         if (scene->toolsettings->sculpt->flags & SCULPT_ONLY_DEFORM)
2191                                 unsupported |= (mti->type != eModifierTypeType_OnlyDeform);
2192
2193                         unsupported |= multires_applied;
2194
2195                         if (unsupported) {
2196                                 if (sculpt_dyntopo)
2197                                         modifier_setError(md, "Not supported in dyntopo");
2198                                 else
2199                                         modifier_setError(md, "Not supported in sculpt mode");
2200                                 continue;
2201                         }
2202                         else {
2203                                 modifier_setError(md, "Hide, Mask and optimized display disabled");
2204                         }
2205                 }
2206
2207                 if (need_mapping && !modifier_supportsMapping(md)) {
2208                         continue;
2209                 }
2210
2211                 if (useDeform < 0 && mti->dependsOnTime && mti->dependsOnTime(md)) {
2212                         continue;
2213                 }
2214
2215                 /* add an orco layer if needed by this modifier */
2216                 if (mti->requiredDataMask)
2217                         mask = mti->requiredDataMask(ob, md);
2218                 else
2219                         mask = 0;
2220
2221                 if (mesh && (mask & CD_MASK_ORCO)) {
2222                         add_orco_mesh(ob, NULL, mesh, orco_mesh, CD_ORCO);
2223                 }
2224
2225                 /* How to apply modifier depends on (a) what we already have as
2226                  * a result of previous modifiers (could be a Mesh or just
2227                  * deformed vertices) and (b) what type the modifier is.
2228                  */
2229
2230                 if (mti->type == eModifierTypeType_OnlyDeform) {
2231                         /* No existing verts to deform, need to build them. */
2232                         if (!deformedVerts) {
2233                                 if (mesh) {
2234                                         /* Deforming a mesh, read the vertex locations
2235                                          * out of the mesh and deform them. Once done with this
2236                                          * run of deformers verts will be written back.
2237                                          */
2238                                         deformedVerts = BKE_mesh_vertexCos_get(mesh, &numVerts);
2239                                 }
2240                                 else {
2241                                         deformedVerts = BKE_mesh_vertexCos_get(mesh_orig_id, &numVerts);
2242                                 }
2243                         }
2244
2245                         /* if this is not the last modifier in the stack then recalculate the normals
2246                          * to avoid giving bogus normals to the next modifier see: [#23673] */
2247                         if (isPrevDeform && mti->dependsOnNormals && mti->dependsOnNormals(md)) {
2248                                 /* XXX, this covers bug #23673, but we may need normal calc for other types */
2249                                 if (mesh) {
2250                                         BKE_mesh_apply_vert_coords(mesh, deformedVerts);
2251                                 }
2252                         }
2253
2254                         modifier_deformVerts_ensure_normals(md, &mectx_deform, mesh, deformedVerts, numVerts);
2255                 }
2256                 else {
2257                         /* determine which data layers are needed by following modifiers */
2258                         if (curr->next)
2259                                 nextmask = curr->next->mask;
2260                         else
2261                                 nextmask = dataMask;
2262
2263                         /* apply vertex coordinates or build a Mesh as necessary */
2264                         if (mesh) {
2265                                 if (deformedVerts) {
2266                                         BKE_mesh_apply_vert_coords(mesh, deformedVerts);
2267                                 }
2268                         }
2269                         else {
2270                                 BKE_id_copy_ex(NULL, &me->id, (ID**)&mesh,
2271                                         LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_USER_REFCOUNT | LIB_ID_CREATE_NO_DEG_TAG, false);
2272                                 ASSERT_IS_VALID_MESH(mesh);
2273
2274                                 // XXX: port to Mesh if build_shapekey_layers can ever be true
2275                                 //if (build_shapekey_layers)
2276                                 //      add_shapekey_layers(mesh, me, ob);
2277
2278                                 if (deformedVerts) {
2279                                         BKE_mesh_apply_vert_coords(mesh, deformedVerts);
2280                                 }
2281
2282                                 if (do_init_wmcol)
2283                                         mesh_update_weight_mcol(ob, mesh, draw_flag, NULL, 0, NULL);
2284
2285                                 /* Constructive modifiers need to have an origindex
2286                                  * otherwise they wont have anywhere to copy the data from.
2287                                  *
2288                                  * Also create ORIGINDEX data if any of the following modifiers
2289                                  * requests it, this way Mirror, Solidify etc will keep ORIGINDEX
2290                                  * data by using generic DM_copy_vert_data() functions.
2291                                  */
2292                                 if (need_mapping || (nextmask & CD_MASK_ORIGINDEX)) {
2293                                         /* calc */
2294                                         CustomData_add_layer(&mesh->vdata, CD_ORIGINDEX, CD_CALLOC, NULL, mesh->totvert);
2295                                         CustomData_add_layer(&mesh->edata, CD_ORIGINDEX, CD_CALLOC, NULL, mesh->totedge);
2296                                         CustomData_add_layer(&mesh->pdata, CD_ORIGINDEX, CD_CALLOC, NULL, mesh->totpoly);
2297
2298                                         /* Not worth parallelizing this, gives less than 0.1% overall speedup in best of best cases... */
2299                                         range_vn_i(CustomData_get_layer(&mesh->vdata, CD_ORIGINDEX), mesh->totvert, 0);
2300                                         range_vn_i(CustomData_get_layer(&mesh->edata, CD_ORIGINDEX), mesh->totedge, 0);
2301                                         range_vn_i(CustomData_get_layer(&mesh->pdata, CD_ORIGINDEX), mesh->totpoly, 0);
2302                                 }
2303                         }
2304
2305                         
2306                         /* set the Mesh to only copy needed data */
2307                         mask = curr->mask;
2308                         /* needMapping check here fixes bug [#28112], otherwise it's
2309                          * possible that it won't be copied */
2310                         mask |= append_mask;
2311                         mesh_set_only_copy(mesh, mask | (need_mapping ? CD_MASK_ORIGINDEX : 0));
2312
2313                         /* add cloth rest shape key if needed */
2314                         if (mask & CD_MASK_CLOTH_ORCO)
2315                                 add_orco_mesh(ob, NULL, mesh, orco_mesh, CD_CLOTH_ORCO);
2316
2317                         /* add an origspace layer if needed */
2318                         if ((curr->mask) & CD_MASK_ORIGSPACE_MLOOP) {
2319                                 if (!CustomData_has_layer(&mesh->ldata, CD_ORIGSPACE_MLOOP)) {
2320                                         CustomData_add_layer(&mesh->ldata, CD_ORIGSPACE_MLOOP, CD_CALLOC, NULL, mesh->totloop);
2321                                         mesh_init_origspace(mesh);
2322                                 }
2323                         }
2324
2325                         Mesh *new_mesh = modifier_applyModifier_ensure_normals(md, &mectx_apply, mesh);
2326                         ASSERT_IS_VALID_MESH(new_mesh);
2327
2328                         if (new_mesh) {
2329                                 /* if the modifier returned a new mesh, release the old one */
2330                                 if (mesh && mesh != new_mesh) {
2331                                         BKE_mesh_free(mesh);
2332                                         MEM_freeN(mesh);
2333                                 }
2334
2335                                 mesh = new_mesh;
2336
2337                                 if (deformedVerts) {
2338                                         if (deformedVerts != inputVertexCos)
2339                                                 MEM_freeN(deformedVerts);
2340
2341                                         deformedVerts = NULL;
2342                                 }
2343                         }
2344
2345                         /* create an orco mesh in parallel */
2346                         if (nextmask & CD_MASK_ORCO) {
2347                                 if (!orco_mesh) {
2348                                         orco_mesh = create_orco_mesh(ob, me, NULL, CD_ORCO);
2349                                 }
2350
2351                                 nextmask &= ~CD_MASK_ORCO;
2352                                 mesh_set_only_copy(orco_mesh, nextmask | CD_MASK_ORIGINDEX |
2353                                                  (mti->requiredDataMask ?
2354                                                   mti->requiredDataMask(ob, md) : 0));
2355
2356                                 new_mesh = modifier_applyModifier_ensure_normals(md, &mectx_orco, orco_mesh);
2357                                 ASSERT_IS_VALID_MESH(new_mesh);
2358
2359                                 if (new_mesh) {
2360                                         /* if the modifier returned a new mesh, release the old one */
2361                                         if (orco_mesh && orco_mesh != new_mesh) {
2362                                                 BKE_id_free(NULL, orco_mesh);
2363                                         }
2364
2365                                         orco_mesh = new_mesh;
2366                                 }
2367                         }
2368
2369                         /* create cloth orco mesh in parallel */
2370                         if (nextmask & CD_MASK_CLOTH_ORCO) {
2371                                 if (!cloth_orco_mesh)
2372                                         cloth_orco_mesh = create_orco_mesh(ob, me, NULL, CD_CLOTH_ORCO);
2373
2374                                 nextmask &= ~CD_MASK_CLOTH_ORCO;
2375                                 mesh_set_only_copy(cloth_orco_mesh, nextmask | CD_MASK_ORIGINDEX);
2376
2377                                 new_mesh = modifier_applyModifier_ensure_normals(md, &mectx_orco, cloth_orco_mesh);
2378                                 ASSERT_IS_VALID_DM(new_mesh);
2379
2380                                 if (new_mesh) {
2381                                         /* if the modifier returned a new mesh, release the old one */
2382                                         if (cloth_orco_mesh && cloth_orco_mesh != new_mesh) {
2383                                                 BKE_id_free(NULL, cloth_orco_mesh);
2384                                         }
2385
2386                                         cloth_orco_mesh = new_mesh;
2387                                 }
2388                         }
2389
2390                         /* in case of dynamic paint, make sure preview mask remains for following modifiers */
2391                         /* XXX Temp and hackish solution! */
2392                         if (md->type == eModifierType_DynamicPaint)
2393                                 append_mask |= CD_MASK_PREVIEW_MLOOPCOL;
2394                         /* In case of active preview modifier, make sure preview mask remains for following modifiers. */
2395                         else if ((md == previewmd) && (do_mod_wmcol)) {
2396                                 mesh_update_weight_mcol(ob, mesh, draw_flag, NULL, 0, NULL);
2397                                 append_mask |= CD_MASK_PREVIEW_MLOOPCOL;
2398                         }
2399
2400                         // dm->deformedOnly = false; // XXX: Does Mesh need this? Looks to be used only by particle system
2401                 }
2402
2403                 isPrevDeform = (mti->type == eModifierTypeType_OnlyDeform);
2404
2405                 /* grab modifiers until index i */
2406                 if ((index != -1) && (BLI_findindex(&ob->modifiers, md) >= index))
2407                         break;
2408
2409                 if (sculpt_mode && md->type == eModifierType_Multires) {
2410                         multires_applied = true;
2411                 }
2412         }
2413
2414         for (md = firstmd; md; md = md->next)
2415                 modifier_freeTemporaryData(md);
2416
2417         /* Yay, we are done. If we have a Mesh and deformed vertices
2418          * need to apply these back onto the Mesh. If we have no
2419          * Mesh then we need to build one.
2420          */
2421         Mesh *final_mesh;
2422
2423         if (mesh) {
2424                 final_mesh = mesh;
2425
2426                 if (deformedVerts) {
2427                         BKE_mesh_apply_vert_coords(final_mesh, deformedVerts);
2428                 }
2429
2430 #if 0 /* For later nice mod preview! */
2431                 /* In case we need modified weights in CD_PREVIEW_MCOL, we have to re-compute it. */
2432                 if (do_final_wmcol)
2433                         mesh_update_weight_mcol(ob, final_mesh, draw_flag, NULL, 0, NULL);
2434 #endif
2435         }
2436         else {
2437                 BKE_id_copy_ex(NULL, &me->id, (ID**)&final_mesh,
2438                         LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_USER_REFCOUNT | LIB_ID_CREATE_NO_DEG_TAG, false);
2439
2440                 //if (build_shapekey_layers) {
2441                 //      add_shapekey_layers(final_mesh, me, ob);
2442                 //}
2443
2444                 if (deformedVerts) {
2445                         BKE_mesh_apply_vert_coords(final_mesh, deformedVerts);
2446                 }
2447
2448                 /* In this case, we should never have weight-modifying modifiers in stack... */
2449                 if (do_init_wmcol)
2450                         mesh_update_weight_mcol(ob, final_mesh, draw_flag, NULL, 0, NULL);
2451         }
2452
2453         /* add an orco layer if needed */
2454         if (dataMask & CD_MASK_ORCO) {
2455                 add_orco_mesh(ob, NULL, final_mesh, orco_mesh, CD_ORCO);
2456
2457                 if (r_deform_mesh && *r_deform_mesh)
2458                         add_orco_mesh(ob, NULL, *r_deform_mesh, NULL, CD_ORCO);
2459         }
2460
2461         if (do_loop_normals) {
2462                 /* Compute loop normals (note: will compute poly and vert normals as well, if needed!) */
2463                 BKE_mesh_calc_normals_split(final_mesh);
2464                 // dm->dirty |= DM_DIRTY_TESS_CDLAYERS; XXX
2465         }
2466
2467         if (sculpt_dyntopo == false) {
2468                 /* watch this! after 2.75a we move to from tessface to looptri (by default) */
2469                 if (dataMask & CD_MASK_MFACE) {
2470                         // DM_ensure_tessface(final_mesh); // XXX: port?
2471                 }
2472
2473                 /* without this, drawing ngon tri's faces will show ugly tessellated face
2474                  * normals and will also have to calculate normals on the fly, try avoid
2475                  * this where possible since calculating polygon normals isn't fast,
2476                  * note that this isn't a problem for subsurf (only quads) or editmode
2477                  * which deals with drawing differently.
2478                  *
2479                  * Only calc vertex normals if they are flagged as dirty.
2480                  * If using loop normals, poly nors have already been computed.
2481                  */
2482                 if (!do_loop_normals) {
2483                         mesh_ensure_display_normals(final_mesh);
2484                 }
2485         }
2486
2487         /* Some modifiers, like datatransfer, may generate those data as temp layer, we do not want to keep them,
2488          * as they are used by display code when available (i.e. even if autosmooth is disabled). */
2489         if (!do_loop_normals && CustomData_has_layer(&final_mesh->ldata, CD_NORMAL)) {
2490                 CustomData_free_layers(&final_mesh->ldata, CD_NORMAL, final_mesh->totloop);
2491         }
2492
2493         *r_final_mesh = final_mesh;
2494
2495         if (orco_mesh) {
2496                 BKE_id_free(NULL, orco_mesh);
2497         }
2498         if (cloth_orco_mesh) {
2499                 BKE_id_free(NULL, cloth_orco_mesh);
2500         }
2501
2502         if (deformedVerts && deformedVerts != inputVertexCos)
2503                 MEM_freeN(deformedVerts);
2504
2505         BLI_linklist_free((LinkNode *)datamasks, NULL);
2506 }
2507
2508 static void mesh_calc_modifiers_dm(
2509         struct Depsgraph *depsgraph, Scene *scene, Object *ob, float (*inputVertexCos)[3],
2510         const bool useRenderParams, int useDeform,
2511         const bool need_mapping, CustomDataMask dataMask,
2512         const int index, const bool useCache, const bool build_shapekey_layers,
2513         const bool allow_gpu,
2514         /* return args */
2515         DerivedMesh **r_deformdm, DerivedMesh **r_finaldm)
2516 {
2517         Mesh *deform_mesh = NULL, *final_mesh = NULL;
2518
2519         mesh_calc_modifiers(depsgraph, scene, ob, inputVertexCos, useRenderParams, useDeform,
2520                         need_mapping, dataMask, index, useCache, build_shapekey_layers, allow_gpu,
2521                         (r_deformdm ? &deform_mesh : NULL), &final_mesh);
2522
2523         if(deform_mesh) {
2524                 *r_deformdm = CDDM_from_mesh_ex(deform_mesh, CD_DUPLICATE);
2525                 BKE_id_free(NULL, deform_mesh);
2526         }
2527
2528         *r_finaldm = CDDM_from_mesh_ex(final_mesh, CD_DUPLICATE);
2529         BKE_id_free(NULL, final_mesh);
2530 }
2531
2532 float (*editbmesh_get_vertex_cos(BMEditMesh *em, int *r_numVerts))[3]
2533 {
2534         BMIter iter;
2535         BMVert *eve;
2536         float (*cos)[3];
2537         int i;
2538
2539         *r_numVerts = em->bm->totvert;
2540
2541         cos = MEM_malloc_arrayN(em->bm->totvert, 3 * sizeof(float), "vertexcos");
2542
2543         BM_ITER_MESH_INDEX (eve, &iter, em->bm, BM_VERTS_OF_MESH, i) {
2544                 copy_v3_v3(cos[i], eve->co);
2545         }
2546
2547         return cos;
2548 }
2549
2550 bool editbmesh_modifier_is_enabled(Scene *scene, ModifierData *md, DerivedMesh *dm)
2551 {
2552         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
2553         const int required_mode = eModifierMode_Realtime | eModifierMode_Editmode;
2554
2555         if (!modifier_isEnabled(scene, md, required_mode)) {
2556                 return false;
2557         }
2558
2559         if ((mti->flags & eModifierTypeFlag_RequiresOriginalData) && dm) {
2560                 modifier_setError(md, "Modifier requires original data, bad stack position");
2561                 return false;
2562         }
2563         
2564         return true;
2565 }
2566
2567 static void editbmesh_calc_modifiers(
2568         struct Depsgraph *depsgraph, Scene *scene, Object *ob,
2569         BMEditMesh *em, CustomDataMask dataMask,
2570         /* return args */
2571         DerivedMesh **r_cage, DerivedMesh **r_final)
2572 {
2573         ModifierData *md, *previewmd = NULL;
2574         float (*deformedVerts)[3] = NULL;
2575         CustomDataMask mask = 0, previewmask = 0, append_mask = 0;
2576         DerivedMesh *dm = NULL, *orcodm = NULL;
2577         int i, numVerts = 0, cageIndex = modifiers_getCageIndex(scene, ob, NULL, 1);
2578         CDMaskLink *datamasks, *curr;
2579         const int required_mode = eModifierMode_Realtime | eModifierMode_Editmode;
2580         int draw_flag = dm_drawflag_calc(scene->toolsettings, ob->data);
2581
2582         // const bool do_mod_mcol = true; // (ob->mode == OB_MODE_OBJECT);
2583 #if 0 /* XXX Will re-enable this when we have global mod stack options. */
2584         const bool do_final_wmcol = (scene->toolsettings->weights_preview == WP_WPREVIEW_FINAL) && do_wmcol;
2585 #endif
2586         const bool do_final_wmcol = false;
2587         const bool do_init_wmcol = ((((Mesh *)ob->data)->drawflag & ME_DRAWEIGHT) && !do_final_wmcol);
2588
2589         const bool do_init_statvis = ((((Mesh *)ob->data)->drawflag & ME_DRAW_STATVIS) && !do_init_wmcol);
2590         const bool do_mod_wmcol = do_init_wmcol;
2591         VirtualModifierData virtualModifierData;
2592
2593         /* TODO(sybren): do we really need multiple objects, or shall we change the flags where needed? */
2594         const ModifierEvalContext mectx = {depsgraph, ob, 0};
2595         const ModifierEvalContext mectx_orco = {depsgraph, ob, MOD_APPLY_ORCO};
2596         const ModifierEvalContext mectx_cache_gpu = {depsgraph, ob, MOD_APPLY_USECACHE | MOD_APPLY_ALLOW_GPU};
2597
2598         const bool do_loop_normals = (((Mesh *)(ob->data))->flag & ME_AUTOSMOOTH) != 0;
2599         const float loop_normals_split_angle = ((Mesh *)(ob->data))->smoothresh;
2600
2601         modifiers_clearErrors(ob);
2602
2603         if (r_cage && cageIndex == -1) {
2604                 *r_cage = getEditDerivedBMesh(em, ob, dataMask, NULL);
2605         }
2606
2607         md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
2608
2609         /* copied from mesh_calc_modifiers */
2610         if (do_mod_wmcol) {
2611                 previewmd = modifiers_getLastPreview(scene, md, required_mode);
2612                 /* even if the modifier doesn't need the data, to make a preview it may */
2613                 if (previewmd) {
2614                         previewmask = CD_MASK_MDEFORMVERT;
2615                 }
2616         }
2617
2618         datamasks = modifiers_calcDataMasks(scene, ob, md, dataMask, required_mode, previewmd, previewmask);
2619
2620         curr = datamasks;
2621         for (i = 0; md; i++, md = md->next, curr = curr->next) {
2622                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
2623
2624                 md->scene = scene;
2625                 
2626                 if (!editbmesh_modifier_is_enabled(scene, md, dm)) {
2627                         continue;
2628                 }
2629
2630                 /* add an orco layer if needed by this modifier */
2631                 if (dm && mti->requiredDataMask) {
2632                         mask = mti->requiredDataMask(ob, md);
2633                         if (mask & CD_MASK_ORCO)
2634                                 add_orco_dm(ob, em, dm, orcodm, CD_ORCO);
2635                 }
2636
2637                 /* How to apply modifier depends on (a) what we already have as
2638                  * a result of previous modifiers (could be a DerivedMesh or just
2639                  * deformed vertices) and (b) what type the modifier is.
2640                  */
2641
2642                 if (mti->type == eModifierTypeType_OnlyDeform) {
2643                         /* No existing verts to deform, need to build them. */
2644                         if (!deformedVerts) {
2645                                 if (dm) {
2646                                         /* Deforming a derived mesh, read the vertex locations
2647                                          * out of the mesh and deform them. Once done with this
2648                                          * run of deformers verts will be written back.
2649                                          */
2650                                         numVerts = dm->getNumVerts(dm);
2651                                         deformedVerts =
2652                                             MEM_malloc_arrayN(numVerts, sizeof(*deformedVerts), "dfmv");
2653                                         dm->getVertCos(dm, deformedVerts);
2654                                 }
2655                                 else {
2656                                         deformedVerts = editbmesh_get_vertex_cos(em, &numVerts);
2657                                 }
2658                         }
2659
2660                         if (mti->deformVertsEM || mti->deformVertsEM_DM)
2661                                 modwrap_deformVertsEM(md, &mectx, em, dm, deformedVerts, numVerts);
2662                         else
2663                                 modwrap_deformVerts(md, &mectx, dm, deformedVerts, numVerts);
2664                 }
2665                 else {
2666                         DerivedMesh *ndm;
2667
2668                         /* apply vertex coordinates or build a DerivedMesh as necessary */
2669                         if (dm) {
2670                                 if (deformedVerts) {
2671                                         DerivedMesh *tdm = CDDM_copy(dm);
2672                                         if (!(r_cage && dm == *r_cage)) {
2673                                                 dm->release(dm);
2674                                         }
2675                                         dm = tdm;
2676
2677                                         CDDM_apply_vert_coords(dm, deformedVerts);
2678                                 }
2679                                 else if (r_cage && dm == *r_cage) {
2680                                         /* dm may be changed by this modifier, so we need to copy it */
2681                                         dm = CDDM_copy(dm);
2682                                 }
2683
2684                         }
2685                         else {
2686                                 dm = CDDM_from_editbmesh(em, false, false);
2687                                 ASSERT_IS_VALID_DM(dm);
2688
2689                                 if (deformedVerts) {
2690                                         CDDM_apply_vert_coords(dm, deformedVerts);
2691                                 }
2692
2693                                 if (do_init_wmcol) {
2694                                         DM_update_weight_mcol(ob, dm, draw_flag, NULL, 0, NULL);
2695                                 }
2696                         }
2697
2698                         /* create an orco derivedmesh in parallel */
2699                         mask = curr->mask;
2700                         if (mask & CD_MASK_ORCO) {
2701                                 if (!orcodm)
2702                                         orcodm = create_orco_dm(ob, ob->data, em, CD_ORCO);
2703
2704                                 mask &= ~CD_MASK_ORCO;
2705                                 DM_set_only_copy(orcodm, mask | CD_MASK_ORIGINDEX);
2706
2707                                 if (mti->applyModifierEM || mti->applyModifierEM_DM) {
2708                                         ndm = modwrap_applyModifierEM(md, &mectx_orco, em, orcodm);
2709                                 }
2710                                 else {
2711                                         ndm = modwrap_applyModifier(md, &mectx_orco, orcodm);
2712                                 }
2713                                 ASSERT_IS_VALID_DM(ndm);
2714
2715                                 if (ndm) {
2716                                         /* if the modifier returned a new dm, release the old one */
2717                                         if (orcodm && orcodm != ndm) orcodm->release(orcodm);
2718                                         orcodm = ndm;
2719                                 }
2720                         }
2721
2722                         /* set the DerivedMesh to only copy needed data */
2723                         mask |= append_mask;
2724                         mask = curr->mask; /* CD_MASK_ORCO may have been cleared above */
2725
2726                         DM_set_only_copy(dm, mask | CD_MASK_ORIGINDEX);
2727
2728                         if (mask & CD_MASK_ORIGSPACE_MLOOP) {
2729                                 if (!CustomData_has_layer(&dm->loopData, CD_ORIGSPACE_MLOOP)) {
2730                                         DM_add_loop_layer(dm, CD_ORIGSPACE_MLOOP, CD_CALLOC, NULL);
2731                                         DM_init_origspace(dm);
2732                                 }
2733                         }
2734
2735                         if (mti->applyModifierEM || mti->applyModifierEM_DM)
2736                                 ndm = modwrap_applyModifierEM(md, &mectx_cache_gpu, em, dm);
2737                         else
2738                                 ndm = modwrap_applyModifier(md, &mectx_cache_gpu, dm);
2739                         ASSERT_IS_VALID_DM(ndm);
2740
2741                         if (ndm) {
2742                                 if (dm && dm != ndm)
2743                                         dm->release(dm);
2744
2745                                 dm = ndm;
2746
2747                                 if (deformedVerts) {
2748                                         MEM_freeN(deformedVerts);
2749                                         deformedVerts = NULL;
2750                                 }
2751                         }
2752
2753                         dm->deformedOnly = false;
2754                 }
2755
2756                 /* In case of active preview modifier, make sure preview mask remains for following modifiers. */
2757                 if ((md == previewmd) && (do_mod_wmcol)) {
2758                         DM_update_weight_mcol(ob, dm, draw_flag, NULL, 0, NULL);
2759                         append_mask |= CD_MASK_PREVIEW_MLOOPCOL;
2760                 }
2761
2762                 if (r_cage && i == cageIndex) {
2763                         if (dm && deformedVerts) {
2764                                 *r_cage = CDDM_copy(dm);
2765                                 CDDM_apply_vert_coords(*r_cage, deformedVerts);
2766                         }
2767                         else if (dm) {
2768                                 *r_cage = dm;
2769                         }
2770                         else {
2771                                 struct Mesh *mesh = ob->data;
2772                                 if (mesh->id.tag & LIB_TAG_COPY_ON_WRITE) {
2773                                         BKE_mesh_runtime_ensure_edit_data(mesh);
2774                                         mesh->runtime.edit_data->vertexCos = MEM_dupallocN(deformedVerts);
2775                                 }
2776                                 *r_cage = getEditDerivedBMesh(
2777                                         em, ob, mask,
2778                                         deformedVerts ? MEM_dupallocN(deformedVerts) : NULL);
2779                         }
2780                 }
2781         }
2782
2783         BLI_linklist_free((LinkNode *)datamasks, NULL);
2784
2785         /* Yay, we are done. If we have a DerivedMesh and deformed vertices need
2786          * to apply these back onto the DerivedMesh. If we have no DerivedMesh
2787          * then we need to build one.
2788          */
2789         if (dm && deformedVerts) {
2790                 *r_final = CDDM_copy(dm);
2791
2792                 if (!(r_cage && dm == *r_cage)) {
2793                         dm->release(dm);
2794                 }
2795
2796                 CDDM_apply_vert_coords(*r_final, deformedVerts);
2797         }
2798         else if (dm) {
2799                 *r_final = dm;
2800         }
2801         else if (!deformedVerts && r_cage && *r_cage) {
2802                 /* cage should already have up to date normals */
2803                 *r_final = *r_cage;
2804
2805                 /* In this case, we should never have weight-modifying modifiers in stack... */
2806                 if (do_init_wmcol)
2807                         DM_update_weight_mcol(ob, *r_final, draw_flag, NULL, 0, NULL);
2808                 if (do_init_statvis)
2809                         DM_update_statvis_color(scene, ob, *r_final);
2810         }
2811         else {
2812                 /* this is just a copy of the editmesh, no need to calc normals */
2813                 struct Mesh *mesh = ob->data;
2814                 if (mesh->id.tag & LIB_TAG_COPY_ON_WRITE) {
2815                         BKE_mesh_runtime_ensure_edit_data(mesh);
2816                         if (mesh->runtime.edit_data->vertexCos != NULL)
2817                                 MEM_freeN((void *)mesh->runtime.edit_data->vertexCos);
2818                         mesh->runtime.edit_data->vertexCos = MEM_dupallocN(deformedVerts);
2819                 }
2820                 *r_final = getEditDerivedBMesh(em, ob, dataMask, deformedVerts);
2821                 deformedVerts = NULL;
2822
2823                 /* In this case, we should never have weight-modifying modifiers in stack... */
2824                 if (do_init_wmcol)
2825                         DM_update_weight_mcol(ob, *r_final, draw_flag, NULL, 0, NULL);
2826                 if (do_init_statvis)
2827                         DM_update_statvis_color(scene, ob, *r_final);
2828         }
2829
2830         if (do_loop_normals) {
2831                 /* Compute loop normals */
2832                 DM_calc_loop_normals(*r_final, do_loop_normals, loop_normals_split_angle);
2833                 if (r_cage && *r_cage && (*r_cage != *r_final)) {
2834                         DM_calc_loop_normals(*r_cage, do_loop_normals, loop_normals_split_angle);
2835                 }
2836         }
2837
2838         /* BMESH_ONLY, ensure tessface's used for drawing,
2839          * but don't recalculate if the last modifier in the stack gives us tessfaces
2840          * check if the derived meshes are DM_TYPE_EDITBMESH before calling, this isn't essential
2841          * but quiets annoying error messages since tessfaces wont be created. */
2842         if (dataMask & CD_MASK_MFACE) {
2843                 if ((*r_final)->type != DM_TYPE_EDITBMESH) {
2844                         DM_ensure_tessface(*r_final);
2845                 }
2846                 if (r_cage && *r_cage) {
2847                         if ((*r_cage)->type != DM_TYPE_EDITBMESH) {
2848                                 if (*r_cage != *r_final) {
2849                                         DM_ensure_tessface(*r_cage);
2850                                 }
2851                         }
2852                 }
2853         }
2854         /* --- */
2855
2856         /* same as mesh_calc_modifiers (if using loop normals, poly nors have already been computed). */
2857         if (!do_loop_normals) {
2858                 dm_ensure_display_normals(*r_final);
2859
2860                 /* Some modifiers, like datatransfer, may generate those data, we do not want to keep them,
2861                  * as they are used by display code when available (i.e. even if autosmooth is disabled). */
2862                 if (CustomData_has_layer(&(*r_final)->loopData, CD_NORMAL)) {
2863                         CustomData_free_layers(&(*r_final)->loopData, CD_NORMAL, (*r_final)->numLoopData);
2864                 }
2865                 if (r_cage && CustomData_has_layer(&(*r_cage)->loopData, CD_NORMAL)) {
2866                         CustomData_free_layers(&(*r_cage)->loopData, CD_NORMAL, (*r_cage)->numLoopData);
2867                 }
2868         }
2869
2870         /* add an orco layer if needed */
2871         if (dataMask & CD_MASK_ORCO)
2872                 add_orco_dm(ob, em, *r_final, orcodm, CD_ORCO);
2873
2874         if (orcodm)
2875                 orcodm->release(orcodm);
2876
2877         if (deformedVerts)
2878                 MEM_freeN(deformedVerts);
2879 }
2880
2881 #ifdef WITH_OPENSUBDIV
2882 /* The idea is to skip CPU-side ORCO calculation when
2883  * we'll be using GPU backend of OpenSubdiv. This is so
2884  * playback performance is kept as high as possible.
2885  */
2886 static bool calc_modifiers_skip_orco(Depsgraph *depsgraph,
2887                                      Scene *scene,
2888                                      Object *ob,
2889                                      bool use_render_params)
2890 {
2891         ModifierData *last_md = ob->modifiers.last;
2892         const int required_mode = use_render_params ? eModifierMode_Render : eModifierMode_Realtime;
2893         if (last_md != NULL &&
2894             last_md->type == eModifierType_Subsurf &&
2895             modifier_isEnabled(scene, last_md, required_mode))
2896         {
2897                 if (U.opensubdiv_compute_type == USER_OPENSUBDIV_COMPUTE_NONE) {
2898                         return false;
2899                 }
2900                 else if ((ob->mode & (OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT | OB_MODE_TEXTURE_PAINT)) != 0) {
2901                         return false;
2902                 }
2903                 else if ((DEG_get_eval_flags_for_id(depsgraph, &ob->id) & DAG_EVAL_NEED_CPU) != 0) {
2904                         return false;
2905                 }
2906                 SubsurfModifierData *smd = (SubsurfModifierData *)last_md;
2907                 /* TODO(sergey): Deduplicate this with checks from subsurf_ccg.c. */
2908                 return smd->use_opensubdiv != 0;
2909         }
2910         return false;
2911 }
2912 #endif
2913
2914 static void mesh_build_data(
2915         struct Depsgraph *depsgraph, Scene *scene, Object *ob, CustomDataMask dataMask,
2916         const bool build_shapekey_layers, const bool need_mapping)
2917 {
2918         BLI_assert(ob->type == OB_MESH);
2919
2920         BKE_object_free_derived_caches(ob);
2921         BKE_object_sculpt_modifiers_changed(ob);
2922
2923 #ifdef WITH_OPENSUBDIV
2924         if (calc_modifiers_skip_orco(depsgraph, scene, ob, false)) {
2925                 dataMask &= ~(CD_MASK_ORCO | CD_MASK_PREVIEW_MCOL);
2926         }
2927 #endif
2928
2929         mesh_calc_modifiers_dm(
2930                 depsgraph, scene, ob, NULL, false, 1, need_mapping, dataMask, -1, true, build_shapekey_layers,
2931                 true,
2932                 &ob->derivedDeform, &ob->derivedFinal);
2933
2934         DM_set_object_boundbox(ob, ob->derivedFinal);
2935
2936         ob->derivedFinal->needsFree = 0;
2937         ob->derivedDeform->needsFree = 0;
2938         ob->lastDataMask = dataMask;
2939         ob->lastNeedMapping = need_mapping;
2940
2941         if ((ob->mode & OB_MODE_ALL_SCULPT) && ob->sculpt) {
2942                 /* create PBVH immediately (would be created on the fly too,
2943                  * but this avoids waiting on first stroke) */
2944
2945                 BKE_sculpt_update_mesh_elements(depsgraph, scene, scene->toolsettings->sculpt, ob, false, false);
2946         }
2947
2948         BLI_assert(!(ob->derivedFinal->dirty & DM_DIRTY_NORMALS));
2949 }
2950
2951 static void editbmesh_build_data(
2952         struct Depsgraph *depsgraph, Scene *scene,
2953         Object *obedit, BMEditMesh *em, CustomDataMask dataMask)
2954 {
2955         BKE_object_free_derived_caches(obedit);
2956         BKE_object_sculpt_modifiers_changed(obedit);
2957
2958         BKE_editmesh_free_derivedmesh(em);
2959
2960 #ifdef WITH_OPENSUBDIV
2961         if (calc_modifiers_skip_orco(depsgraph, scene, obedit, false)) {
2962                 dataMask &= ~(CD_MASK_ORCO | CD_MASK_PREVIEW_MCOL);
2963         }
2964 #endif
2965
2966         editbmesh_calc_modifiers(
2967                 depsgraph, scene, obedit, em, dataMask,
2968                 &em->derivedCage, &em->derivedFinal);
2969
2970         DM_set_object_boundbox(obedit, em->derivedFinal);
2971
2972         em->lastDataMask = dataMask;
2973         em->derivedFinal->needsFree = 0;
2974         em->derivedCage->needsFree = 0;
2975
2976         BLI_assert(!(em->derivedFinal->dirty & DM_DIRTY_NORMALS));
2977 }
2978
2979 static CustomDataMask object_get_datamask(const Depsgraph *depsgraph, Object *ob, bool *r_need_mapping)
2980 {
2981         ViewLayer *view_layer = DEG_get_evaluated_view_layer(depsgraph);
2982         Object *actob = view_layer->basact ? view_layer->basact->object : NULL;
2983         CustomDataMask mask = ob->customdata_mask;
2984
2985         if (r_need_mapping) {
2986                 *r_need_mapping = false;
2987         }
2988
2989         if (ob == actob) {
2990                 bool editing = BKE_paint_select_face_test(ob);
2991
2992                 /* weight paint and face select need original indices because of selection buffer drawing */
2993                 if (r_need_mapping) {
2994                         *r_need_mapping = (editing || (ob->mode & (OB_MODE_WEIGHT_PAINT | OB_MODE_VERTEX_PAINT)));
2995                 }
2996
2997                 /* check if we need tfaces & mcols due to face select or texture paint */
2998                 if ((ob->mode & OB_MODE_TEXTURE_PAINT) || editing) {
2999                         mask |= CD_MASK_MLOOPUV | CD_MASK_MLOOPCOL;
3000                 }
3001
3002                 /* check if we need mcols due to vertex paint or weightpaint */
3003                 if (ob->mode & OB_MODE_VERTEX_PAINT) {
3004                         mask |= CD_MASK_MLOOPCOL;
3005                 }
3006
3007                 if (ob->mode & OB_MODE_WEIGHT_PAINT) {
3008                         mask |= CD_MASK_PREVIEW_MLOOPCOL;
3009                 }
3010
3011                 if (ob->mode & OB_MODE_EDIT)
3012                         mask |= CD_MASK_MVERT_SKIN;
3013         }
3014
3015         return mask;
3016 }
3017
3018 void makeDerivedMesh(
3019         struct Depsgraph *depsgraph, Scene *scene, Object *ob, BMEditMesh *em,
3020         CustomDataMask dataMask, const bool build_shapekey_layers)
3021 {
3022         bool need_mapping;
3023         dataMask |= object_get_datamask(depsgraph, ob, &need_mapping);
3024
3025         if (em) {
3026                 editbmesh_build_data(depsgraph, scene, ob, em, dataMask);
3027         }
3028         else {
3029                 mesh_build_data(depsgraph, scene, ob, dataMask, build_shapekey_layers, need_mapping);
3030         }
3031 }
3032
3033 /***/
3034
3035 DerivedMesh *mesh_get_derived_final(
3036         struct Depsgraph *depsgraph, Scene *scene, Object *ob, CustomDataMask dataMask)
3037 {
3038         /* if there's no derived mesh or the last data mask used doesn't include
3039          * the data we need, rebuild the derived mesh
3040          */
3041         bool need_mapping;
3042         dataMask |= object_get_datamask(depsgraph, ob, &need_mapping);
3043
3044         if (!ob->derivedFinal ||
3045             ((dataMask & ob->lastDataMask) != dataMask) ||
3046             (need_mapping != ob->lastNeedMapping))
3047         {
3048                 mesh_build_data(depsgraph, scene, ob, dataMask, false, need_mapping);
3049         }
3050
3051         if (ob->derivedFinal) { BLI_assert(!(ob->derivedFinal->dirty & DM_DIRTY_NORMALS)); }
3052         return ob->derivedFinal;
3053 }
3054
3055 DerivedMesh *mesh_get_derived_deform(struct Depsgraph *depsgraph, Scene *scene, Object *ob, CustomDataMask dataMask)
3056 {
3057         /* if there's no derived mesh or the last data mask used doesn't include
3058          * the data we need, rebuild the derived mesh
3059          */
3060         bool need_mapping;
3061
3062         dataMask |= object_get_datamask(depsgraph, ob, &need_mapping);
3063
3064         if (!ob->derivedDeform ||
3065             ((dataMask & ob->lastDataMask) != dataMask) ||
3066             (need_mapping != ob->lastNeedMapping))
3067         {
3068                 mesh_build_data(depsgraph, scene, ob, dataMask, false, need_mapping);
3069         }
3070
3071         return ob->derivedDeform;
3072 }
3073
3074 DerivedMesh *mesh_create_derived_render(struct Depsgraph *depsgraph, Scene *scene, Object *ob, CustomDataMask dataMask)
3075 {
3076         DerivedMesh *final;
3077         
3078         mesh_calc_modifiers_dm(
3079                 depsgraph, scene, ob, NULL, true, 1, false, dataMask, -1, false, false, false,
3080                 NULL, &final);
3081
3082         return final;
3083 }
3084
3085 DerivedMesh *mesh_create_derived_index_render(struct Depsgraph *depsgraph, Scene *scene, Object *ob, CustomDataMask dataMask, int index)
3086 {
3087         DerivedMesh *final;
3088
3089         mesh_calc_modifiers_dm(
3090                 depsgraph, scene, ob, NULL, true, 1, false, dataMask, index, false, false, false,
3091                 NULL, &final);
3092
3093         return final;
3094 }
3095
3096 DerivedMesh *mesh_create_derived_view(
3097         struct Depsgraph *depsgraph, Scene *scene,
3098         Object *ob, CustomDataMask dataMask)
3099 {
3100         DerivedMesh *final;
3101
3102         /* XXX hack
3103          * psys modifier updates particle state when called during dupli-list generation,
3104          * which can lead to wrong transforms. This disables particle system modifier execution.
3105          */
3106         ob->transflag |= OB_NO_PSYS_UPDATE;
3107
3108         mesh_calc_modifiers_dm(
3109                 depsgraph, scene, ob, NULL, false, 1, false, dataMask, -1, false, false, false,
3110                 NULL, &final);
3111
3112         ob->transflag &= ~OB_NO_PSYS_UPDATE;
3113
3114         return final;
3115 }
3116
3117 DerivedMesh *mesh_create_derived_no_deform(
3118         struct Depsgraph *depsgraph, Scene *scene, Object *ob,
3119         float (*vertCos)[3], CustomDataMask dataMask)
3120 {
3121         DerivedMesh *final;
3122         
3123         mesh_calc_modifiers_dm(
3124                 depsgraph, scene, ob, vertCos, false, 0, false, dataMask, -1, false, false, false,
3125                 NULL, &final);
3126
3127         return final;
3128 }
3129
3130 DerivedMesh *mesh_create_derived_no_deform_render(
3131         struct Depsgraph *depsgraph, Scene *scene,
3132         Object *ob, float (*vertCos)[3],
3133         CustomDataMask dataMask)
3134 {
3135         DerivedMesh *final;
3136
3137         mesh_calc_modifiers_dm(
3138                 depsgraph, scene, ob, vertCos, true, 0, false, dataMask, -1, false, false, false,
3139                 NULL, &final);
3140
3141         return final;
3142 }
3143
3144 /***/
3145
3146 DerivedMesh *editbmesh_get_derived_cage_and_final(
3147        &nbs