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