- mask_tex_map_obj --> mask_tex_map_object
[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.0 && weight2 > -MOD_WVG_ZEROFLOOR)
102                         weight2 = -MOD_WVG_ZEROFLOOR;
103                 else if (weight2 >= 0.0 && 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) / 2.0;
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         = 0.0;
122         wmd->default_weight2        = 0.0;
123         wmd->mix_mode               = MOD_WVG_MIX_SET;
124         wmd->mix_set                = MOD_WVG_SET_INTER;
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, wmd->defgrp_name, sizeof(twmd->defgrp_name));
137         BLI_strncpy(twmd->defgrp_name2, wmd->defgrp_name2, sizeof(twmd->defgrp_name2));
138         twmd->default_weight         = wmd->default_weight;
139         twmd->default_weight2        = wmd->default_weight2;
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 == NULL);
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         int numVerts;
233         int defgrp_idx, defgrp_idx2 = -1;
234         float *org_w = NULL;
235         float *new_w = NULL;
236         int *tidx, *indices = NULL;
237         int numIdx = 0;
238         int i, j;
239         char rel_ret = 0; /* Boolean, whether we have to release ret dm or not, when not using it! */
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) || (ob->defbase.first == NULL))
248                 return dm;
249
250         /* Get vgroup idx from its name. */
251         defgrp_idx = defgroup_name_index(ob, wmd->defgrp_name);
252         if (defgrp_idx < 0)
253                 return dm;
254         /* Get seconf vgroup idx from its name, if given. */
255         if (wmd->defgrp_name2[0] != (char)0) {
256                 defgrp_idx2 = defgroup_name_index(ob, wmd->defgrp_name2);
257                 if (defgrp_idx2 < 0)
258                         return dm;
259         }
260
261         /* XXX All this to avoid copying dm when not needed… However, it nearly doubles compute
262          *     time! See scene 5 of the WeighVG test file…
263          */
264 #if 0
265         /* Get actual dverts (ie vertex group data). */
266         dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
267         /* If no dverts, return unmodified data… */
268         if (dvert == NULL)
269                 return dm;
270
271         /* Get org mesh, only to test whether affected cdata layer has already been copied
272          * somewhere up in the modifiers stack.
273          */
274         ob_m = get_mesh(ob);
275         if (ob_m == NULL)
276                 return dm;
277
278         /* Create a copy of our dmesh, only if our affected cdata layer is the same as org mesh. */
279         if (dvert == CustomData_get_layer(&ob_m->vdata, CD_MDEFORMVERT)) {
280                 /* XXX Seems to create problems with weightpaint mode???
281                  *     I'm missing something here, I guess…
282                  */
283 //              DM_set_only_copy(dm, CD_MASK_MDEFORMVERT); /* Only copy defgroup layer. */
284                 ret = CDDM_copy(dm);
285                 dvert = ret->getVertDataArray(ret, CD_MDEFORMVERT);
286                 if (dvert == NULL) {
287                         ret->release(ret);
288                         return dm;
289                 }
290                 rel_ret = 1;
291         }
292         else
293                 ret = dm;
294 #else
295         ret = CDDM_copy(dm);
296         rel_ret = 1;
297         dvert = ret->getVertDataArray(ret, CD_MDEFORMVERT);
298         if (dvert == NULL) {
299                 if (rel_ret)
300                         ret->release(ret);
301                 return dm;
302         }
303 #endif
304
305         /* Find out which vertices to work on. */
306         tidx = MEM_mallocN(sizeof(int) * numVerts, "WeightVGMix Modifier, tidx");
307         switch (wmd->mix_set) {
308         case MOD_WVG_SET_ORG:
309                 /* All vertices in first vgroup. */
310                 for (i = 0; i < numVerts; i++) {
311                         for (j = 0; j < dvert[i].totweight; j++) {
312                                 if(dvert[i].dw[j].def_nr == defgrp_idx) {
313                                         tidx[numIdx++] = i;
314                                         break;
315                                 }
316                         }
317                 }
318                 break;
319         case MOD_WVG_SET_NEW:
320                 /* All vertices in second vgroup. */
321                 for (i = 0; i < numVerts; i++) {
322                         for (j = 0; j < dvert[i].totweight; j++) {
323                                 if(dvert[i].dw[j].def_nr == defgrp_idx2) {
324                                         tidx[numIdx++] = i;
325                                         break;
326                                 }
327                         }
328                 }
329                 break;
330         case MOD_WVG_SET_UNION:
331                 /* All vertices in one vgroup or the other. */
332                 for (i = 0; i < numVerts; i++) {
333                         for (j = 0; j < dvert[i].totweight; j++) {
334                                 if(dvert[i].dw[j].def_nr == defgrp_idx || dvert[i].dw[j].def_nr == defgrp_idx2) {
335                                         tidx[numIdx++] = i;
336                                         break;
337                                 }
338                         }
339                 }
340                 break;
341         case MOD_WVG_SET_INTER:
342                 /* All vertices in both vgroups. */
343                 for (i = 0; i < numVerts; i++) {
344                         char idx1 = 0;
345                         char idx2 = 0;
346                         for (j = 0; j < dvert[i].totweight; j++) {
347                                 if(dvert[i].dw[j].def_nr == defgrp_idx) {
348                                         if (idx2) {
349                                                 tidx[numIdx++] = i;
350                                                 break;
351                                         }
352                                         else
353                                                 idx1 = 1;
354                                 }
355                                 else if(dvert[i].dw[j].def_nr == defgrp_idx2) {
356                                         if (idx1) {
357                                                 tidx[numIdx++] = i;
358                                                 break;
359                                         }
360                                         else
361                                                 idx2 = 1;
362                                 }
363                         }
364                 }
365                 break;
366         case MOD_WVG_SET_ALL:
367         default:
368                 /* Use all vertices, no need to do anything here. */
369                 break;
370         }
371         if (numIdx) {
372                 indices = MEM_mallocN(sizeof(int) * numIdx, "WeightVGMix Modifier, indices");
373                 memcpy(indices, tidx, sizeof(int) * numIdx);
374         }
375         else
376                 numIdx = numVerts;
377         MEM_freeN(tidx);
378
379         org_w = MEM_mallocN(sizeof(float) * numIdx, "WeightVGMix Modifier, org_w");
380         new_w = MEM_mallocN(sizeof(float) * numIdx, "WeightVGMix Modifier, new_w");
381
382         /* Mix weights. */
383         for (i = 0; i < numIdx; i++) {
384                 float weight2 = 0.0;
385                 char w1 = 0;
386                 char w2 = 0;
387                 int idx = indices ? indices[i] : i;
388                 for (j = 0; j < dvert[idx].totweight; j++) {
389                         if(dvert[idx].dw[j].def_nr == defgrp_idx) {
390                                 org_w[i] = dvert[idx].dw[j].weight;
391                                 w1 = 1;
392                                 if (w2)
393                                         break;
394                         }
395                         else if(dvert[idx].dw[j].def_nr == defgrp_idx2) {
396                                 weight2 = dvert[idx].dw[j].weight;
397                                 w2 = 1;
398                                 if (w1)
399                                         break;
400                         }
401                 }
402                 if (w1 == 0)
403                         org_w[i] = wmd->default_weight;
404                 if (w2 == 0)
405                         weight2 = wmd->default_weight2;
406                 new_w[i] = mix_weight(org_w[i], weight2, wmd->mix_mode);
407         }
408
409         /* Do masking. */
410         weightvg_do_mask(numIdx, indices, org_w, new_w, ob, ret, wmd->mask_constant,
411                          wmd->mask_defgrp_name, wmd->mask_texture, wmd->mask_tex_use_channel,
412                          wmd->mask_tex_mapping, wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);
413
414         /* Update (add to) vgroup.
415          * XXX Depending on the MOD_WVG_SET_xxx option chosen, we might have to add vertices to vgroup.
416          */
417         weightvg_update_vg(dvert, defgrp_idx, numIdx, indices, org_w, 1, -FLT_MAX, 0, 0.0f);
418
419         /* Freeing stuff. */
420         if (org_w)
421                 MEM_freeN(org_w);
422         if (new_w)
423                 MEM_freeN(new_w);
424         if (indices)
425                 MEM_freeN(indices);
426
427         /* Return the vgroup-modified mesh. */
428         return ret;
429 }
430
431 static DerivedMesh *applyModifierEM(ModifierData *md, Object *ob,
432                                     struct EditMesh *UNUSED(editData),
433                                     DerivedMesh *derivedData)
434 {
435         return applyModifier(md, ob, derivedData, 0, 1);
436 }
437
438
439 ModifierTypeInfo modifierType_WeightVGMix = {
440         /* name */              "WeightVGMix",
441         /* structName */        "WeightVGMixModifierData",
442         /* structSize */        sizeof(WeightVGMixModifierData),
443         /* type */              eModifierTypeType_Nonconstructive,
444         /* flags */             eModifierTypeFlag_AcceptsMesh
445 /*                             |eModifierTypeFlag_SupportsMapping*/
446                                |eModifierTypeFlag_SupportsEditmode,
447
448         /* copyData */          copyData,
449         /* deformVerts */       NULL,
450         /* deformMatrices */    NULL,
451         /* deformVertsEM */     NULL,
452         /* deformMatricesEM */  NULL,
453         /* applyModifier */     applyModifier,
454         /* applyModifierEM */   applyModifierEM,
455         /* initData */          initData,
456         /* requiredDataMask */  requiredDataMask,
457         /* freeData */          NULL,
458         /* isDisabled */        isDisabled,
459         /* updateDepgraph */    updateDepgraph,
460         /* dependsOnTime */     dependsOnTime,
461         /* dependsOnNormals */  NULL,
462         /* foreachObjectLink */ foreachObjectLink,
463         /* foreachIDLink */     foreachIDLink,
464         /* foreachTexLink */    foreachTexLink,
465 };