Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / intern / modifier.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software  Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2005 by the Blender Foundation.
17  * All rights reserved.
18  * Modifier stack implementation.
19  *
20  * BKE_modifier.h contains the function prototypes for this file.
21  */
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #include <stdlib.h>
28 #include <stddef.h>
29 #include <string.h>
30 #include <stdarg.h>
31 #include <math.h>
32 #include <float.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_armature_types.h"
37 #include "DNA_mesh_types.h"
38 #include "DNA_object_types.h"
39
40 #include "BLI_utildefines.h"
41 #include "BLI_listbase.h"
42 #include "BLI_linklist.h"
43 #include "BLI_path_util.h"
44 #include "BLI_string.h"
45 #include "BLI_string_utils.h"
46
47 #include "BLT_translation.h"
48
49 #include "BKE_appdir.h"
50 #include "BKE_cdderivedmesh.h"
51 #include "BKE_editmesh.h"
52 #include "BKE_global.h"
53 #include "BKE_idcode.h"
54 #include "BKE_key.h"
55 #include "BKE_library.h"
56 #include "BKE_library_query.h"
57 #include "BKE_mesh.h"
58 #include "BKE_multires.h"
59 #include "BKE_object.h"
60 #include "BKE_DerivedMesh.h"
61
62 /* may move these, only for modifier_path_relbase */
63 #include "BKE_main.h"
64 /* end */
65
66 #include "DEG_depsgraph.h"
67 #include "DEG_depsgraph_query.h"
68
69 #include "MOD_modifiertypes.h"
70
71 #include "CLG_log.h"
72
73 static CLG_LogRef LOG = {"bke.modifier"};
74 static ModifierTypeInfo *modifier_types[NUM_MODIFIER_TYPES] = {NULL};
75 static VirtualModifierData virtualModifierCommonData;
76
77 void BKE_modifier_init(void)
78 {
79         ModifierData *md;
80
81         /* Initialize modifier types */
82         modifier_type_init(modifier_types); /* MOD_utils.c */
83
84         /* Initialize global cmmon storage used for virtual modifier list */
85         md = modifier_new(eModifierType_Armature);
86         virtualModifierCommonData.amd = *((ArmatureModifierData *) md);
87         modifier_free(md);
88
89         md = modifier_new(eModifierType_Curve);
90         virtualModifierCommonData.cmd = *((CurveModifierData *) md);
91         modifier_free(md);
92
93         md = modifier_new(eModifierType_Lattice);
94         virtualModifierCommonData.lmd = *((LatticeModifierData *) md);
95         modifier_free(md);
96
97         md = modifier_new(eModifierType_ShapeKey);
98         virtualModifierCommonData.smd = *((ShapeKeyModifierData *) md);
99         modifier_free(md);
100
101         virtualModifierCommonData.amd.modifier.mode |= eModifierMode_Virtual;
102         virtualModifierCommonData.cmd.modifier.mode |= eModifierMode_Virtual;
103         virtualModifierCommonData.lmd.modifier.mode |= eModifierMode_Virtual;
104         virtualModifierCommonData.smd.modifier.mode |= eModifierMode_Virtual;
105 }
106
107 const ModifierTypeInfo *modifierType_getInfo(ModifierType type)
108 {
109         /* type unsigned, no need to check < 0 */
110         if (type < NUM_MODIFIER_TYPES && modifier_types[type]->name[0] != '\0') {
111                 return modifier_types[type];
112         }
113         else {
114                 return NULL;
115         }
116 }
117
118 /***/
119
120 ModifierData *modifier_new(int type)
121 {
122         const ModifierTypeInfo *mti = modifierType_getInfo(type);
123         ModifierData *md = MEM_callocN(mti->structSize, mti->structName);
124
125         /* note, this name must be made unique later */
126         BLI_strncpy(md->name, DATA_(mti->name), sizeof(md->name));
127
128         md->type = type;
129         md->mode = eModifierMode_Realtime | eModifierMode_Render | eModifierMode_Expanded;
130         md->flag = eModifierFlag_StaticOverride_Local;
131
132         if (mti->flags & eModifierTypeFlag_EnableInEditmode)
133                 md->mode |= eModifierMode_Editmode;
134
135         if (mti->initData) mti->initData(md);
136
137         return md;
138 }
139
140 static void modifier_free_data_id_us_cb(void *UNUSED(userData), Object *UNUSED(ob), ID **idpoin, int cb_flag)
141 {
142         ID *id = *idpoin;
143         if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
144                 id_us_min(id);
145         }
146 }
147
148 void modifier_free_ex(ModifierData *md, const int flag)
149 {
150         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
151
152         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
153                 if (mti->foreachIDLink) {
154                         mti->foreachIDLink(md, NULL, modifier_free_data_id_us_cb, NULL);
155                 }
156                 else if (mti->foreachObjectLink) {
157                         mti->foreachObjectLink(md, NULL, (ObjectWalkFunc)modifier_free_data_id_us_cb, NULL);
158                 }
159         }
160
161         if (mti->freeData) mti->freeData(md);
162         if (md->error) MEM_freeN(md->error);
163
164         MEM_freeN(md);
165 }
166
167 void modifier_free(ModifierData *md)
168 {
169         modifier_free_ex(md, 0);
170 }
171
172 bool modifier_unique_name(ListBase *modifiers, ModifierData *md)
173 {
174         if (modifiers && md) {
175                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
176
177                 return BLI_uniquename(modifiers, md, DATA_(mti->name), '.', offsetof(ModifierData, name), sizeof(md->name));
178         }
179         return false;
180 }
181
182 bool modifier_dependsOnTime(ModifierData *md)
183 {
184         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
185
186         return mti->dependsOnTime && mti->dependsOnTime(md);
187 }
188
189 bool modifier_supportsMapping(ModifierData *md)
190 {
191         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
192
193         return (mti->type == eModifierTypeType_OnlyDeform ||
194                 (mti->flags & eModifierTypeFlag_SupportsMapping));
195 }
196
197 bool modifier_isPreview(ModifierData *md)
198 {
199         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
200
201         /* Constructive modifiers are highly likely to also modify data like vgroups or vcol! */
202         if (!((mti->flags & eModifierTypeFlag_UsesPreview) || (mti->type == eModifierTypeType_Constructive))) {
203                 return false;
204         }
205
206         if (md->mode & eModifierMode_Realtime) {
207                 return true;
208         }
209
210         return false;
211 }
212
213 ModifierData *modifiers_findByType(Object *ob, ModifierType type)
214 {
215         ModifierData *md = ob->modifiers.first;
216
217         for (; md; md = md->next)
218                 if (md->type == type)
219                         break;
220
221         return md;
222 }
223
224 ModifierData *modifiers_findByName(Object *ob, const char *name)
225 {
226         return BLI_findstring(&(ob->modifiers), name, offsetof(ModifierData, name));
227 }
228
229 void modifiers_clearErrors(Object *ob)
230 {
231         ModifierData *md = ob->modifiers.first;
232         /* int qRedraw = 0; */
233
234         for (; md; md = md->next) {
235                 if (md->error) {
236                         MEM_freeN(md->error);
237                         md->error = NULL;
238
239                         /* qRedraw = 1; */
240                 }
241         }
242 }
243
244 void modifiers_foreachObjectLink(Object *ob, ObjectWalkFunc walk, void *userData)
245 {
246         ModifierData *md = ob->modifiers.first;
247
248         for (; md; md = md->next) {
249                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
250
251                 if (mti->foreachObjectLink)
252                         mti->foreachObjectLink(md, ob, walk, userData);
253         }
254 }
255
256 void modifiers_foreachIDLink(Object *ob, IDWalkFunc walk, void *userData)
257 {
258         ModifierData *md = ob->modifiers.first;
259
260         for (; md; md = md->next) {
261                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
262
263                 if (mti->foreachIDLink) mti->foreachIDLink(md, ob, walk, userData);
264                 else if (mti->foreachObjectLink) {
265                         /* each Object can masquerade as an ID, so this should be OK */
266                         ObjectWalkFunc fp = (ObjectWalkFunc)walk;
267                         mti->foreachObjectLink(md, ob, fp, userData);
268                 }
269         }
270 }
271
272 void modifiers_foreachTexLink(Object *ob, TexWalkFunc walk, void *userData)
273 {
274         ModifierData *md = ob->modifiers.first;
275
276         for (; md; md = md->next) {
277                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
278
279                 if (mti->foreachTexLink)
280                         mti->foreachTexLink(md, ob, walk, userData);
281         }
282 }
283
284 /* callback's can use this
285  * to avoid copying every member.
286  */
287 void modifier_copyData_generic(const ModifierData *md_src, ModifierData *md_dst, const int UNUSED(flag))
288 {
289         const ModifierTypeInfo *mti = modifierType_getInfo(md_src->type);
290
291         /* md_dst may have already be fully initialized with some extra allocated data,
292          * we need to free it now to avoid memleak. */
293         if (mti->freeData) {
294                 mti->freeData(md_dst);
295         }
296
297         const size_t data_size = sizeof(ModifierData);
298         const char *md_src_data = ((const char *)md_src) + data_size;
299         char       *md_dst_data =       ((char *)md_dst) + data_size;
300         BLI_assert(data_size <= (size_t)mti->structSize);
301         memcpy(md_dst_data, md_src_data, (size_t)mti->structSize - data_size);
302
303         /* Runtime fields are never to be preserved. */
304         md_dst->runtime = NULL;
305 }
306
307 static void modifier_copy_data_id_us_cb(void *UNUSED(userData), Object *UNUSED(ob), ID **idpoin, int cb_flag)
308 {
309         ID *id = *idpoin;
310         if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
311                 id_us_plus(id);
312         }
313 }
314
315 void modifier_copyData_ex(ModifierData *md, ModifierData *target, const int flag)
316 {
317         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
318
319         target->mode = md->mode;
320         target->flag = md->flag;
321
322         if (mti->copyData) {
323                 mti->copyData(md, target, flag);
324         }
325
326         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
327                 if (mti->foreachIDLink) {
328                         mti->foreachIDLink(target, NULL, modifier_copy_data_id_us_cb, NULL);
329                 }
330                 else if (mti->foreachObjectLink) {
331                         mti->foreachObjectLink(target, NULL, (ObjectWalkFunc)modifier_copy_data_id_us_cb, NULL);
332                 }
333         }
334 }
335
336 void modifier_copyData(ModifierData *md, ModifierData *target)
337 {
338         modifier_copyData_ex(md, target, 0);
339 }
340
341
342 bool modifier_supportsCage(struct Scene *scene, ModifierData *md)
343 {
344         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
345
346         return ((!mti->isDisabled || !mti->isDisabled(scene, md, 0)) &&
347                 (mti->flags & eModifierTypeFlag_SupportsEditmode) &&
348                 modifier_supportsMapping(md));
349 }
350
351 bool modifier_couldBeCage(struct Scene *scene, ModifierData *md)
352 {
353         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
354
355         return ((md->mode & eModifierMode_Realtime) &&
356                 (md->mode & eModifierMode_Editmode) &&
357                 (!mti->isDisabled || !mti->isDisabled(scene, md, 0)) &&
358                 modifier_supportsMapping(md));
359 }
360
361 bool modifier_isSameTopology(ModifierData *md)
362 {
363         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
364         return ELEM(mti->type, eModifierTypeType_OnlyDeform, eModifierTypeType_NonGeometrical);
365 }
366
367 bool modifier_isNonGeometrical(ModifierData *md)
368 {
369         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
370         return (mti->type == eModifierTypeType_NonGeometrical);
371 }
372
373 void modifier_setError(ModifierData *md, const char *_format, ...)
374 {
375         char buffer[512];
376         va_list ap;
377         const char *format = TIP_(_format);
378
379         va_start(ap, _format);
380         vsnprintf(buffer, sizeof(buffer), format, ap);
381         va_end(ap);
382         buffer[sizeof(buffer) - 1] = '\0';
383
384         if (md->error)
385                 MEM_freeN(md->error);
386
387         md->error = BLI_strdup(buffer);
388
389         CLOG_STR_ERROR(&LOG, md->error);
390 }
391
392 /* used for buttons, to find out if the 'draw deformed in editmode' option is
393  * there
394  *
395  * also used in transform_conversion.c, to detect CrazySpace [tm] (2nd arg
396  * then is NULL)
397  * also used for some mesh tools to give warnings
398  */
399 int modifiers_getCageIndex(struct Scene *scene, Object *ob, int *r_lastPossibleCageIndex, bool is_virtual)
400 {
401         VirtualModifierData virtualModifierData;
402         ModifierData *md = (is_virtual) ? modifiers_getVirtualModifierList(ob, &virtualModifierData) : ob->modifiers.first;
403         int i, cageIndex = -1;
404
405         if (r_lastPossibleCageIndex) {
406                 /* ensure the value is initialized */
407                 *r_lastPossibleCageIndex = -1;
408         }
409
410         /* Find the last modifier acting on the cage. */
411         for (i = 0; md; i++, md = md->next) {
412                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
413                 bool supports_mapping;
414
415                 if (mti->isDisabled && mti->isDisabled(scene, md, 0)) continue;
416                 if (!(mti->flags & eModifierTypeFlag_SupportsEditmode)) continue;
417                 if (md->mode & eModifierMode_DisableTemporary) continue;
418
419                 supports_mapping = modifier_supportsMapping(md);
420                 if (r_lastPossibleCageIndex && supports_mapping) {
421                         *r_lastPossibleCageIndex = i;
422                 }
423
424                 if (!(md->mode & eModifierMode_Realtime)) continue;
425                 if (!(md->mode & eModifierMode_Editmode)) continue;
426
427                 if (!supports_mapping)
428                         break;
429
430                 if (md->mode & eModifierMode_OnCage)
431                         cageIndex = i;
432         }
433
434         return cageIndex;
435 }
436
437
438 bool modifiers_isSoftbodyEnabled(Object *ob)
439 {
440         ModifierData *md = modifiers_findByType(ob, eModifierType_Softbody);
441
442         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
443 }
444
445 bool modifiers_isClothEnabled(Object *ob)
446 {
447         ModifierData *md = modifiers_findByType(ob, eModifierType_Cloth);
448
449         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
450 }
451
452 bool modifiers_isModifierEnabled(Object *ob, int modifierType)
453 {
454         ModifierData *md = modifiers_findByType(ob, modifierType);
455
456         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
457 }
458
459 bool modifiers_isParticleEnabled(Object *ob)
460 {
461         ModifierData *md = modifiers_findByType(ob, eModifierType_ParticleSystem);
462
463         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
464 }
465
466 /**
467  * Check whether is enabled.
468  *
469  * \param scene: Current scene, may be NULL, in which case isDisabled callback of the modifier is never called.
470  */
471 bool modifier_isEnabled(const struct Scene *scene, ModifierData *md, int required_mode)
472 {
473         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
474
475         if ((md->mode & required_mode) != required_mode) return false;
476         if (scene != NULL && mti->isDisabled && mti->isDisabled(scene, md, required_mode == eModifierMode_Render)) return false;
477         if (md->mode & eModifierMode_DisableTemporary) return false;
478         if ((required_mode & eModifierMode_Editmode) && !(mti->flags & eModifierTypeFlag_SupportsEditmode)) return false;
479
480         return true;
481 }
482
483 CDMaskLink *modifiers_calcDataMasks(struct Scene *scene, Object *ob, ModifierData *md,
484                                     const CustomData_MeshMasks *dataMask, int required_mode,
485                                     ModifierData *previewmd, const CustomData_MeshMasks *previewmask)
486 {
487         CDMaskLink *dataMasks = NULL;
488         CDMaskLink *curr, *prev;
489
490         /* build a list of modifier data requirements in reverse order */
491         for (; md; md = md->next) {
492                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
493
494                 curr = MEM_callocN(sizeof(CDMaskLink), "CDMaskLink");
495
496                 if (modifier_isEnabled(scene, md, required_mode)) {
497                         if (mti->requiredDataMask)
498                                  mti->requiredDataMask(ob, md, &curr->mask);
499
500                         if (previewmd == md && previewmask != NULL) {
501                                 CustomData_MeshMasks_update(&curr->mask, previewmask);
502                         }
503                 }
504
505                 /* prepend new datamask */
506                 curr->next = dataMasks;
507                 dataMasks = curr;
508         }
509
510         /* build the list of required data masks - each mask in the list must
511          * include all elements of the masks that follow it
512          *
513          * note the list is currently in reverse order, so "masks that follow it"
514          * actually means "masks that precede it" at the moment
515          */
516         for (curr = dataMasks, prev = NULL; curr; prev = curr, curr = curr->next) {
517                 if (prev) {
518                         CustomData_MeshMasks_update(&curr->mask, &prev->mask);
519                 }
520                 else {
521                         CustomData_MeshMasks_update(&curr->mask, dataMask);
522                 }
523         }
524
525         /* reverse the list so it's in the correct order */
526         BLI_linklist_reverse((LinkNode **)&dataMasks);
527
528         return dataMasks;
529 }
530
531 ModifierData *modifiers_getLastPreview(struct Scene *scene, ModifierData *md, int required_mode)
532 {
533         ModifierData *tmp_md = NULL;
534
535         if ((required_mode & ~eModifierMode_Editmode) != eModifierMode_Realtime)
536                 return tmp_md;
537
538         /* Find the latest modifier in stack generating preview. */
539         for (; md; md = md->next) {
540                 if (modifier_isEnabled(scene, md, required_mode) && modifier_isPreview(md))
541                         tmp_md = md;
542         }
543         return tmp_md;
544 }
545
546 /* NOTE: This is to support old files from before Blender supported modifiers,
547  * in some cases versioning code updates these so for new files this will
548  * return an empty list. */
549 ModifierData *modifiers_getVirtualModifierList(Object *ob, VirtualModifierData *virtualModifierData)
550 {
551         ModifierData *md;
552
553         md = ob->modifiers.first;
554
555         *virtualModifierData = virtualModifierCommonData;
556
557         if (ob->parent) {
558                 if (ob->parent->type == OB_ARMATURE && ob->partype == PARSKEL) {
559                         virtualModifierData->amd.object = ob->parent;
560                         virtualModifierData->amd.modifier.next = md;
561                         virtualModifierData->amd.deformflag = ((bArmature *)(ob->parent->data))->deformflag;
562                         md = &virtualModifierData->amd.modifier;
563                 }
564                 else if (ob->parent->type == OB_CURVE && ob->partype == PARSKEL) {
565                         virtualModifierData->cmd.object = ob->parent;
566                         virtualModifierData->cmd.defaxis = ob->trackflag + 1;
567                         virtualModifierData->cmd.modifier.next = md;
568                         md = &virtualModifierData->cmd.modifier;
569                 }
570                 else if (ob->parent->type == OB_LATTICE && ob->partype == PARSKEL) {
571                         virtualModifierData->lmd.object = ob->parent;
572                         virtualModifierData->lmd.modifier.next = md;
573                         md = &virtualModifierData->lmd.modifier;
574                 }
575         }
576
577         /* shape key modifier, not yet for curves */
578         if (ELEM(ob->type, OB_MESH, OB_LATTICE) && BKE_key_from_object(ob)) {
579                 if (ob->type == OB_MESH && (ob->shapeflag & OB_SHAPE_EDIT_MODE))
580                         virtualModifierData->smd.modifier.mode |= eModifierMode_Editmode | eModifierMode_OnCage;
581                 else
582                         virtualModifierData->smd.modifier.mode &= ~eModifierMode_Editmode | eModifierMode_OnCage;
583
584                 virtualModifierData->smd.modifier.next = md;
585                 md = &virtualModifierData->smd.modifier;
586         }
587
588         return md;
589 }
590
591 /* Takes an object and returns its first selected armature, else just its armature
592  * This should work for multiple armatures per object
593  */
594 Object *modifiers_isDeformedByArmature(Object *ob)
595 {
596         VirtualModifierData virtualModifierData;
597         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
598         ArmatureModifierData *amd = NULL;
599
600         /* return the first selected armature, this lets us use multiple armatures */
601         for (; md; md = md->next) {
602                 if (md->type == eModifierType_Armature) {
603                         amd = (ArmatureModifierData *) md;
604                         if (amd->object && (amd->object->flag & SELECT))
605                                 return amd->object;
606                 }
607         }
608
609         if (amd) /* if were still here then return the last armature */
610                 return amd->object;
611
612         return NULL;
613 }
614
615 Object *modifiers_isDeformedByMeshDeform(Object *ob)
616 {
617         VirtualModifierData virtualModifierData;
618         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
619         MeshDeformModifierData *mdmd = NULL;
620
621         /* return the first selected armature, this lets us use multiple armatures */
622         for (; md; md = md->next) {
623                 if (md->type == eModifierType_MeshDeform) {
624                         mdmd = (MeshDeformModifierData *) md;
625                         if (mdmd->object && (mdmd->object->flag & SELECT))
626                                 return mdmd->object;
627                 }
628         }
629
630         if (mdmd) /* if were still here then return the last armature */
631                 return mdmd->object;
632
633         return NULL;
634 }
635
636 /* Takes an object and returns its first selected lattice, else just its lattice
637  * This should work for multiple lattices per object
638  */
639 Object *modifiers_isDeformedByLattice(Object *ob)
640 {
641         VirtualModifierData virtualModifierData;
642         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
643         LatticeModifierData *lmd = NULL;
644
645         /* return the first selected lattice, this lets us use multiple lattices */
646         for (; md; md = md->next) {
647                 if (md->type == eModifierType_Lattice) {
648                         lmd = (LatticeModifierData *) md;
649                         if (lmd->object && (lmd->object->flag & SELECT))
650                                 return lmd->object;
651                 }
652         }
653
654         if (lmd) /* if were still here then return the last lattice */
655                 return lmd->object;
656
657         return NULL;
658 }
659
660 /* Takes an object and returns its first selected curve, else just its curve
661  * This should work for multiple curves per object
662  */
663 Object *modifiers_isDeformedByCurve(Object *ob)
664 {
665         VirtualModifierData virtualModifierData;
666         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
667         CurveModifierData *cmd = NULL;
668
669         /* return the first selected curve, this lets us use multiple curves */
670         for (; md; md = md->next) {
671                 if (md->type == eModifierType_Curve) {
672                         cmd = (CurveModifierData *) md;
673                         if (cmd->object && (cmd->object->flag & SELECT))
674                                 return cmd->object;
675                 }
676         }
677
678         if (cmd) /* if were still here then return the last curve */
679                 return cmd->object;
680
681         return NULL;
682 }
683
684 bool modifiers_usesArmature(Object *ob, bArmature *arm)
685 {
686         VirtualModifierData virtualModifierData;
687         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
688
689         for (; md; md = md->next) {
690                 if (md->type == eModifierType_Armature) {
691                         ArmatureModifierData *amd = (ArmatureModifierData *) md;
692                         if (amd->object && amd->object->data == arm)
693                                 return true;
694                 }
695         }
696
697         return false;
698 }
699
700 bool modifier_isCorrectableDeformed(ModifierData *md)
701 {
702         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
703         return mti->deformMatricesEM != NULL;
704 }
705
706 bool modifiers_isCorrectableDeformed(struct Scene *scene, Object *ob)
707 {
708         VirtualModifierData virtualModifierData;
709         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
710         int required_mode = eModifierMode_Realtime;
711
712         if (ob->mode == OB_MODE_EDIT) {
713                 required_mode |= eModifierMode_Editmode;
714         }
715         for (; md; md = md->next) {
716                 if (!modifier_isEnabled(scene, md, required_mode)) {
717                         /* pass */
718                 }
719                 else if (modifier_isCorrectableDeformed(md)) {
720                         return true;
721                 }
722         }
723         return false;
724 }
725
726 /* Check whether the given object has a modifier in its stack that uses WEIGHT_MCOL CD layer
727  * to preview something... Used by DynamicPaint and WeightVG currently. */
728 bool modifiers_isPreview(Object *ob)
729 {
730         ModifierData *md = ob->modifiers.first;
731
732         for (; md; md = md->next) {
733                 if (modifier_isPreview(md))
734                         return true;
735         }
736
737         return false;
738 }
739
740 void modifier_freeTemporaryData(ModifierData *md)
741 {
742         if (md->type == eModifierType_Armature) {
743                 ArmatureModifierData *amd = (ArmatureModifierData *)md;
744
745                 if (amd->prevCos) {
746                         MEM_freeN(amd->prevCos);
747                         amd->prevCos = NULL;
748                 }
749         }
750 }
751
752 /* ensure modifier correctness when changing ob->data */
753 void test_object_modifiers(Object *ob)
754 {
755         ModifierData *md;
756
757         /* just multires checked for now, since only multires
758          * modifies mesh data */
759
760         if (ob->type != OB_MESH) return;
761
762         for (md = ob->modifiers.first; md; md = md->next) {
763                 if (md->type == eModifierType_Multires) {
764                         MultiresModifierData *mmd = (MultiresModifierData *)md;
765
766                         multiresModifier_set_levels_from_disps(mmd, ob);
767                 }
768         }
769 }
770
771 /* where should this go?, it doesn't fit well anywhere :S - campbell */
772
773 /* elubie: changed this to default to the same dir as the render output
774  * to prevent saving to C:\ on Windows */
775
776 /* campbell: logic behind this...
777  *
778  * - if the ID is from a library, return library path
779  * - else if the file has been saved return the blend file path.
780  * - else if the file isn't saved and the ID isn't from a library, return the temp dir.
781  */
782 const char *modifier_path_relbase(Main *bmain, Object *ob)
783 {
784         if (G.relbase_valid || ID_IS_LINKED(ob)) {
785                 return ID_BLEND_PATH(bmain, &ob->id);
786         }
787         else {
788                 /* last resort, better then using "" which resolves to the current
789                  * working directory */
790                 return BKE_tempdir_session();
791         }
792 }
793
794 const char *modifier_path_relbase_from_global(Object *ob)
795 {
796         if (G.relbase_valid || ID_IS_LINKED(ob)) {
797                 return ID_BLEND_PATH_FROM_GLOBAL(&ob->id);
798         }
799         else {
800                 /* last resort, better then using "" which resolves to the current
801                  * working directory */
802                 return BKE_tempdir_session();
803         }
804 }
805
806 /* initializes the path with either */
807 void modifier_path_init(char *path, int path_maxlen, const char *name)
808 {
809         /* elubie: changed this to default to the same dir as the render output
810          * to prevent saving to C:\ on Windows */
811         BLI_join_dirfile(path, path_maxlen,
812                          G.relbase_valid ? "//" : BKE_tempdir_session(),
813                          name);
814 }
815
816
817 /* wrapper around ModifierTypeInfo.applyModifier that ensures valid normals */
818
819 struct Mesh *modwrap_applyModifier(
820         ModifierData *md, const ModifierEvalContext *ctx,
821         struct Mesh *me)
822 {
823         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
824         BLI_assert(CustomData_has_layer(&me->pdata, CD_NORMAL) == false);
825
826         if (mti->dependsOnNormals && mti->dependsOnNormals(md)) {
827                 BKE_mesh_calc_normals(me);
828         }
829         return mti->applyModifier(md, ctx, me);
830 }
831
832 void modwrap_deformVerts(
833         ModifierData *md, const ModifierEvalContext *ctx,
834         Mesh *me, float (*vertexCos)[3], int numVerts)
835 {
836         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
837         BLI_assert(!me || CustomData_has_layer(&me->pdata, CD_NORMAL) == false);
838
839         if (me && mti->dependsOnNormals && mti->dependsOnNormals(md)) {
840                 BKE_mesh_calc_normals(me);
841         }
842         mti->deformVerts(md, ctx, me, vertexCos, numVerts);
843 }
844
845 void modwrap_deformVertsEM(
846         ModifierData *md, const ModifierEvalContext *ctx,
847         struct BMEditMesh *em, Mesh *me,
848         float (*vertexCos)[3], int numVerts)
849 {
850         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
851         BLI_assert(!me || CustomData_has_layer(&me->pdata, CD_NORMAL) == false);
852
853         if (me && mti->dependsOnNormals && mti->dependsOnNormals(md)) {
854                 BKE_mesh_calc_normals(me);
855         }
856         mti->deformVertsEM(md, ctx, em, me, vertexCos, numVerts);
857 }
858
859 /* end modifier callback wrappers */
860
861
862 /**
863  * Get evaluated mesh for other evaluated object, which is used as an operand for the modifier,
864  * e.g. second operand for boolean modifier.
865  * Note that modifiers in stack always get fully evaluated COW ID pointers, never original ones. Makes things simpler.
866  *
867  * \param get_cage_mesh Return evaluated mesh with only deforming modifiers applied
868  *                      (i.e. mesh topology remains the same as original one, a.k.a. 'cage' mesh).
869  */
870 Mesh *BKE_modifier_get_evaluated_mesh_from_evaluated_object(Object *ob_eval, const bool get_cage_mesh)
871 {
872         Mesh *me = NULL;
873
874         if ((ob_eval->type == OB_MESH) && (ob_eval->mode & OB_MODE_EDIT)) {
875                 /* In EditMode, evaluated mesh is stored in BMEditMesh, not the object... */
876                 BMEditMesh *em = BKE_editmesh_from_object(ob_eval);
877                 if (em != NULL) {  /* em might not exist yet in some cases, just after loading a .blend file, see T57878. */
878                         me = (get_cage_mesh && em->mesh_eval_cage != NULL) ? em->mesh_eval_cage : em->mesh_eval_final;
879                 }
880         }
881         if (me == NULL) {
882                 me = (get_cage_mesh && ob_eval->runtime.mesh_deform_eval != NULL) ? ob_eval->runtime.mesh_deform_eval :
883                                                                                     ob_eval->runtime.mesh_eval;
884         }
885
886         return me;
887 }
888
889 ModifierData *modifier_get_original(ModifierData *md)
890 {
891         if (md->orig_modifier_data == NULL) {
892                 return md;
893         }
894         return md->orig_modifier_data;
895 }
896
897 struct ModifierData *modifier_get_evaluated(
898         Depsgraph* depsgraph,
899         Object *object,
900         ModifierData *md)
901 {
902         Object *object_eval = DEG_get_evaluated_object(depsgraph, object);
903         if (object_eval == object) {
904                 return md;
905         }
906         return modifiers_findByName(object_eval, md->name);
907 }