Depsgraph: Wrap all arguments foe modifiers relations update into a struct
[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 freeData(ModifierData *md)
130 {
131         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
132         if (wmd->mask_texture) {
133                 id_us_min(&wmd->mask_texture->id);
134         }
135 }
136
137 static void copyData(ModifierData *md, ModifierData *target)
138 {
139 #if 0
140         WeightVGMixModifierData *wmd  = (WeightVGMixModifierData *) md;
141         WeightVGMixModifierData *twmd = (WeightVGMixModifierData *) target;
142 #endif
143
144         modifier_copyData_generic(md, target);
145 }
146
147 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
148 {
149         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
150         CustomDataMask dataMask = 0;
151
152         /* We need vertex groups! */
153         dataMask |= CD_MASK_MDEFORMVERT;
154
155         /* Ask for UV coordinates if we need them. */
156         if (wmd->mask_tex_mapping == MOD_DISP_MAP_UV)
157                 dataMask |= CD_MASK_MTFACE;
158
159         /* No need to ask for CD_PREVIEW_MLOOPCOL... */
160
161         return dataMask;
162 }
163
164 static bool dependsOnTime(ModifierData *md)
165 {
166         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
167
168         if (wmd->mask_texture)
169                 return BKE_texture_dependsOnTime(wmd->mask_texture);
170         return false;
171 }
172
173 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
174 {
175         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
176         walk(userData, ob, &wmd->mask_tex_map_obj, IDWALK_CB_NOP);
177 }
178
179 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
180 {
181         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
182
183         walk(userData, ob, (ID **)&wmd->mask_texture, IDWALK_CB_USER);
184
185         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
186 }
187
188 static void foreachTexLink(ModifierData *md, Object *ob, TexWalkFunc walk, void *userData)
189 {
190         walk(userData, ob, md, "mask_texture");
191 }
192
193 static void updateDepgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
194 {
195         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
196         DagNode *curNode;
197
198         if (wmd->mask_tex_map_obj && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
199                 curNode = dag_get_node(ctx->forest, wmd->mask_tex_map_obj);
200
201                 dag_add_relation(ctx->forest, curNode, ctx->obNode, DAG_RL_DATA_DATA | DAG_RL_OB_DATA,
202                                  "WeightVGMix Modifier");
203         }
204
205         if (wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL)
206                 dag_add_relation(ctx->forest, ctx->obNode, ctx->obNode, DAG_RL_DATA_DATA | DAG_RL_OB_DATA,
207                                  "WeightVGMix Modifier");
208 }
209
210 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
211 {
212         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
213         if (wmd->mask_tex_map_obj != NULL && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
214                 DEG_add_object_relation(ctx->node, wmd->mask_tex_map_obj, DEG_OB_COMP_TRANSFORM, "WeightVGMix Modifier");
215                 DEG_add_object_relation(ctx->node, wmd->mask_tex_map_obj, DEG_OB_COMP_GEOMETRY, "WeightVGMix Modifier");
216         }
217         if (wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL) {
218                 DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "WeightVGMix Modifier");
219                 DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_GEOMETRY, "WeightVGMix Modifier");
220         }
221 }
222
223 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
224 {
225         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
226         /* If no vertex group, bypass. */
227         return (wmd->defgrp_name_a[0] == '\0');
228 }
229
230 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *derivedData,
231                                   ModifierApplyFlag UNUSED(flag))
232 {
233         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
234         DerivedMesh *dm = derivedData;
235         MDeformVert *dvert = NULL;
236         MDeformWeight **dw1, **tdw1, **dw2, **tdw2;
237         int numVerts;
238         int defgrp_index, defgrp_index_other = -1;
239         float *org_w;
240         float *new_w;
241         int *tidx, *indices = NULL;
242         int numIdx = 0;
243         int i;
244         /* Flags. */
245 #if 0
246         const bool do_prev = (wmd->modifier.mode & eModifierMode_DoWeightPreview) != 0;
247 #endif
248
249         /* Get number of verts. */
250         numVerts = dm->getNumVerts(dm);
251
252         /* Check if we can just return the original mesh.
253          * Must have verts and therefore verts assigned to vgroups to do anything useful!
254          */
255         if ((numVerts == 0) || BLI_listbase_is_empty(&ob->defbase))
256                 return dm;
257
258         /* Get vgroup idx from its name. */
259         defgrp_index = defgroup_name_index(ob, wmd->defgrp_name_a);
260         if (defgrp_index == -1)
261                 return dm;
262         /* Get second vgroup idx from its name, if given. */
263         if (wmd->defgrp_name_b[0] != (char)0) {
264                 defgrp_index_other = defgroup_name_index(ob, wmd->defgrp_name_b);
265                 if (defgrp_index_other == -1)
266                         return dm;
267         }
268
269         dvert = CustomData_duplicate_referenced_layer(&dm->vertData, CD_MDEFORMVERT, numVerts);
270         /* If no vertices were ever added to an object's vgroup, dvert might be NULL. */
271         if (!dvert) {
272                 /* If not affecting all vertices, just return. */
273                 if (wmd->mix_set != MOD_WVG_SET_ALL)
274                         return dm;
275                 /* Else, add a valid data layer! */
276                 dvert = CustomData_add_layer(&dm->vertData, CD_MDEFORMVERT, CD_CALLOC, NULL, numVerts);
277                 /* Ultimate security check. */
278                 if (!dvert)
279                         return dm;
280         }
281         /* Find out which vertices to work on. */
282         tidx = MEM_malloc_arrayN(numVerts, sizeof(int), "WeightVGMix Modifier, tidx");
283         tdw1 = MEM_malloc_arrayN(numVerts, sizeof(MDeformWeight *), "WeightVGMix Modifier, tdw1");
284         tdw2 = MEM_malloc_arrayN(numVerts, sizeof(MDeformWeight *), "WeightVGMix Modifier, tdw2");
285         switch (wmd->mix_set) {
286                 case MOD_WVG_SET_A:
287                         /* All vertices in first vgroup. */
288                         for (i = 0; i < numVerts; i++) {
289                                 MDeformWeight *dw = defvert_find_index(&dvert[i], defgrp_index);
290                                 if (dw) {
291                                         tdw1[numIdx] = dw;
292                                         tdw2[numIdx] = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
293                                         tidx[numIdx++] = i;
294                                 }
295                         }
296                         break;
297                 case MOD_WVG_SET_B:
298                         /* All vertices in second vgroup. */
299                         for (i = 0; i < numVerts; i++) {
300                                 MDeformWeight *dw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
301                                 if (dw) {
302                                         tdw1[numIdx] = defvert_find_index(&dvert[i], defgrp_index);
303                                         tdw2[numIdx] = dw;
304                                         tidx[numIdx++] = i;
305                                 }
306                         }
307                         break;
308                 case MOD_WVG_SET_OR:
309                         /* All vertices in one vgroup or the other. */
310                         for (i = 0; i < numVerts; i++) {
311                                 MDeformWeight *adw = defvert_find_index(&dvert[i], defgrp_index);
312                                 MDeformWeight *bdw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
313                                 if (adw || bdw) {
314                                         tdw1[numIdx] = adw;
315                                         tdw2[numIdx] = bdw;
316                                         tidx[numIdx++] = i;
317                                 }
318                         }
319                         break;
320                 case MOD_WVG_SET_AND:
321                         /* All vertices in both vgroups. */
322                         for (i = 0; i < numVerts; i++) {
323                                 MDeformWeight *adw = defvert_find_index(&dvert[i], defgrp_index);
324                                 MDeformWeight *bdw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
325                                 if (adw && bdw) {
326                                         tdw1[numIdx] = adw;
327                                         tdw2[numIdx] = bdw;
328                                         tidx[numIdx++] = i;
329                                 }
330                         }
331                         break;
332                 case MOD_WVG_SET_ALL:
333                 default:
334                         /* Use all vertices. */
335                         for (i = 0; i < numVerts; i++) {
336                                 tdw1[i] = defvert_find_index(&dvert[i], defgrp_index);
337                                 tdw2[i] = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
338                         }
339                         numIdx = -1;
340                         break;
341         }
342         if (numIdx == 0) {
343                 /* Use no vertices! Hence, return org data. */
344                 MEM_freeN(tdw1);
345                 MEM_freeN(tdw2);
346                 MEM_freeN(tidx);
347                 return dm;
348         }
349         if (numIdx != -1) {
350                 indices = MEM_malloc_arrayN(numIdx, sizeof(int), "WeightVGMix Modifier, indices");
351                 memcpy(indices, tidx, sizeof(int) * numIdx);
352                 dw1 = MEM_malloc_arrayN(numIdx, sizeof(MDeformWeight *), "WeightVGMix Modifier, dw1");
353                 memcpy(dw1, tdw1, sizeof(MDeformWeight *) * numIdx);
354                 MEM_freeN(tdw1);
355                 dw2 = MEM_malloc_arrayN(numIdx, sizeof(MDeformWeight *), "WeightVGMix Modifier, dw2");
356                 memcpy(dw2, tdw2, sizeof(MDeformWeight *) * numIdx);
357                 MEM_freeN(tdw2);
358         }
359         else {
360                 /* Use all vertices. */
361                 numIdx = numVerts;
362                 /* Just copy MDeformWeight pointers arrays, they will be freed at the end. */
363                 dw1 = tdw1;
364                 dw2 = tdw2;
365         }
366         MEM_freeN(tidx);
367
368         org_w = MEM_malloc_arrayN(numIdx, sizeof(float), "WeightVGMix Modifier, org_w");
369         new_w = MEM_malloc_arrayN(numIdx, sizeof(float), "WeightVGMix Modifier, new_w");
370
371         /* Mix weights. */
372         for (i = 0; i < numIdx; i++) {
373                 float weight2;
374                 org_w[i] = dw1[i] ? dw1[i]->weight : wmd->default_weight_a;
375                 weight2  = dw2[i] ? dw2[i]->weight : wmd->default_weight_b;
376
377                 new_w[i] = mix_weight(org_w[i], weight2, wmd->mix_mode);
378         }
379
380         /* Do masking. */
381         weightvg_do_mask(numIdx, indices, org_w, new_w, ob, dm, wmd->mask_constant,
382                          wmd->mask_defgrp_name, wmd->modifier.scene, wmd->mask_texture,
383                          wmd->mask_tex_use_channel, wmd->mask_tex_mapping,
384                          wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);
385
386         /* Update (add to) vgroup.
387          * XXX Depending on the MOD_WVG_SET_xxx option chosen, we might have to add vertices to vgroup.
388          */
389         weightvg_update_vg(dvert, defgrp_index, dw1, numIdx, indices, org_w, true, -FLT_MAX, false, 0.0f);
390
391         /* If weight preview enabled... */
392 #if 0 /* XXX Currently done in mod stack :/ */
393         if (do_prev)
394                 DM_update_weight_mcol(ob, dm, 0, org_w, numIdx, indices);
395 #endif
396
397         /* Freeing stuff. */
398         MEM_freeN(org_w);
399         MEM_freeN(new_w);
400         MEM_freeN(dw1);
401         MEM_freeN(dw2);
402
403         if (indices)
404                 MEM_freeN(indices);
405
406         /* Return the vgroup-modified mesh. */
407         return dm;
408 }
409
410
411 ModifierTypeInfo modifierType_WeightVGMix = {
412         /* name */              "VertexWeightMix",
413         /* structName */        "WeightVGMixModifierData",
414         /* structSize */        sizeof(WeightVGMixModifierData),
415         /* type */              eModifierTypeType_NonGeometrical,
416         /* flags */             eModifierTypeFlag_AcceptsMesh |
417                                 eModifierTypeFlag_SupportsMapping |
418                                 eModifierTypeFlag_SupportsEditmode |
419                                 eModifierTypeFlag_UsesPreview,
420
421         /* copyData */          copyData,
422         /* deformVerts */       NULL,
423         /* deformMatrices */    NULL,
424         /* deformVertsEM */     NULL,
425         /* deformMatricesEM */  NULL,
426         /* applyModifier */     applyModifier,
427         /* applyModifierEM */   NULL,
428         /* initData */          initData,
429         /* requiredDataMask */  requiredDataMask,
430         /* freeData */          freeData,
431         /* isDisabled */        isDisabled,
432         /* updateDepgraph */    updateDepgraph,
433         /* updateDepsgraph */   updateDepsgraph,
434         /* dependsOnTime */     dependsOnTime,
435         /* dependsOnNormals */  NULL,
436         /* foreachObjectLink */ foreachObjectLink,
437         /* foreachIDLink */     foreachIDLink,
438         /* foreachTexLink */    foreachTexLink,
439 };