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