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
304 static void modifier_copy_data_id_us_cb(void *UNUSED(userData), Object *UNUSED(ob), ID **idpoin, int cb_flag)
305 {
306         ID *id = *idpoin;
307         if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
308                 id_us_plus(id);
309         }
310 }
311
312 void modifier_copyData_ex(ModifierData *md, ModifierData *target, const int flag)
313 {
314         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
315
316         target->mode = md->mode;
317         target->flag = md->flag;
318
319         if (mti->copyData) {
320                 mti->copyData(md, target, flag);
321         }
322
323         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
324                 if (mti->foreachIDLink) {
325                         mti->foreachIDLink(target, NULL, modifier_copy_data_id_us_cb, NULL);
326                 }
327                 else if (mti->foreachObjectLink) {
328                         mti->foreachObjectLink(target, NULL, (ObjectWalkFunc)modifier_copy_data_id_us_cb, NULL);
329                 }
330         }
331 }
332
333 void modifier_copyData(ModifierData *md, ModifierData *target)
334 {
335         modifier_copyData_ex(md, target, 0);
336 }
337
338
339 bool modifier_supportsCage(struct Scene *scene, ModifierData *md)
340 {
341         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
342
343         return ((!mti->isDisabled || !mti->isDisabled(scene, md, 0)) &&
344                 (mti->flags & eModifierTypeFlag_SupportsEditmode) &&
345                 modifier_supportsMapping(md));
346 }
347
348 bool modifier_couldBeCage(struct Scene *scene, ModifierData *md)
349 {
350         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
351
352         return ((md->mode & eModifierMode_Realtime) &&
353                 (md->mode & eModifierMode_Editmode) &&
354                 (!mti->isDisabled || !mti->isDisabled(scene, md, 0)) &&
355                 modifier_supportsMapping(md));
356 }
357
358 bool modifier_isSameTopology(ModifierData *md)
359 {
360         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
361         return ELEM(mti->type, eModifierTypeType_OnlyDeform, eModifierTypeType_NonGeometrical);
362 }
363
364 bool modifier_isNonGeometrical(ModifierData *md)
365 {
366         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
367         return (mti->type == eModifierTypeType_NonGeometrical);
368 }
369
370 void modifier_setError(ModifierData *md, const char *_format, ...)
371 {
372         char buffer[512];
373         va_list ap;
374         const char *format = TIP_(_format);
375
376         va_start(ap, _format);
377         vsnprintf(buffer, sizeof(buffer), format, ap);
378         va_end(ap);
379         buffer[sizeof(buffer) - 1] = '\0';
380
381         if (md->error)
382                 MEM_freeN(md->error);
383
384         md->error = BLI_strdup(buffer);
385
386         CLOG_STR_ERROR(&LOG, md->error);
387 }
388
389 /* used for buttons, to find out if the 'draw deformed in editmode' option is
390  * there
391  *
392  * also used in transform_conversion.c, to detect CrazySpace [tm] (2nd arg
393  * then is NULL)
394  * also used for some mesh tools to give warnings
395  */
396 int modifiers_getCageIndex(struct Scene *scene, Object *ob, int *r_lastPossibleCageIndex, bool is_virtual)
397 {
398         VirtualModifierData virtualModifierData;
399         ModifierData *md = (is_virtual) ? modifiers_getVirtualModifierList(ob, &virtualModifierData) : ob->modifiers.first;
400         int i, cageIndex = -1;
401
402         if (r_lastPossibleCageIndex) {
403                 /* ensure the value is initialized */
404                 *r_lastPossibleCageIndex = -1;
405         }
406
407         /* Find the last modifier acting on the cage. */
408         for (i = 0; md; i++, md = md->next) {
409                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
410                 bool supports_mapping;
411
412                 if (mti->isDisabled && mti->isDisabled(scene, md, 0)) continue;
413                 if (!(mti->flags & eModifierTypeFlag_SupportsEditmode)) continue;
414                 if (md->mode & eModifierMode_DisableTemporary) continue;
415
416                 supports_mapping = modifier_supportsMapping(md);
417                 if (r_lastPossibleCageIndex && supports_mapping) {
418                         *r_lastPossibleCageIndex = i;
419                 }
420
421                 if (!(md->mode & eModifierMode_Realtime)) continue;
422                 if (!(md->mode & eModifierMode_Editmode)) continue;
423
424                 if (!supports_mapping)
425                         break;
426
427                 if (md->mode & eModifierMode_OnCage)
428                         cageIndex = i;
429         }
430
431         return cageIndex;
432 }
433
434
435 bool modifiers_isSoftbodyEnabled(Object *ob)
436 {
437         ModifierData *md = modifiers_findByType(ob, eModifierType_Softbody);
438
439         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
440 }
441
442 bool modifiers_isClothEnabled(Object *ob)
443 {
444         ModifierData *md = modifiers_findByType(ob, eModifierType_Cloth);
445
446         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
447 }
448
449 bool modifiers_isModifierEnabled(Object *ob, int modifierType)
450 {
451         ModifierData *md = modifiers_findByType(ob, modifierType);
452
453         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
454 }
455
456 bool modifiers_isParticleEnabled(Object *ob)
457 {
458         ModifierData *md = modifiers_findByType(ob, eModifierType_ParticleSystem);
459
460         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
461 }
462
463 /**
464  * Check whether is enabled.
465  *
466  * \param scene: Current scene, may be NULL, in which case isDisabled callback of the modifier is never called.
467  */
468 bool modifier_isEnabled(const struct Scene *scene, ModifierData *md, int required_mode)
469 {
470         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
471
472         if ((md->mode & required_mode) != required_mode) return false;
473         if (scene != NULL && mti->isDisabled && mti->isDisabled(scene, md, required_mode == eModifierMode_Render)) return false;
474         if (md->mode & eModifierMode_DisableTemporary) return false;
475         if ((required_mode & eModifierMode_Editmode) && !(mti->flags & eModifierTypeFlag_SupportsEditmode)) return false;
476
477         return true;
478 }
479
480 CDMaskLink *modifiers_calcDataMasks(struct Scene *scene, Object *ob, ModifierData *md,
481                                     const CustomData_MeshMasks *dataMask, int required_mode,
482                                     ModifierData *previewmd, const CustomData_MeshMasks *previewmask)
483 {
484         CDMaskLink *dataMasks = NULL;
485         CDMaskLink *curr, *prev;
486
487         /* build a list of modifier data requirements in reverse order */
488         for (; md; md = md->next) {
489                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
490
491                 curr = MEM_callocN(sizeof(CDMaskLink), "CDMaskLink");
492
493                 if (modifier_isEnabled(scene, md, required_mode)) {
494                         if (mti->requiredDataMask)
495                                  mti->requiredDataMask(ob, md, &curr->mask);
496
497                         if (previewmd == md && previewmask != NULL) {
498                                 CustomData_MeshMasks_update(&curr->mask, previewmask);
499                         }
500                 }
501
502                 /* prepend new datamask */
503                 curr->next = dataMasks;
504                 dataMasks = curr;
505         }
506
507         /* build the list of required data masks - each mask in the list must
508          * include all elements of the masks that follow it
509          *
510          * note the list is currently in reverse order, so "masks that follow it"
511          * actually means "masks that precede it" at the moment
512          */
513         for (curr = dataMasks, prev = NULL; curr; prev = curr, curr = curr->next) {
514                 if (prev) {
515                         CustomData_MeshMasks_update(&curr->mask, &prev->mask);
516                 }
517                 else {
518                         CustomData_MeshMasks_update(&curr->mask, dataMask);
519                 }
520         }
521
522         /* reverse the list so it's in the correct order */
523         BLI_linklist_reverse((LinkNode **)&dataMasks);
524
525         return dataMasks;
526 }
527
528 ModifierData *modifiers_getLastPreview(struct Scene *scene, ModifierData *md, int required_mode)
529 {
530         ModifierData *tmp_md = NULL;
531
532         if ((required_mode & ~eModifierMode_Editmode) != eModifierMode_Realtime)
533                 return tmp_md;
534
535         /* Find the latest modifier in stack generating preview. */
536         for (; md; md = md->next) {
537                 if (modifier_isEnabled(scene, md, required_mode) && modifier_isPreview(md))
538                         tmp_md = md;
539         }
540         return tmp_md;
541 }
542
543 /* NOTE: This is to support old files from before Blender supported modifiers,
544  * in some cases versioning code updates these so for new files this will
545  * return an empty list. */
546 ModifierData *modifiers_getVirtualModifierList(Object *ob, VirtualModifierData *virtualModifierData)
547 {
548         ModifierData *md;
549
550         md = ob->modifiers.first;
551
552         *virtualModifierData = virtualModifierCommonData;
553
554         if (ob->parent) {
555                 if (ob->parent->type == OB_ARMATURE && ob->partype == PARSKEL) {
556                         virtualModifierData->amd.object = ob->parent;
557                         virtualModifierData->amd.modifier.next = md;
558                         virtualModifierData->amd.deformflag = ((bArmature *)(ob->parent->data))->deformflag;
559                         md = &virtualModifierData->amd.modifier;
560                 }
561                 else if (ob->parent->type == OB_CURVE && ob->partype == PARSKEL) {
562                         virtualModifierData->cmd.object = ob->parent;
563                         virtualModifierData->cmd.defaxis = ob->trackflag + 1;
564                         virtualModifierData->cmd.modifier.next = md;
565                         md = &virtualModifierData->cmd.modifier;
566                 }
567                 else if (ob->parent->type == OB_LATTICE && ob->partype == PARSKEL) {
568                         virtualModifierData->lmd.object = ob->parent;
569                         virtualModifierData->lmd.modifier.next = md;
570                         md = &virtualModifierData->lmd.modifier;
571                 }
572         }
573
574         /* shape key modifier, not yet for curves */
575         if (ELEM(ob->type, OB_MESH, OB_LATTICE) && BKE_key_from_object(ob)) {
576                 if (ob->type == OB_MESH && (ob->shapeflag & OB_SHAPE_EDIT_MODE))
577                         virtualModifierData->smd.modifier.mode |= eModifierMode_Editmode | eModifierMode_OnCage;
578                 else
579                         virtualModifierData->smd.modifier.mode &= ~eModifierMode_Editmode | eModifierMode_OnCage;
580
581                 virtualModifierData->smd.modifier.next = md;
582                 md = &virtualModifierData->smd.modifier;
583         }
584
585         return md;
586 }
587
588 /* Takes an object and returns its first selected armature, else just its armature
589  * This should work for multiple armatures per object
590  */
591 Object *modifiers_isDeformedByArmature(Object *ob)
592 {
593         VirtualModifierData virtualModifierData;
594         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
595         ArmatureModifierData *amd = NULL;
596
597         /* return the first selected armature, this lets us use multiple armatures */
598         for (; md; md = md->next) {
599                 if (md->type == eModifierType_Armature) {
600                         amd = (ArmatureModifierData *) md;
601                         if (amd->object && (amd->object->flag & SELECT))
602                                 return amd->object;
603                 }
604         }
605
606         if (amd) /* if were still here then return the last armature */
607                 return amd->object;
608
609         return NULL;
610 }
611
612 Object *modifiers_isDeformedByMeshDeform(Object *ob)
613 {
614         VirtualModifierData virtualModifierData;
615         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
616         MeshDeformModifierData *mdmd = NULL;
617
618         /* return the first selected armature, this lets us use multiple armatures */
619         for (; md; md = md->next) {
620                 if (md->type == eModifierType_MeshDeform) {
621                         mdmd = (MeshDeformModifierData *) md;
622                         if (mdmd->object && (mdmd->object->flag & SELECT))
623                                 return mdmd->object;
624                 }
625         }
626
627         if (mdmd) /* if were still here then return the last armature */
628                 return mdmd->object;
629
630         return NULL;
631 }
632
633 /* Takes an object and returns its first selected lattice, else just its lattice
634  * This should work for multiple lattices per object
635  */
636 Object *modifiers_isDeformedByLattice(Object *ob)
637 {
638         VirtualModifierData virtualModifierData;
639         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
640         LatticeModifierData *lmd = NULL;
641
642         /* return the first selected lattice, this lets us use multiple lattices */
643         for (; md; md = md->next) {
644                 if (md->type == eModifierType_Lattice) {
645                         lmd = (LatticeModifierData *) md;
646                         if (lmd->object && (lmd->object->flag & SELECT))
647                                 return lmd->object;
648                 }
649         }
650
651         if (lmd) /* if were still here then return the last lattice */
652                 return lmd->object;
653
654         return NULL;
655 }
656
657 /* Takes an object and returns its first selected curve, else just its curve
658  * This should work for multiple curves per object
659  */
660 Object *modifiers_isDeformedByCurve(Object *ob)
661 {
662         VirtualModifierData virtualModifierData;
663         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
664         CurveModifierData *cmd = NULL;
665
666         /* return the first selected curve, this lets us use multiple curves */
667         for (; md; md = md->next) {
668                 if (md->type == eModifierType_Curve) {
669                         cmd = (CurveModifierData *) md;
670                         if (cmd->object && (cmd->object->flag & SELECT))
671                                 return cmd->object;
672                 }
673         }
674
675         if (cmd) /* if were still here then return the last curve */
676                 return cmd->object;
677
678         return NULL;
679 }
680
681 bool modifiers_usesArmature(Object *ob, bArmature *arm)
682 {
683         VirtualModifierData virtualModifierData;
684         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
685
686         for (; md; md = md->next) {
687                 if (md->type == eModifierType_Armature) {
688                         ArmatureModifierData *amd = (ArmatureModifierData *) md;
689                         if (amd->object && amd->object->data == arm)
690                                 return true;
691                 }
692         }
693
694         return false;
695 }
696
697 bool modifier_isCorrectableDeformed(ModifierData *md)
698 {
699         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
700         return mti->deformMatricesEM != NULL;
701 }
702
703 bool modifiers_isCorrectableDeformed(struct Scene *scene, Object *ob)
704 {
705         VirtualModifierData virtualModifierData;
706         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
707         int required_mode = eModifierMode_Realtime;
708
709         if (ob->mode == OB_MODE_EDIT) {
710                 required_mode |= eModifierMode_Editmode;
711         }
712         for (; md; md = md->next) {
713                 if (!modifier_isEnabled(scene, md, required_mode)) {
714                         /* pass */
715                 }
716                 else if (modifier_isCorrectableDeformed(md)) {
717                         return true;
718                 }
719         }
720         return false;
721 }
722
723 /* Check whether the given object has a modifier in its stack that uses WEIGHT_MCOL CD layer
724  * to preview something... Used by DynamicPaint and WeightVG currently. */
725 bool modifiers_isPreview(Object *ob)
726 {
727         ModifierData *md = ob->modifiers.first;
728
729         for (; md; md = md->next) {
730                 if (modifier_isPreview(md))
731                         return true;
732         }
733
734         return false;
735 }
736
737 void modifier_freeTemporaryData(ModifierData *md)
738 {
739         if (md->type == eModifierType_Armature) {
740                 ArmatureModifierData *amd = (ArmatureModifierData *)md;
741
742                 if (amd->prevCos) {
743                         MEM_freeN(amd->prevCos);
744                         amd->prevCos = NULL;
745                 }
746         }
747 }
748
749 /* ensure modifier correctness when changing ob->data */
750 void test_object_modifiers(Object *ob)
751 {
752         ModifierData *md;
753
754         /* just multires checked for now, since only multires
755          * modifies mesh data */
756
757         if (ob->type != OB_MESH) return;
758
759         for (md = ob->modifiers.first; md; md = md->next) {
760                 if (md->type == eModifierType_Multires) {
761                         MultiresModifierData *mmd = (MultiresModifierData *)md;
762
763                         multiresModifier_set_levels_from_disps(mmd, ob);
764                 }
765         }
766 }
767
768 /* where should this go?, it doesn't fit well anywhere :S - campbell */
769
770 /* elubie: changed this to default to the same dir as the render output
771  * to prevent saving to C:\ on Windows */
772
773 /* campbell: logic behind this...
774  *
775  * - if the ID is from a library, return library path
776  * - else if the file has been saved return the blend file path.
777  * - else if the file isn't saved and the ID isn't from a library, return the temp dir.
778  */
779 const char *modifier_path_relbase(Main *bmain, Object *ob)
780 {
781         if (G.relbase_valid || ID_IS_LINKED(ob)) {
782                 return ID_BLEND_PATH(bmain, &ob->id);
783         }
784         else {
785                 /* last resort, better then using "" which resolves to the current
786                  * working directory */
787                 return BKE_tempdir_session();
788         }
789 }
790
791 const char *modifier_path_relbase_from_global(Object *ob)
792 {
793         if (G.relbase_valid || ID_IS_LINKED(ob)) {
794                 return ID_BLEND_PATH_FROM_GLOBAL(&ob->id);
795         }
796         else {
797                 /* last resort, better then using "" which resolves to the current
798                  * working directory */
799                 return BKE_tempdir_session();
800         }
801 }
802
803 /* initializes the path with either */
804 void modifier_path_init(char *path, int path_maxlen, const char *name)
805 {
806         /* elubie: changed this to default to the same dir as the render output
807          * to prevent saving to C:\ on Windows */
808         BLI_join_dirfile(path, path_maxlen,
809                          G.relbase_valid ? "//" : BKE_tempdir_session(),
810                          name);
811 }
812
813
814 /* wrapper around ModifierTypeInfo.applyModifier that ensures valid normals */
815
816 struct Mesh *modwrap_applyModifier(
817         ModifierData *md, const ModifierEvalContext *ctx,
818         struct Mesh *me)
819 {
820         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
821         BLI_assert(CustomData_has_layer(&me->pdata, CD_NORMAL) == false);
822
823         if (mti->dependsOnNormals && mti->dependsOnNormals(md)) {
824                 BKE_mesh_calc_normals(me);
825         }
826         return mti->applyModifier(md, ctx, me);
827 }
828
829 void modwrap_deformVerts(
830         ModifierData *md, const ModifierEvalContext *ctx,
831         Mesh *me, float (*vertexCos)[3], int numVerts)
832 {
833         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
834         BLI_assert(!me || CustomData_has_layer(&me->pdata, CD_NORMAL) == false);
835
836         if (me && mti->dependsOnNormals && mti->dependsOnNormals(md)) {
837                 BKE_mesh_calc_normals(me);
838         }
839         mti->deformVerts(md, ctx, me, vertexCos, numVerts);
840 }
841
842 void modwrap_deformVertsEM(
843         ModifierData *md, const ModifierEvalContext *ctx,
844         struct BMEditMesh *em, Mesh *me,
845         float (*vertexCos)[3], int numVerts)
846 {
847         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
848         BLI_assert(!me || CustomData_has_layer(&me->pdata, CD_NORMAL) == false);
849
850         if (me && mti->dependsOnNormals && mti->dependsOnNormals(md)) {
851                 BKE_mesh_calc_normals(me);
852         }
853         mti->deformVertsEM(md, ctx, em, me, vertexCos, numVerts);
854 }
855
856 /* end modifier callback wrappers */
857
858
859 /* wrappers for modifier callbacks that accept Mesh and select the proper implementation
860  * depending on if the modifier has been ported to Mesh or is still using DerivedMesh
861  */
862
863 /* deprecated variants of above that accept DerivedMesh */
864
865 struct DerivedMesh *modifier_applyModifier_DM_deprecated(
866         struct ModifierData *md, const ModifierEvalContext *ctx,
867         struct DerivedMesh *dm)
868 {
869         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
870
871         /* TODO(sybren): deduplicate all the copies of this code in this file. */
872         Mesh *mesh = NULL;
873         if (dm != NULL) {
874                 mesh = BKE_id_new_nomain(ID_ME, NULL);
875                 DM_to_mesh(dm, mesh, ctx->object, &CD_MASK_EVERYTHING, false);
876         }
877
878         struct Mesh *new_mesh = mti->applyModifier(md, ctx, mesh);
879
880         /* Make a DM that doesn't reference new_mesh so we can free the latter. */
881         DerivedMesh *ndm = CDDM_from_mesh_ex(new_mesh, CD_DUPLICATE, &CD_MASK_EVERYTHING);
882
883         if (new_mesh != mesh) {
884                 BKE_id_free(NULL, new_mesh);
885         }
886         if (mesh != NULL) {
887                 BKE_id_free(NULL, mesh);
888         }
889
890         return ndm;
891
892 }
893
894 /**
895  * Get evaluated mesh for other evaluated object, which is used as an operand for the modifier,
896  * e.g. second operand for boolean modifier.
897  * Note that modifiers in stack always get fully evaluated COW ID pointers, never original ones. Makes things simpler.
898  *
899  * \param get_cage_mesh Return evaluated mesh with only deforming modifiers applied
900  *                      (i.e. mesh topology remains the same as original one, a.k.a. 'cage' mesh).
901  */
902 Mesh *BKE_modifier_get_evaluated_mesh_from_evaluated_object(Object *ob_eval, const bool get_cage_mesh)
903 {
904         Mesh *me = NULL;
905
906         if ((ob_eval->type == OB_MESH) && (ob_eval->mode & OB_MODE_EDIT)) {
907                 /* In EditMode, evaluated mesh is stored in BMEditMesh, not the object... */
908                 BMEditMesh *em = BKE_editmesh_from_object(ob_eval);
909                 if (em != NULL) {  /* em might not exist yet in some cases, just after loading a .blend file, see T57878. */
910                         me = (get_cage_mesh && em->mesh_eval_cage != NULL) ? em->mesh_eval_cage : em->mesh_eval_final;
911                 }
912         }
913         if (me == NULL) {
914                 me = (get_cage_mesh && ob_eval->runtime.mesh_deform_eval != NULL) ? ob_eval->runtime.mesh_deform_eval :
915                                                                                     ob_eval->runtime.mesh_eval;
916         }
917
918         return me;
919 }