svn merge ^/trunk/blender -r40390:40394
[blender.git] / source / blender / modifiers / intern / MOD_weightvgmix.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software  Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2011 by Bastien Montagne.
21  * All rights reserved.
22  *
23  * Contributor(s): None yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  *
27  */
28
29 /*
30  * XXX I'd like to make modified weights visible in WeightPaint mode,
31  *     but couldn't figure a way to do this...
32  *     Maybe this will need changes in mesh_calc_modifiers (DerivedMesh.c)?
33  *     Or the WeightPaint mode code itself?
34  */
35
36 #include "BLI_utildefines.h"
37 #include "BLI_math.h"
38 #include "BLI_string.h"
39
40 #include "DNA_mesh_types.h"
41 #include "DNA_meshdata_types.h"
42 #include "DNA_modifier_types.h"
43 #include "DNA_object_types.h"
44
45 #include "BKE_cdderivedmesh.h"
46 #include "BKE_deform.h"
47 #include "BKE_mesh.h"
48 #include "BKE_modifier.h"
49 #include "BKE_texture.h"          /* Texture masking. */
50
51 #include "depsgraph_private.h"
52 #include "MEM_guardedalloc.h"
53 #include "MOD_util.h"
54 #include "MOD_weightvg_util.h"
55
56
57 /**
58  * This mixes the old weight with the new weight factor.
59  */
60 static float mix_weight(float weight, float weight2, char mix_mode)
61 {
62 #if 0
63         /*
64          * XXX Don't know why, but the switch version takes many CPU time,
65          *     and produces lag in realtime playback...
66          */
67         switch (mix_mode)
68         {
69         case MOD_WVG_MIX_ADD:
70                 return (weight + weight2);
71         case MOD_WVG_MIX_SUB:
72                 return (weight - weight2);
73         case MOD_WVG_MIX_MUL:
74                 return (weight * weight2);
75         case MOD_WVG_MIX_DIV:
76                 /* Avoid dividing by zero (or really small values). */
77                 if (0.0 <= weight2 < MOD_WVG_ZEROFLOOR)
78                         weight2 = MOD_WVG_ZEROFLOOR;
79                 else if (-MOD_WVG_ZEROFLOOR < weight2)
80                         weight2 = -MOD_WVG_ZEROFLOOR;
81                 return (weight / weight2);
82         case MOD_WVG_MIX_DIF:
83                 return (weight < weight2 ? weight2 - weight : weight - weight2);
84         case MOD_WVG_MIX_AVG:
85                 return (weight + weight2) / 2.0;
86         case MOD_WVG_MIX_SET:
87         default:
88                 return weight2;
89         }
90 #endif
91         if (mix_mode == MOD_WVG_MIX_SET)
92                 return weight2;
93         else if (mix_mode == MOD_WVG_MIX_ADD)
94                 return (weight + weight2);
95         else if (mix_mode == MOD_WVG_MIX_SUB)
96                 return (weight - weight2);
97         else if (mix_mode == MOD_WVG_MIX_MUL)
98                 return (weight * weight2);
99         else if (mix_mode == MOD_WVG_MIX_DIV) {
100                 /* Avoid dividing by zero (or really small values). */
101                 if (weight2 < 0.0f && weight2 > -MOD_WVG_ZEROFLOOR)
102                         weight2 = -MOD_WVG_ZEROFLOOR;
103                 else if (weight2 >= 0.0f && weight2 < MOD_WVG_ZEROFLOOR)
104                         weight2 = MOD_WVG_ZEROFLOOR;
105                 return (weight / weight2);
106         }
107         else if (mix_mode == MOD_WVG_MIX_DIF)
108                 return (weight < weight2 ? weight2 - weight : weight - weight2);
109         else if (mix_mode == MOD_WVG_MIX_AVG)
110                 return (weight + weight2) * 0.5f;
111         else return weight2;
112 }
113
114 /**************************************
115  * Modifiers functions.               *
116  **************************************/
117 static void initData(ModifierData *md)
118 {
119         WeightVGMixModifierData *wmd = (WeightVGMixModifierData*) md;
120
121         wmd->default_weight_a       = 0.0f;
122         wmd->default_weight_b       = 0.0f;
123         wmd->mix_mode               = MOD_WVG_MIX_SET;
124         wmd->mix_set                = MOD_WVG_SET_AND;
125
126         wmd->mask_constant          = 1.0f;
127         wmd->mask_tex_use_channel   = MOD_WVG_MASK_TEX_USE_INT; /* Use intensity by default. */
128         wmd->mask_tex_mapping       = MOD_DISP_MAP_LOCAL;
129 }
130
131 static void copyData(ModifierData *md, ModifierData *target)
132 {
133         WeightVGMixModifierData *wmd  = (WeightVGMixModifierData*) md;
134         WeightVGMixModifierData *twmd = (WeightVGMixModifierData*) target;
135
136         BLI_strncpy(twmd->defgrp_name_a, wmd->defgrp_name_a, sizeof(twmd->defgrp_name_a));
137         BLI_strncpy(twmd->defgrp_name_b, wmd->defgrp_name_b, sizeof(twmd->defgrp_name_b));
138         twmd->default_weight_a       = wmd->default_weight_a;
139         twmd->default_weight_b       = wmd->default_weight_b;
140         twmd->mix_mode               = wmd->mix_mode;
141         twmd->mix_set                = wmd->mix_set;
142
143         twmd->mask_constant          = wmd->mask_constant;
144         BLI_strncpy(twmd->mask_defgrp_name, wmd->mask_defgrp_name, sizeof(twmd->mask_defgrp_name));
145         twmd->mask_texture           = wmd->mask_texture;
146         twmd->mask_tex_use_channel   = wmd->mask_tex_use_channel;
147         twmd->mask_tex_mapping       = wmd->mask_tex_mapping;
148         twmd->mask_tex_map_obj       = wmd->mask_tex_map_obj;
149         BLI_strncpy(twmd->mask_tex_uvlayer_name, wmd->mask_tex_uvlayer_name, sizeof(twmd->mask_tex_uvlayer_name));
150 }
151
152 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
153 {
154         WeightVGMixModifierData *wmd = (WeightVGMixModifierData*) md;
155         CustomDataMask dataMask = 0;
156
157         /* We need vertex groups! */
158         dataMask |= CD_MASK_MDEFORMVERT;
159
160         /* Ask for UV coordinates if we need them. */
161         if(wmd->mask_tex_mapping == MOD_DISP_MAP_UV)
162                 dataMask |= CD_MASK_MTFACE;
163
164         return dataMask;
165 }
166
167 static int dependsOnTime(ModifierData *md)
168 {
169         WeightVGMixModifierData *wmd = (WeightVGMixModifierData*) md;
170
171         if(wmd->mask_texture)
172                 return BKE_texture_dependsOnTime(wmd->mask_texture);
173         return 0;
174 }
175
176 static void foreachObjectLink(ModifierData *md, Object *ob,
177                               void (*walk)(void *userData, Object *ob, Object **obpoin),
178                               void *userData)
179 {
180         WeightVGMixModifierData *wmd = (WeightVGMixModifierData*) md;
181         walk(userData, ob, &wmd->mask_tex_map_obj);
182 }
183
184 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
185 {
186         WeightVGMixModifierData *wmd = (WeightVGMixModifierData*) md;
187
188         walk(userData, ob, (ID **)&wmd->mask_texture);
189
190         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
191 }
192
193 static void foreachTexLink(ModifierData *md, Object *ob, TexWalkFunc walk, void *userData)
194 {
195         walk(userData, ob, md, "mask_texture");
196 }
197
198 static void updateDepgraph(ModifierData *md, DagForest *forest, struct Scene *UNUSED(scene),
199                            Object *UNUSED(ob), DagNode *obNode)
200 {
201         WeightVGMixModifierData *wmd = (WeightVGMixModifierData*) md;
202         DagNode *curNode;
203
204         if(wmd->mask_tex_map_obj && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
205                 curNode = dag_get_node(forest, wmd->mask_tex_map_obj);
206
207                 dag_add_relation(forest, curNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
208                                  "WeightVGMix Modifier");
209         }
210
211         if(wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL)
212                 dag_add_relation(forest, obNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
213                                  "WeightVGMix Modifier");
214 }
215
216 static int isDisabled(ModifierData *md, int UNUSED(useRenderParams))
217 {
218         WeightVGMixModifierData *wmd = (WeightVGMixModifierData*) md;
219         /* If no vertex group, bypass. */
220         return (wmd->defgrp_name_a[0] == '\0');
221 }
222
223 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *derivedData,
224                                   int UNUSED(useRenderParams), int UNUSED(isFinalCalc))
225 {
226         WeightVGMixModifierData *wmd = (WeightVGMixModifierData*) md;
227         DerivedMesh *dm = derivedData, *ret = NULL;
228 #if 0
229         Mesh *ob_m = NULL;
230 #endif
231         MDeformVert *dvert = NULL;
232         MDeformWeight **dw1, **tdw1, **dw2, **tdw2;
233         int numVerts;
234         int defgrp_idx, defgrp_idx2 = -1;
235         float *org_w;
236         float *new_w;
237         int *tidx, *indices = NULL;
238         int numIdx = 0;
239         int i;
240         char rel_ret = 0; /* Boolean, whether we have to release ret dm or not, when not using it! */
241
242         /* Get number of verts. */
243         numVerts = dm->getNumVerts(dm);
244
245         /* Check if we can just return the original mesh.
246          * Must have verts and therefore verts assigned to vgroups to do anything useful!
247          */
248         if ((numVerts == 0) || (ob->defbase.first == NULL))
249                 return dm;
250
251         /* Get vgroup idx from its name. */
252         defgrp_idx = defgroup_name_index(ob, wmd->defgrp_name_a);
253         if (defgrp_idx < 0)
254                 return dm;
255         /* Get seconf vgroup idx from its name, if given. */
256         if (wmd->defgrp_name_b[0] != (char)0) {
257                 defgrp_idx2 = defgroup_name_index(ob, wmd->defgrp_name_b);
258                 if (defgrp_idx2 < 0)
259                         return dm;
260         }
261
262         /* XXX All this to avoid copying dm when not needed... However, it nearly doubles compute
263          *     time! See scene 5 of the WeighVG test file...
264          */
265 #if 0
266         /* Get actual dverts (ie vertex group data). */
267         dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
268         /* If no dverts, return unmodified data... */
269         if (dvert == NULL)
270                 return dm;
271
272         /* Get org mesh, only to test whether affected cdata layer has already been copied
273          * somewhere up in the modifiers stack.
274          */
275         ob_m = get_mesh(ob);
276         if (ob_m == NULL)
277                 return dm;
278
279         /* Create a copy of our dmesh, only if our affected cdata layer is the same as org mesh. */
280         if (dvert == CustomData_get_layer(&ob_m->vdata, CD_MDEFORMVERT)) {
281                 /* XXX Seems to create problems with weightpaint mode???
282                  *     I'm missing something here, I guess...
283                  */
284 //              DM_set_only_copy(dm, CD_MASK_MDEFORMVERT); /* Only copy defgroup layer. */
285                 ret = CDDM_copy(dm);
286                 dvert = ret->getVertDataArray(ret, CD_MDEFORMVERT);
287                 if (dvert == NULL) {
288                         ret->release(ret);
289                         return dm;
290                 }
291                 rel_ret = 1;
292         }
293         else
294                 ret = dm;
295 #else
296         ret = CDDM_copy(dm, 0);
297         rel_ret = 1;
298         dvert = ret->getVertDataArray(ret, CD_MDEFORMVERT);
299         if (dvert == NULL) {
300                 if (rel_ret)
301                         ret->release(ret);
302                 return dm;
303         }
304 #endif
305
306         /* Find out which vertices to work on. */
307         tidx = MEM_mallocN(sizeof(int) * numVerts, "WeightVGMix Modifier, tidx");
308         tdw1 = MEM_mallocN(sizeof(MDeformWeight*) * numVerts, "WeightVGMix Modifier, tdw1");
309         tdw2 = MEM_mallocN(sizeof(MDeformWeight*) * numVerts, "WeightVGMix Modifier, tdw2");
310         switch (wmd->mix_set) {
311         case MOD_WVG_SET_A:
312                 /* All vertices in first vgroup. */
313                 for (i = 0; i < numVerts; i++) {
314                         MDeformWeight *dw = defvert_find_index(&dvert[i], defgrp_idx);
315                         if(dw) {
316                                 tdw1[numIdx] = dw;
317                                 tdw2[numIdx] = defvert_find_index(&dvert[i], defgrp_idx2);
318                                 tidx[numIdx++] = i;
319                         }
320                 }
321                 break;
322         case MOD_WVG_SET_B:
323                 /* All vertices in second vgroup. */
324                 for (i = 0; i < numVerts; i++) {
325                         MDeformWeight *dw = defvert_find_index(&dvert[i], defgrp_idx2);
326                         if(dw) {
327                                 tdw1[numIdx] = defvert_find_index(&dvert[i], defgrp_idx);
328                                 tdw2[numIdx] = dw;
329                                 tidx[numIdx++] = i;
330                         }
331                 }
332                 break;
333         case MOD_WVG_SET_OR:
334                 /* All vertices in one vgroup or the other. */
335                 for (i = 0; i < numVerts; i++) {
336                         MDeformWeight *adw = defvert_find_index(&dvert[i], defgrp_idx);
337                         MDeformWeight *bdw = defvert_find_index(&dvert[i], defgrp_idx2);
338                         if(adw || bdw) {
339                                 tdw1[numIdx] = adw;
340                                 tdw2[numIdx] = bdw;
341                                 tidx[numIdx++] = i;
342                         }
343                 }
344                 break;
345         case MOD_WVG_SET_AND:
346                 /* All vertices in both vgroups. */
347                 for (i = 0; i < numVerts; i++) {
348                         MDeformWeight *adw = defvert_find_index(&dvert[i], defgrp_idx);
349                         MDeformWeight *bdw = defvert_find_index(&dvert[i], defgrp_idx2);
350                         if(adw && bdw) {
351                                 tdw1[numIdx] = adw;
352                                 tdw2[numIdx] = bdw;
353                                 tidx[numIdx++] = i;
354                         }
355                 }
356                 break;
357         case MOD_WVG_SET_ALL:
358         default:
359                 /* Use all vertices. */
360                 for (i = 0; i < numVerts; i++) {
361                         tdw1[i] = defvert_find_index(&dvert[i], defgrp_idx);
362                         tdw2[i] = defvert_find_index(&dvert[i], defgrp_idx2);
363                 }
364                 numIdx = -1;
365                 break;
366         }
367         if(numIdx == 0) {
368                 /* Use no vertices! Hence, return org data. */
369                 MEM_freeN(tdw1);
370                 MEM_freeN(tdw2);
371                 MEM_freeN(tidx);
372                 if (rel_ret)
373                         ret->release(ret);
374                 return dm;
375         }
376         if (numIdx != -1) {
377                 indices = MEM_mallocN(sizeof(int) * numIdx, "WeightVGMix Modifier, indices");
378                 memcpy(indices, tidx, sizeof(int) * numIdx);
379                 dw1 = MEM_mallocN(sizeof(MDeformWeight*) * numIdx, "WeightVGMix Modifier, dw1");
380                 memcpy(dw1, tdw1, sizeof(MDeformWeight*) * numIdx);
381                 MEM_freeN(tdw1);
382                 dw2 = MEM_mallocN(sizeof(MDeformWeight*) * numIdx, "WeightVGMix Modifier, dw2");
383                 memcpy(dw2, tdw2, sizeof(MDeformWeight*) * numIdx);
384                 MEM_freeN(tdw2);
385         }
386         else {
387                 /* Use all vertices. */
388                 numIdx = numVerts;
389                 /* Just copy MDeformWeight pointers arrays, they will be freed at the end. */
390                 dw1 = tdw1;
391                 dw2 = tdw2;
392         }
393         MEM_freeN(tidx);
394
395         org_w = MEM_mallocN(sizeof(float) * numIdx, "WeightVGMix Modifier, org_w");
396         new_w = MEM_mallocN(sizeof(float) * numIdx, "WeightVGMix Modifier, new_w");
397
398         /* Mix weights. */
399         for (i = 0; i < numIdx; i++) {
400                 float weight2 = 0.0;
401                 org_w[i] = dw1[i] ? dw1[i]->weight : wmd->default_weight_a;
402                 weight2  = dw2[i] ? dw2[i]->weight : wmd->default_weight_b;
403
404                 new_w[i] = mix_weight(org_w[i], weight2, wmd->mix_mode);
405         }
406
407         /* Do masking. */
408         weightvg_do_mask(numIdx, indices, org_w, new_w, ob, ret, wmd->mask_constant,
409                          wmd->mask_defgrp_name, wmd->mask_texture, wmd->mask_tex_use_channel,
410                          wmd->mask_tex_mapping, wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);
411
412         /* Update (add to) vgroup.
413          * XXX Depending on the MOD_WVG_SET_xxx option chosen, we might have to add vertices to vgroup.
414          */
415         weightvg_update_vg(dvert, defgrp_idx, dw1, numIdx, indices, org_w, TRUE, -FLT_MAX, FALSE, 0.0f);
416
417         /* Freeing stuff. */
418         MEM_freeN(org_w);
419         MEM_freeN(new_w);
420         MEM_freeN(dw1);
421         MEM_freeN(dw2);
422
423         if (indices)
424                 MEM_freeN(indices);
425
426         /* Return the vgroup-modified mesh. */
427         return ret;
428 }
429
430 static DerivedMesh *applyModifierEM(ModifierData *md, Object *ob,
431                                     struct BMEditMesh *UNUSED(editData),
432                                     DerivedMesh *derivedData)
433 {
434         return applyModifier(md, ob, derivedData, 0, 1);
435 }
436
437
438 ModifierTypeInfo modifierType_WeightVGMix = {
439         /* name */              "VertexWeightMix",
440         /* structName */        "WeightVGMixModifierData",
441         /* structSize */        sizeof(WeightVGMixModifierData),
442         /* type */              eModifierTypeType_Nonconstructive,
443         /* flags */             eModifierTypeFlag_AcceptsMesh
444 /*                             |eModifierTypeFlag_SupportsMapping*/
445                                |eModifierTypeFlag_SupportsEditmode,
446
447         /* copyData */          copyData,
448         /* deformVerts */       NULL,
449         /* deformMatrices */    NULL,
450         /* deformVertsEM */     NULL,
451         /* deformMatricesEM */  NULL,
452         /* applyModifier */     applyModifier,
453         /* applyModifierEM */   applyModifierEM,
454         /* initData */          initData,
455         /* requiredDataMask */  requiredDataMask,
456         /* freeData */          NULL,
457         /* isDisabled */        isDisabled,
458         /* updateDepgraph */    updateDepgraph,
459         /* dependsOnTime */     dependsOnTime,
460         /* dependsOnNormals */  NULL,
461         /* foreachObjectLink */ foreachObjectLink,
462         /* foreachIDLink */     foreachIDLink,
463         /* foreachTexLink */    foreachTexLink,
464 };