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