Fix build error on Windows 32 bit.
[blender-staging.git] / source / blender / blenkernel / intern / modifier.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 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Dunbar
22  *                 Ton Roosendaal,
23  *                 Ben Batt,
24  *                 Brecht Van Lommel,
25  *                 Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  * Modifier stack implementation.
30  *
31  * BKE_modifier.h contains the function prototypes for this file.
32  *
33  */
34
35 /** \file blender/blenkernel/intern/modifier.c
36  *  \ingroup bke
37  */
38
39 #include <stdlib.h>
40 #include <stddef.h>
41 #include <string.h>
42 #include <stdarg.h>
43 #include <math.h>
44 #include <float.h>
45
46 #include "MEM_guardedalloc.h"
47
48 #include "DNA_armature_types.h"
49 #include "DNA_object_types.h"
50
51 #include "BLI_utildefines.h"
52 #include "BLI_listbase.h"
53 #include "BLI_linklist.h"
54 #include "BLI_path_util.h"
55 #include "BLI_string.h"
56 #include "BLI_string_utils.h"
57
58 #include "BLT_translation.h"
59
60 #include "BKE_appdir.h"
61 #include "BKE_key.h"
62 #include "BKE_library.h"
63 #include "BKE_library_query.h"
64 #include "BKE_multires.h"
65 #include "BKE_DerivedMesh.h"
66
67 /* may move these, only for modifier_path_relbase */
68 #include "BKE_global.h" /* ugh, G.main->name only */
69 #include "BKE_main.h"
70 /* end */
71
72 #include "MOD_modifiertypes.h"
73
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
131         if (mti->flags & eModifierTypeFlag_EnableInEditmode)
132                 md->mode |= eModifierMode_Editmode;
133
134         if (mti->initData) mti->initData(md);
135
136         return md;
137 }
138
139 void modifier_free(ModifierData *md) 
140 {
141         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
142
143         if (mti->freeData) mti->freeData(md);
144         if (md->error) MEM_freeN(md->error);
145
146         MEM_freeN(md);
147 }
148
149 bool modifier_unique_name(ListBase *modifiers, ModifierData *md)
150 {
151         if (modifiers && md) {
152                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
153
154                 return BLI_uniquename(modifiers, md, DATA_(mti->name), '.', offsetof(ModifierData, name), sizeof(md->name));
155         }
156         return false;
157 }
158
159 bool modifier_dependsOnTime(ModifierData *md)
160 {
161         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
162
163         return mti->dependsOnTime && mti->dependsOnTime(md);
164 }
165
166 bool modifier_supportsMapping(ModifierData *md)
167 {
168         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
169
170         return (mti->type == eModifierTypeType_OnlyDeform ||
171                 (mti->flags & eModifierTypeFlag_SupportsMapping));
172 }
173
174 bool modifier_isPreview(ModifierData *md)
175 {
176         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
177
178         /* Constructive modifiers are highly likely to also modify data like vgroups or vcol! */
179         if (!((mti->flags & eModifierTypeFlag_UsesPreview) || (mti->type == eModifierTypeType_Constructive))) {
180                 return false;
181         }
182
183         if (md->mode & eModifierMode_Realtime) {
184                 return true;
185         }
186
187         return false;
188 }
189
190 ModifierData *modifiers_findByType(Object *ob, ModifierType type)
191 {
192         ModifierData *md = ob->modifiers.first;
193
194         for (; md; md = md->next)
195                 if (md->type == type)
196                         break;
197
198         return md;
199 }
200
201 ModifierData *modifiers_findByName(Object *ob, const char *name)
202 {
203         return BLI_findstring(&(ob->modifiers), name, offsetof(ModifierData, name));
204 }
205
206 void modifiers_clearErrors(Object *ob)
207 {
208         ModifierData *md = ob->modifiers.first;
209         /* int qRedraw = 0; */
210
211         for (; md; md = md->next) {
212                 if (md->error) {
213                         MEM_freeN(md->error);
214                         md->error = NULL;
215
216                         /* qRedraw = 1; */
217                 }
218         }
219 }
220
221 void modifiers_foreachObjectLink(Object *ob, ObjectWalkFunc walk, void *userData)
222 {
223         ModifierData *md = ob->modifiers.first;
224
225         for (; md; md = md->next) {
226                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
227
228                 if (mti->foreachObjectLink)
229                         mti->foreachObjectLink(md, ob, walk, userData);
230         }
231 }
232
233 void modifiers_foreachIDLink(Object *ob, IDWalkFunc walk, void *userData)
234 {
235         ModifierData *md = ob->modifiers.first;
236
237         for (; md; md = md->next) {
238                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
239
240                 if (mti->foreachIDLink) mti->foreachIDLink(md, ob, walk, userData);
241                 else if (mti->foreachObjectLink) {
242                         /* each Object can masquerade as an ID, so this should be OK */
243                         ObjectWalkFunc fp = (ObjectWalkFunc)walk;
244                         mti->foreachObjectLink(md, ob, fp, userData);
245                 }
246         }
247 }
248
249 void modifiers_foreachTexLink(Object *ob, TexWalkFunc walk, void *userData)
250 {
251         ModifierData *md = ob->modifiers.first;
252
253         for (; md; md = md->next) {
254                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
255
256                 if (mti->foreachTexLink)
257                         mti->foreachTexLink(md, ob, walk, userData);
258         }
259 }
260
261 /* callback's can use this
262  * to avoid copying every member.
263  */
264 void modifier_copyData_generic(const ModifierData *md_src, ModifierData *md_dst)
265 {
266         const ModifierTypeInfo *mti = modifierType_getInfo(md_src->type);
267         const size_t data_size = sizeof(ModifierData);
268         const char *md_src_data = ((const char *)md_src) + data_size;
269         char       *md_dst_data =       ((char *)md_dst) + data_size;
270         BLI_assert(data_size <= (size_t)mti->structSize);
271         memcpy(md_dst_data, md_src_data, (size_t)mti->structSize - data_size);
272 }
273
274 static void modifier_copy_data_id_us_cb(void *UNUSED(userData), Object *UNUSED(ob), ID **idpoin, int cb_flag)
275 {
276         ID *id = *idpoin;
277         if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
278                 id_us_plus(id);
279         }
280 }
281
282 void modifier_copyData_ex(ModifierData *md, ModifierData *target, const int flag)
283 {
284         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
285
286         target->mode = md->mode;
287
288         if (mti->copyData) {
289                 mti->copyData(md, target);
290         }
291
292         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
293                 if (mti->foreachIDLink) {
294                         mti->foreachIDLink(target, NULL, modifier_copy_data_id_us_cb, NULL);
295                 }
296                 else if (mti->foreachObjectLink) {
297                         mti->foreachObjectLink(target, NULL, (ObjectWalkFunc)modifier_copy_data_id_us_cb, NULL);
298                 }
299         }
300 }
301
302 void modifier_copyData(ModifierData *md, ModifierData *target)
303 {
304         modifier_copyData_ex(md, target, 0);
305 }
306
307
308 bool modifier_supportsCage(struct Scene *scene, ModifierData *md)
309 {
310         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
311
312         md->scene = scene;
313
314         return ((!mti->isDisabled || !mti->isDisabled(md, 0)) &&
315                 (mti->flags & eModifierTypeFlag_SupportsEditmode) &&
316                 modifier_supportsMapping(md));
317 }
318
319 bool modifier_couldBeCage(struct Scene *scene, ModifierData *md)
320 {
321         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
322
323         md->scene = scene;
324
325         return ((md->mode & eModifierMode_Realtime) &&
326                 (md->mode & eModifierMode_Editmode) &&
327                 (!mti->isDisabled || !mti->isDisabled(md, 0)) &&
328                 modifier_supportsMapping(md));
329 }
330
331 bool modifier_isSameTopology(ModifierData *md)
332 {
333         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
334         return ELEM(mti->type, eModifierTypeType_OnlyDeform, eModifierTypeType_NonGeometrical);
335 }
336
337 bool modifier_isNonGeometrical(ModifierData *md)
338 {
339         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
340         return (mti->type == eModifierTypeType_NonGeometrical);
341 }
342
343 void modifier_setError(ModifierData *md, const char *_format, ...)
344 {
345         char buffer[512];
346         va_list ap;
347         const char *format = TIP_(_format);
348
349         va_start(ap, _format);
350         vsnprintf(buffer, sizeof(buffer), format, ap);
351         va_end(ap);
352         buffer[sizeof(buffer) - 1] = '\0';
353
354         if (md->error)
355                 MEM_freeN(md->error);
356
357         md->error = BLI_strdup(buffer);
358
359 }
360
361 /* used for buttons, to find out if the 'draw deformed in editmode' option is
362  * there
363  * 
364  * also used in transform_conversion.c, to detect CrazySpace [tm] (2nd arg
365  * then is NULL) 
366  * also used for some mesh tools to give warnings
367  */
368 int modifiers_getCageIndex(struct Scene *scene, Object *ob, int *r_lastPossibleCageIndex, bool is_virtual)
369 {
370         VirtualModifierData virtualModifierData;
371         ModifierData *md = (is_virtual) ? modifiers_getVirtualModifierList(ob, &virtualModifierData) : ob->modifiers.first;
372         int i, cageIndex = -1;
373
374         if (r_lastPossibleCageIndex) {
375                 /* ensure the value is initialized */
376                 *r_lastPossibleCageIndex = -1;
377         }
378
379         /* Find the last modifier acting on the cage. */
380         for (i = 0; md; i++, md = md->next) {
381                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
382                 bool supports_mapping;
383
384                 md->scene = scene;
385
386                 if (mti->isDisabled && mti->isDisabled(md, 0)) continue;
387                 if (!(mti->flags & eModifierTypeFlag_SupportsEditmode)) continue;
388                 if (md->mode & eModifierMode_DisableTemporary) continue;
389
390                 supports_mapping = modifier_supportsMapping(md);
391                 if (r_lastPossibleCageIndex && supports_mapping) {
392                         *r_lastPossibleCageIndex = i;
393                 }
394
395                 if (!(md->mode & eModifierMode_Realtime)) continue;
396                 if (!(md->mode & eModifierMode_Editmode)) continue;
397
398                 if (!supports_mapping)
399                         break;
400
401                 if (md->mode & eModifierMode_OnCage)
402                         cageIndex = i;
403         }
404
405         return cageIndex;
406 }
407
408
409 bool modifiers_isSoftbodyEnabled(Object *ob)
410 {
411         ModifierData *md = modifiers_findByType(ob, eModifierType_Softbody);
412
413         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
414 }
415
416 bool modifiers_isClothEnabled(Object *ob)
417 {
418         ModifierData *md = modifiers_findByType(ob, eModifierType_Cloth);
419
420         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
421 }
422
423 bool modifiers_isModifierEnabled(Object *ob, int modifierType)
424 {
425         ModifierData *md = modifiers_findByType(ob, modifierType);
426
427         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
428 }
429
430 bool modifiers_isParticleEnabled(Object *ob)
431 {
432         ModifierData *md = modifiers_findByType(ob, eModifierType_ParticleSystem);
433
434         return (md && md->mode & (eModifierMode_Realtime | eModifierMode_Render));
435 }
436
437 /**
438  * Check whether is enabled.
439  *
440  * \param scene Current scene, may be NULL, in which case isDisabled callback of the modifier is never called.
441  */
442 bool modifier_isEnabled(struct Scene *scene, ModifierData *md, int required_mode)
443 {
444         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
445
446         md->scene = scene;
447
448         if ((md->mode & required_mode) != required_mode) return false;
449         if (scene != NULL && mti->isDisabled && mti->isDisabled(md, required_mode == eModifierMode_Render)) return false;
450         if (md->mode & eModifierMode_DisableTemporary) return false;
451         if ((required_mode & eModifierMode_Editmode) && !(mti->flags & eModifierTypeFlag_SupportsEditmode)) return false;
452         
453         return true;
454 }
455
456 CDMaskLink *modifiers_calcDataMasks(struct Scene *scene, Object *ob, ModifierData *md,
457                                     CustomDataMask dataMask, int required_mode,
458                                     ModifierData *previewmd, CustomDataMask previewmask)
459 {
460         CDMaskLink *dataMasks = NULL;
461         CDMaskLink *curr, *prev;
462
463         /* build a list of modifier data requirements in reverse order */
464         for (; md; md = md->next) {
465                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
466
467                 curr = MEM_callocN(sizeof(CDMaskLink), "CDMaskLink");
468                 
469                 if (modifier_isEnabled(scene, md, required_mode)) {
470                         if (mti->requiredDataMask)
471                                 curr->mask = mti->requiredDataMask(ob, md);
472
473                         if (previewmd == md) {
474                                 curr->mask |= previewmask;
475                         }
476                 }
477
478                 /* prepend new datamask */
479                 curr->next = dataMasks;
480                 dataMasks = curr;
481         }
482
483         /* build the list of required data masks - each mask in the list must
484          * include all elements of the masks that follow it
485          *
486          * note the list is currently in reverse order, so "masks that follow it"
487          * actually means "masks that precede it" at the moment
488          */
489         for (curr = dataMasks, prev = NULL; curr; prev = curr, curr = curr->next) {
490                 if (prev) {
491                         CustomDataMask prev_mask = prev->mask;
492                         CustomDataMask curr_mask = curr->mask;
493
494                         curr->mask = curr_mask | prev_mask;
495                 }
496                 else {
497                         CustomDataMask curr_mask = curr->mask;
498
499                         curr->mask = curr_mask | dataMask;
500                 }
501         }
502
503         /* reverse the list so it's in the correct order */
504         BLI_linklist_reverse((LinkNode **)&dataMasks);
505
506         return dataMasks;
507 }
508
509 ModifierData *modifiers_getLastPreview(struct Scene *scene, ModifierData *md, int required_mode)
510 {
511         ModifierData *tmp_md = NULL;
512
513         if ((required_mode & ~eModifierMode_Editmode) != eModifierMode_Realtime)
514                 return tmp_md;
515
516         /* Find the latest modifier in stack generating preview. */
517         for (; md; md = md->next) {
518                 if (modifier_isEnabled(scene, md, required_mode) && modifier_isPreview(md))
519                         tmp_md = md;
520         }
521         return tmp_md;
522 }
523
524 /* NOTE: This is to support old files from before Blender supported modifiers,
525  * in some cases versioning code updates these so for new files this will
526  * return an empty list. */
527 ModifierData *modifiers_getVirtualModifierList(Object *ob, VirtualModifierData *virtualModifierData)
528 {
529         ModifierData *md;
530
531         md = ob->modifiers.first;
532
533         *virtualModifierData = virtualModifierCommonData;
534
535         if (ob->parent) {
536                 if (ob->parent->type == OB_ARMATURE && ob->partype == PARSKEL) {
537                         virtualModifierData->amd.object = ob->parent;
538                         virtualModifierData->amd.modifier.next = md;
539                         virtualModifierData->amd.deformflag = ((bArmature *)(ob->parent->data))->deformflag;
540                         md = &virtualModifierData->amd.modifier;
541                 }
542                 else if (ob->parent->type == OB_CURVE && ob->partype == PARSKEL) {
543                         virtualModifierData->cmd.object = ob->parent;
544                         virtualModifierData->cmd.defaxis = ob->trackflag + 1;
545                         virtualModifierData->cmd.modifier.next = md;
546                         md = &virtualModifierData->cmd.modifier;
547                 }
548                 else if (ob->parent->type == OB_LATTICE && ob->partype == PARSKEL) {
549                         virtualModifierData->lmd.object = ob->parent;
550                         virtualModifierData->lmd.modifier.next = md;
551                         md = &virtualModifierData->lmd.modifier;
552                 }
553         }
554
555         /* shape key modifier, not yet for curves */
556         if (ELEM(ob->type, OB_MESH, OB_LATTICE) && BKE_key_from_object(ob)) {
557                 if (ob->type == OB_MESH && (ob->shapeflag & OB_SHAPE_EDIT_MODE))
558                         virtualModifierData->smd.modifier.mode |= eModifierMode_Editmode | eModifierMode_OnCage;
559                 else
560                         virtualModifierData->smd.modifier.mode &= ~eModifierMode_Editmode | eModifierMode_OnCage;
561
562                 virtualModifierData->smd.modifier.next = md;
563                 md = &virtualModifierData->smd.modifier;
564         }
565
566         return md;
567 }
568
569 /* Takes an object and returns its first selected armature, else just its armature
570  * This should work for multiple armatures per object
571  */
572 Object *modifiers_isDeformedByArmature(Object *ob)
573 {
574         VirtualModifierData virtualModifierData;
575         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
576         ArmatureModifierData *amd = NULL;
577         
578         /* return the first selected armature, this lets us use multiple armatures */
579         for (; md; md = md->next) {
580                 if (md->type == eModifierType_Armature) {
581                         amd = (ArmatureModifierData *) md;
582                         if (amd->object && (amd->object->flag & SELECT))
583                                 return amd->object;
584                 }
585         }
586         
587         if (amd) /* if were still here then return the last armature */
588                 return amd->object;
589         
590         return NULL;
591 }
592
593 /* Takes an object and returns its first selected lattice, else just its lattice
594  * This should work for multiple lattices per object
595  */
596 Object *modifiers_isDeformedByLattice(Object *ob)
597 {
598         VirtualModifierData virtualModifierData;
599         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
600         LatticeModifierData *lmd = NULL;
601         
602         /* return the first selected lattice, this lets us use multiple lattices */
603         for (; md; md = md->next) {
604                 if (md->type == eModifierType_Lattice) {
605                         lmd = (LatticeModifierData *) md;
606                         if (lmd->object && (lmd->object->flag & SELECT))
607                                 return lmd->object;
608                 }
609         }
610         
611         if (lmd) /* if were still here then return the last lattice */
612                 return lmd->object;
613         
614         return NULL;
615 }
616
617 /* Takes an object and returns its first selected curve, else just its curve
618  * This should work for multiple curves per object
619  */
620 Object *modifiers_isDeformedByCurve(Object *ob)
621 {
622         VirtualModifierData virtualModifierData;
623         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
624         CurveModifierData *cmd = NULL;
625         
626         /* return the first selected curve, this lets us use multiple curves */
627         for (; md; md = md->next) {
628                 if (md->type == eModifierType_Curve) {
629                         cmd = (CurveModifierData *) md;
630                         if (cmd->object && (cmd->object->flag & SELECT))
631                                 return cmd->object;
632                 }
633         }
634         
635         if (cmd) /* if were still here then return the last curve */
636                 return cmd->object;
637         
638         return NULL;
639 }
640
641 bool modifiers_usesArmature(Object *ob, bArmature *arm)
642 {
643         VirtualModifierData virtualModifierData;
644         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
645
646         for (; md; md = md->next) {
647                 if (md->type == eModifierType_Armature) {
648                         ArmatureModifierData *amd = (ArmatureModifierData *) md;
649                         if (amd->object && amd->object->data == arm)
650                                 return true;
651                 }
652         }
653
654         return false;
655 }
656
657 bool modifier_isCorrectableDeformed(ModifierData *md)
658 {
659         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
660         return (mti->deformMatricesEM != NULL);
661 }
662
663 bool modifiers_isCorrectableDeformed(struct Scene *scene, Object *ob)
664 {
665         VirtualModifierData virtualModifierData;
666         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
667         int required_mode = eModifierMode_Realtime;
668
669         if (ob->mode == OB_MODE_EDIT)
670                 required_mode |= eModifierMode_Editmode;
671         
672         for (; md; md = md->next) {
673                 if (!modifier_isEnabled(scene, md, required_mode)) {
674                         /* pass */
675                 }
676                 else if (modifier_isCorrectableDeformed(md)) {
677                         return true;
678                 }
679         }
680         return false;
681 }
682
683 /* Check whether the given object has a modifier in its stack that uses WEIGHT_MCOL CD layer
684  * to preview something... Used by DynamicPaint and WeightVG currently. */
685 bool modifiers_isPreview(Object *ob)
686 {
687         ModifierData *md = ob->modifiers.first;
688
689         for (; md; md = md->next) {
690                 if (modifier_isPreview(md))
691                         return true;
692         }
693
694         return false;
695 }
696
697 void modifier_freeTemporaryData(ModifierData *md)
698 {
699         if (md->type == eModifierType_Armature) {
700                 ArmatureModifierData *amd = (ArmatureModifierData *)md;
701
702                 if (amd->prevCos) {
703                         MEM_freeN(amd->prevCos);
704                         amd->prevCos = NULL;
705                 }
706         }
707 }
708
709 /* ensure modifier correctness when changing ob->data */
710 void test_object_modifiers(Object *ob)
711 {
712         ModifierData *md;
713
714         /* just multires checked for now, since only multires
715          * modifies mesh data */
716
717         if (ob->type != OB_MESH) return;
718
719         for (md = ob->modifiers.first; md; md = md->next) {
720                 if (md->type == eModifierType_Multires) {
721                         MultiresModifierData *mmd = (MultiresModifierData *)md;
722
723                         multiresModifier_set_levels_from_disps(mmd, ob);
724                 }
725         }
726 }
727
728 /* where should this go?, it doesnt fit well anywhere :S - campbell */
729
730 /* elubie: changed this to default to the same dir as the render output
731  * to prevent saving to C:\ on Windows */
732
733 /* campbell: logic behind this...
734  *
735  * - if the ID is from a library, return library path
736  * - else if the file has been saved return the blend file path.
737  * - else if the file isn't saved and the ID isn't from a library, return the temp dir.
738  */
739 const char *modifier_path_relbase(Object *ob)
740 {
741         if (G.relbase_valid || ID_IS_LINKED(ob)) {
742                 return ID_BLEND_PATH(G.main, &ob->id);
743         }
744         else {
745                 /* last resort, better then using "" which resolves to the current
746                  * working directory */
747                 return BKE_tempdir_session();
748         }
749 }
750
751 /* initializes the path with either */
752 void modifier_path_init(char *path, int path_maxlen, const char *name)
753 {
754         /* elubie: changed this to default to the same dir as the render output
755          * to prevent saving to C:\ on Windows */
756         BLI_join_dirfile(path, path_maxlen,
757                          G.relbase_valid ? "//" : BKE_tempdir_session(),
758                          name);
759 }
760
761
762 /* wrapper around ModifierTypeInfo.applyModifier that ensures valid normals */
763
764 struct DerivedMesh *modwrap_applyModifier(
765         ModifierData *md, Object *ob,
766         struct DerivedMesh *dm,
767         ModifierApplyFlag flag)
768 {
769         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
770         BLI_assert(CustomData_has_layer(&dm->polyData, CD_NORMAL) == false);
771
772         if (mti->dependsOnNormals && mti->dependsOnNormals(md)) {
773                 DM_ensure_normals(dm);
774         }
775         return mti->applyModifier(md, ob, dm, flag);
776 }
777
778 struct DerivedMesh *modwrap_applyModifierEM(
779         ModifierData *md, Object *ob,
780         struct BMEditMesh *em,
781         DerivedMesh *dm,
782         ModifierApplyFlag flag)
783 {
784         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
785         BLI_assert(CustomData_has_layer(&dm->polyData, CD_NORMAL) == false);
786
787         if (mti->dependsOnNormals && mti->dependsOnNormals(md)) {
788                 DM_ensure_normals(dm);
789         }
790         return mti->applyModifierEM(md, ob, em, dm, flag);
791 }
792
793 void modwrap_deformVerts(
794         ModifierData *md, Object *ob,
795         DerivedMesh *dm,
796         float (*vertexCos)[3], int numVerts,
797         ModifierApplyFlag flag)
798 {
799         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
800         BLI_assert(!dm || CustomData_has_layer(&dm->polyData, CD_NORMAL) == false);
801
802         if (dm && mti->dependsOnNormals && mti->dependsOnNormals(md)) {
803                 DM_ensure_normals(dm);
804         }
805         mti->deformVerts(md, ob, dm, vertexCos, numVerts, flag);
806 }
807
808 void modwrap_deformVertsEM(
809         ModifierData *md, Object *ob,
810         struct BMEditMesh *em, DerivedMesh *dm,
811         float (*vertexCos)[3], int numVerts)
812 {
813         const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
814         BLI_assert(!dm || CustomData_has_layer(&dm->polyData, CD_NORMAL) == false);
815
816         if (dm && mti->dependsOnNormals && mti->dependsOnNormals(md)) {
817                 DM_ensure_normals(dm);
818         }
819         mti->deformVertsEM(md, ob, em, dm, vertexCos, numVerts);
820 }
821 /* end modifier callback wrappers */