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