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