Fix modifier freeing code re. ID refcounting.
[blender.git] / source / blender / modifiers / intern / MOD_weightvgmix.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) 2011 by Bastien Montagne.
19  * All rights reserved.
20  *
21  * Contributor(s): None yet.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  *
25  */
26
27 /** \file blender/modifiers/intern/MOD_weightvgmix.c
28  *  \ingroup modifiers
29  */
30
31 #include "BLI_utildefines.h"
32 #include "BLI_math.h"
33 #include "BLI_listbase.h"
34
35 #include "DNA_meshdata_types.h"
36 #include "DNA_modifier_types.h"
37 #include "DNA_object_types.h"
38
39 #include "BKE_cdderivedmesh.h"
40 #include "BKE_deform.h"
41 #include "BKE_library.h"
42 #include "BKE_library_query.h"
43 #include "BKE_modifier.h"
44 #include "BKE_texture.h"          /* Texture masking. */
45
46 #include "depsgraph_private.h"
47 #include "DEG_depsgraph_build.h"
48
49 #include "MEM_guardedalloc.h"
50
51 #include "MOD_weightvg_util.h"
52 #include "MOD_modifiertypes.h"
53
54
55 /**
56  * This mixes the old weight with the new weight factor.
57  */
58 static float mix_weight(float weight, float weight2, char mix_mode)
59 {
60 #if 0
61         /*
62          * XXX Don't know why, but the switch version takes many CPU time,
63          *     and produces lag in realtime playback...
64          */
65         switch (mix_mode)
66         {
67                 case MOD_WVG_MIX_ADD:
68                         return (weight + weight2);
69                 case MOD_WVG_MIX_SUB:
70                         return (weight - weight2);
71                 case MOD_WVG_MIX_MUL:
72                         return (weight * weight2);
73                 case MOD_WVG_MIX_DIV:
74                         /* Avoid dividing by zero (or really small values). */
75                         if (0.0 <= weight2 < MOD_WVG_ZEROFLOOR)
76                                 weight2 = MOD_WVG_ZEROFLOOR;
77                         else if (-MOD_WVG_ZEROFLOOR < weight2)
78                                 weight2 = -MOD_WVG_ZEROFLOOR;
79                         return (weight / weight2);
80                 case MOD_WVG_MIX_DIF:
81                         return (weight < weight2 ? weight2 - weight : weight - weight2);
82                 case MOD_WVG_MIX_AVG:
83                         return (weight + weight2) / 2.0;
84                 case MOD_WVG_MIX_SET:
85                 default:
86                         return weight2;
87         }
88 #endif
89         if (mix_mode == MOD_WVG_MIX_SET)
90                 return weight2;
91         else if (mix_mode == MOD_WVG_MIX_ADD)
92                 return (weight + weight2);
93         else if (mix_mode == MOD_WVG_MIX_SUB)
94                 return (weight - weight2);
95         else if (mix_mode == MOD_WVG_MIX_MUL)
96                 return (weight * weight2);
97         else if (mix_mode == MOD_WVG_MIX_DIV) {
98                 /* Avoid dividing by zero (or really small values). */
99                 if (weight2 < 0.0f && weight2 > -MOD_WVG_ZEROFLOOR)
100                         weight2 = -MOD_WVG_ZEROFLOOR;
101                 else if (weight2 >= 0.0f && weight2 < MOD_WVG_ZEROFLOOR)
102                         weight2 = MOD_WVG_ZEROFLOOR;
103                 return (weight / weight2);
104         }
105         else if (mix_mode == MOD_WVG_MIX_DIF)
106                 return (weight < weight2 ? weight2 - weight : weight - weight2);
107         else if (mix_mode == MOD_WVG_MIX_AVG)
108                 return (weight + weight2) * 0.5f;
109         else return weight2;
110 }
111
112 /**************************************
113  * Modifiers functions.               *
114  **************************************/
115 static void initData(ModifierData *md)
116 {
117         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
118
119         wmd->default_weight_a       = 0.0f;
120         wmd->default_weight_b       = 0.0f;
121         wmd->mix_mode               = MOD_WVG_MIX_SET;
122         wmd->mix_set                = MOD_WVG_SET_AND;
123
124         wmd->mask_constant          = 1.0f;
125         wmd->mask_tex_use_channel   = MOD_WVG_MASK_TEX_USE_INT; /* Use intensity by default. */
126         wmd->mask_tex_mapping       = MOD_DISP_MAP_LOCAL;
127 }
128
129 static void copyData(ModifierData *md, ModifierData *target)
130 {
131 #if 0
132         WeightVGMixModifierData *wmd  = (WeightVGMixModifierData *) md;
133         WeightVGMixModifierData *twmd = (WeightVGMixModifierData *) target;
134 #endif
135
136         modifier_copyData_generic(md, target);
137 }
138
139 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
140 {
141         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
142         CustomDataMask dataMask = 0;
143
144         /* We need vertex groups! */
145         dataMask |= CD_MASK_MDEFORMVERT;
146
147         /* Ask for UV coordinates if we need them. */
148         if (wmd->mask_tex_mapping == MOD_DISP_MAP_UV)
149                 dataMask |= CD_MASK_MTFACE;
150
151         /* No need to ask for CD_PREVIEW_MLOOPCOL... */
152
153         return dataMask;
154 }
155
156 static bool dependsOnTime(ModifierData *md)
157 {
158         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
159
160         if (wmd->mask_texture)
161                 return BKE_texture_dependsOnTime(wmd->mask_texture);
162         return false;
163 }
164
165 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
166 {
167         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
168         walk(userData, ob, &wmd->mask_tex_map_obj, IDWALK_CB_NOP);
169 }
170
171 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
172 {
173         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
174
175         walk(userData, ob, (ID **)&wmd->mask_texture, IDWALK_CB_USER);
176
177         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
178 }
179
180 static void foreachTexLink(ModifierData *md, Object *ob, TexWalkFunc walk, void *userData)
181 {
182         walk(userData, ob, md, "mask_texture");
183 }
184
185 static void updateDepgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
186 {
187         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
188         DagNode *curNode;
189
190         if (wmd->mask_tex_map_obj && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
191                 curNode = dag_get_node(ctx->forest, wmd->mask_tex_map_obj);
192
193                 dag_add_relation(ctx->forest, curNode, ctx->obNode, DAG_RL_DATA_DATA | DAG_RL_OB_DATA,
194                                  "WeightVGMix Modifier");
195         }
196
197         if (wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL)
198                 dag_add_relation(ctx->forest, ctx->obNode, ctx->obNode, DAG_RL_DATA_DATA | DAG_RL_OB_DATA,
199                                  "WeightVGMix Modifier");
200 }
201
202 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
203 {
204         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
205         if (wmd->mask_tex_map_obj != NULL && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
206                 DEG_add_object_relation(ctx->node, wmd->mask_tex_map_obj, DEG_OB_COMP_TRANSFORM, "WeightVGMix Modifier");
207                 DEG_add_object_relation(ctx->node, wmd->mask_tex_map_obj, DEG_OB_COMP_GEOMETRY, "WeightVGMix Modifier");
208         }
209         if (wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL) {
210                 DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "WeightVGMix Modifier");
211                 DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_GEOMETRY, "WeightVGMix Modifier");
212         }
213 }
214
215 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
216 {
217         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
218         /* If no vertex group, bypass. */
219         return (wmd->defgrp_name_a[0] == '\0');
220 }
221
222 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *derivedData,
223                                   ModifierApplyFlag UNUSED(flag))
224 {
225         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
226         DerivedMesh *dm = derivedData;
227         MDeformVert *dvert = NULL;
228         MDeformWeight **dw1, **tdw1, **dw2, **tdw2;
229         int numVerts;
230         int defgrp_index, defgrp_index_other = -1;
231         float *org_w;
232         float *new_w;
233         int *tidx, *indices = NULL;
234         int numIdx = 0;
235         int i;
236         /* Flags. */
237 #if 0
238         const bool do_prev = (wmd->modifier.mode & eModifierMode_DoWeightPreview) != 0;
239 #endif
240
241         /* Get number of verts. */
242         numVerts = dm->getNumVerts(dm);
243
244         /* Check if we can just return the original mesh.
245          * Must have verts and therefore verts assigned to vgroups to do anything useful!
246          */
247         if ((numVerts == 0) || BLI_listbase_is_empty(&ob->defbase))
248                 return dm;
249
250         /* Get vgroup idx from its name. */
251         defgrp_index = defgroup_name_index(ob, wmd->defgrp_name_a);
252         if (defgrp_index == -1)
253                 return dm;
254         /* Get second vgroup idx from its name, if given. */
255         if (wmd->defgrp_name_b[0] != (char)0) {
256                 defgrp_index_other = defgroup_name_index(ob, wmd->defgrp_name_b);
257                 if (defgrp_index_other == -1)
258                         return dm;
259         }
260
261         dvert = CustomData_duplicate_referenced_layer(&dm->vertData, CD_MDEFORMVERT, numVerts);
262         /* If no vertices were ever added to an object's vgroup, dvert might be NULL. */
263         if (!dvert) {
264                 /* If not affecting all vertices, just return. */
265                 if (wmd->mix_set != MOD_WVG_SET_ALL)
266                         return dm;
267                 /* Else, add a valid data layer! */
268                 dvert = CustomData_add_layer(&dm->vertData, CD_MDEFORMVERT, CD_CALLOC, NULL, numVerts);
269                 /* Ultimate security check. */
270                 if (!dvert)
271                         return dm;
272         }
273         /* Find out which vertices to work on. */
274         tidx = MEM_malloc_arrayN(numVerts, sizeof(int), "WeightVGMix Modifier, tidx");
275         tdw1 = MEM_malloc_arrayN(numVerts, sizeof(MDeformWeight *), "WeightVGMix Modifier, tdw1");
276         tdw2 = MEM_malloc_arrayN(numVerts, sizeof(MDeformWeight *), "WeightVGMix Modifier, tdw2");
277         switch (wmd->mix_set) {
278                 case MOD_WVG_SET_A:
279                         /* All vertices in first vgroup. */
280                         for (i = 0; i < numVerts; i++) {
281                                 MDeformWeight *dw = defvert_find_index(&dvert[i], defgrp_index);
282                                 if (dw) {
283                                         tdw1[numIdx] = dw;
284                                         tdw2[numIdx] = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
285                                         tidx[numIdx++] = i;
286                                 }
287                         }
288                         break;
289                 case MOD_WVG_SET_B:
290                         /* All vertices in second vgroup. */
291                         for (i = 0; i < numVerts; i++) {
292                                 MDeformWeight *dw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
293                                 if (dw) {
294                                         tdw1[numIdx] = defvert_find_index(&dvert[i], defgrp_index);
295                                         tdw2[numIdx] = dw;
296                                         tidx[numIdx++] = i;
297                                 }
298                         }
299                         break;
300                 case MOD_WVG_SET_OR:
301                         /* All vertices in one vgroup or the other. */
302                         for (i = 0; i < numVerts; i++) {
303                                 MDeformWeight *adw = defvert_find_index(&dvert[i], defgrp_index);
304                                 MDeformWeight *bdw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
305                                 if (adw || bdw) {
306                                         tdw1[numIdx] = adw;
307                                         tdw2[numIdx] = bdw;
308                                         tidx[numIdx++] = i;
309                                 }
310                         }
311                         break;
312                 case MOD_WVG_SET_AND:
313                         /* All vertices in both vgroups. */
314                         for (i = 0; i < numVerts; i++) {
315                                 MDeformWeight *adw = defvert_find_index(&dvert[i], defgrp_index);
316                                 MDeformWeight *bdw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
317                                 if (adw && bdw) {
318                                         tdw1[numIdx] = adw;
319                                         tdw2[numIdx] = bdw;
320                                         tidx[numIdx++] = i;
321                                 }
322                         }
323                         break;
324                 case MOD_WVG_SET_ALL:
325                 default:
326                         /* Use all vertices. */
327                         for (i = 0; i < numVerts; i++) {
328                                 tdw1[i] = defvert_find_index(&dvert[i], defgrp_index);
329                                 tdw2[i] = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
330                         }
331                         numIdx = -1;
332                         break;
333         }
334         if (numIdx == 0) {
335                 /* Use no vertices! Hence, return org data. */
336                 MEM_freeN(tdw1);
337                 MEM_freeN(tdw2);
338                 MEM_freeN(tidx);
339                 return dm;
340         }
341         if (numIdx != -1) {
342                 indices = MEM_malloc_arrayN(numIdx, sizeof(int), "WeightVGMix Modifier, indices");
343                 memcpy(indices, tidx, sizeof(int) * numIdx);
344                 dw1 = MEM_malloc_arrayN(numIdx, sizeof(MDeformWeight *), "WeightVGMix Modifier, dw1");
345                 memcpy(dw1, tdw1, sizeof(MDeformWeight *) * numIdx);
346                 MEM_freeN(tdw1);
347                 dw2 = MEM_malloc_arrayN(numIdx, sizeof(MDeformWeight *), "WeightVGMix Modifier, dw2");
348                 memcpy(dw2, tdw2, sizeof(MDeformWeight *) * numIdx);
349                 MEM_freeN(tdw2);
350         }
351         else {
352                 /* Use all vertices. */
353                 numIdx = numVerts;
354                 /* Just copy MDeformWeight pointers arrays, they will be freed at the end. */
355                 dw1 = tdw1;
356                 dw2 = tdw2;
357         }
358         MEM_freeN(tidx);
359
360         org_w = MEM_malloc_arrayN(numIdx, sizeof(float), "WeightVGMix Modifier, org_w");
361         new_w = MEM_malloc_arrayN(numIdx, sizeof(float), "WeightVGMix Modifier, new_w");
362
363         /* Mix weights. */
364         for (i = 0; i < numIdx; i++) {
365                 float weight2;
366                 org_w[i] = dw1[i] ? dw1[i]->weight : wmd->default_weight_a;
367                 weight2  = dw2[i] ? dw2[i]->weight : wmd->default_weight_b;
368
369                 new_w[i] = mix_weight(org_w[i], weight2, wmd->mix_mode);
370         }
371
372         /* Do masking. */
373         weightvg_do_mask(numIdx, indices, org_w, new_w, ob, dm, wmd->mask_constant,
374                          wmd->mask_defgrp_name, wmd->modifier.scene, wmd->mask_texture,
375                          wmd->mask_tex_use_channel, wmd->mask_tex_mapping,
376                          wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);
377
378         /* Update (add to) vgroup.
379          * XXX Depending on the MOD_WVG_SET_xxx option chosen, we might have to add vertices to vgroup.
380          */
381         weightvg_update_vg(dvert, defgrp_index, dw1, numIdx, indices, org_w, true, -FLT_MAX, false, 0.0f);
382
383         /* If weight preview enabled... */
384 #if 0 /* XXX Currently done in mod stack :/ */
385         if (do_prev)
386                 DM_update_weight_mcol(ob, dm, 0, org_w, numIdx, indices);
387 #endif
388
389         /* Freeing stuff. */
390         MEM_freeN(org_w);
391         MEM_freeN(new_w);
392         MEM_freeN(dw1);
393         MEM_freeN(dw2);
394
395         if (indices)
396                 MEM_freeN(indices);
397
398         /* Return the vgroup-modified mesh. */
399         return dm;
400 }
401
402
403 ModifierTypeInfo modifierType_WeightVGMix = {
404         /* name */              "VertexWeightMix",
405         /* structName */        "WeightVGMixModifierData",
406         /* structSize */        sizeof(WeightVGMixModifierData),
407         /* type */              eModifierTypeType_NonGeometrical,
408         /* flags */             eModifierTypeFlag_AcceptsMesh |
409                                 eModifierTypeFlag_SupportsMapping |
410                                 eModifierTypeFlag_SupportsEditmode |
411                                 eModifierTypeFlag_UsesPreview,
412
413         /* copyData */          copyData,
414         /* deformVerts */       NULL,
415         /* deformMatrices */    NULL,
416         /* deformVertsEM */     NULL,
417         /* deformMatricesEM */  NULL,
418         /* applyModifier */     applyModifier,
419         /* applyModifierEM */   NULL,
420         /* initData */          initData,
421         /* requiredDataMask */  requiredDataMask,
422         /* freeData */          NULL,
423         /* isDisabled */        isDisabled,
424         /* updateDepgraph */    updateDepgraph,
425         /* updateDepsgraph */   updateDepsgraph,
426         /* dependsOnTime */     dependsOnTime,
427         /* dependsOnNormals */  NULL,
428         /* foreachObjectLink */ foreachObjectLink,
429         /* foreachIDLink */     foreachIDLink,
430         /* foreachTexLink */    foreachTexLink,
431 };