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