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