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_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_customdata.h"
41 #include "BKE_deform.h"
42 #include "BKE_library.h"
43 #include "BKE_library_query.h"
44 #include "BKE_modifier.h"
45 #include "BKE_texture.h"          /* Texture masking. */
46
47 #include "DEG_depsgraph_build.h"
48
49 #include "MEM_guardedalloc.h"
50
51 #include "MOD_weightvg_util.h"
52 #include "MOD_modifiertypes.h"
53
54
55 /**
56  * This mixes the old weight with the new weight factor.
57  */
58 static float mix_weight(float weight, float weight2, char mix_mode)
59 {
60 #if 0
61         /*
62          * XXX Don't know why, but the switch version takes many CPU time,
63          *     and produces lag in realtime playback...
64          */
65         switch (mix_mode)
66         {
67                 case MOD_WVG_MIX_ADD:
68                         return (weight + weight2);
69                 case MOD_WVG_MIX_SUB:
70                         return (weight - weight2);
71                 case MOD_WVG_MIX_MUL:
72                         return (weight * weight2);
73                 case MOD_WVG_MIX_DIV:
74                         /* Avoid dividing by zero (or really small values). */
75                         if (0.0 <= weight2 < MOD_WVG_ZEROFLOOR)
76                                 weight2 = MOD_WVG_ZEROFLOOR;
77                         else if (-MOD_WVG_ZEROFLOOR < weight2)
78                                 weight2 = -MOD_WVG_ZEROFLOOR;
79                         return (weight / weight2);
80                 case MOD_WVG_MIX_DIF:
81                         return (weight < weight2 ? weight2 - weight : weight - weight2);
82                 case MOD_WVG_MIX_AVG:
83                         return (weight + weight2) / 2.0;
84                 case MOD_WVG_MIX_SET:
85                 default:
86                         return weight2;
87         }
88 #endif
89         if (mix_mode == MOD_WVG_MIX_SET)
90                 return weight2;
91         else if (mix_mode == MOD_WVG_MIX_ADD)
92                 return (weight + weight2);
93         else if (mix_mode == MOD_WVG_MIX_SUB)
94                 return (weight - weight2);
95         else if (mix_mode == MOD_WVG_MIX_MUL)
96                 return (weight * weight2);
97         else if (mix_mode == MOD_WVG_MIX_DIV) {
98                 /* Avoid dividing by zero (or really small values). */
99                 if (weight2 < 0.0f && weight2 > -MOD_WVG_ZEROFLOOR)
100                         weight2 = -MOD_WVG_ZEROFLOOR;
101                 else if (weight2 >= 0.0f && weight2 < MOD_WVG_ZEROFLOOR)
102                         weight2 = MOD_WVG_ZEROFLOOR;
103                 return (weight / weight2);
104         }
105         else if (mix_mode == MOD_WVG_MIX_DIF)
106                 return (weight < weight2 ? weight2 - weight : weight - weight2);
107         else if (mix_mode == MOD_WVG_MIX_AVG)
108                 return (weight + weight2) * 0.5f;
109         else return weight2;
110 }
111
112 /**************************************
113  * Modifiers functions.               *
114  **************************************/
115 static void initData(ModifierData *md)
116 {
117         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
118
119         wmd->default_weight_a       = 0.0f;
120         wmd->default_weight_b       = 0.0f;
121         wmd->mix_mode               = MOD_WVG_MIX_SET;
122         wmd->mix_set                = MOD_WVG_SET_AND;
123
124         wmd->mask_constant          = 1.0f;
125         wmd->mask_tex_use_channel   = MOD_WVG_MASK_TEX_USE_INT; /* Use intensity by default. */
126         wmd->mask_tex_mapping       = MOD_DISP_MAP_LOCAL;
127 }
128
129 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
130 {
131         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
132         CustomDataMask dataMask = 0;
133
134         /* We need vertex groups! */
135         dataMask |= CD_MASK_MDEFORMVERT;
136
137         /* Ask for UV coordinates if we need them. */
138         if (wmd->mask_tex_mapping == MOD_DISP_MAP_UV)
139                 dataMask |= CD_MASK_MTFACE;
140
141         /* No need to ask for CD_PREVIEW_MLOOPCOL... */
142
143         return dataMask;
144 }
145
146 static bool dependsOnTime(ModifierData *md)
147 {
148         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
149
150         if (wmd->mask_texture)
151                 return BKE_texture_dependsOnTime(wmd->mask_texture);
152         return false;
153 }
154
155 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
156 {
157         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
158         walk(userData, ob, &wmd->mask_tex_map_obj, IDWALK_CB_NOP);
159 }
160
161 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
162 {
163         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
164
165         walk(userData, ob, (ID **)&wmd->mask_texture, IDWALK_CB_USER);
166
167         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
168 }
169
170 static void foreachTexLink(ModifierData *md, Object *ob, TexWalkFunc walk, void *userData)
171 {
172         walk(userData, ob, md, "mask_texture");
173 }
174
175 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
176 {
177         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
178         if (wmd->mask_tex_map_obj != NULL && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
179                 DEG_add_object_relation(ctx->node, wmd->mask_tex_map_obj, DEG_OB_COMP_TRANSFORM, "WeightVGMix Modifier");
180                 DEG_add_object_relation(ctx->node, wmd->mask_tex_map_obj, DEG_OB_COMP_GEOMETRY, "WeightVGMix Modifier");
181         }
182         if (wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL) {
183                 DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "WeightVGMix Modifier");
184                 DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_GEOMETRY, "WeightVGMix Modifier");
185         }
186 }
187
188 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
189 {
190         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
191         /* If no vertex group, bypass. */
192         return (wmd->defgrp_name_a[0] == '\0');
193 }
194
195 static Mesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
196 {
197         BLI_assert(mesh != NULL);
198
199         WeightVGMixModifierData *wmd = (WeightVGMixModifierData *) md;
200
201         MDeformVert *dvert = NULL;
202         MDeformWeight **dw1, **tdw1, **dw2, **tdw2;
203         float *org_w;
204         float *new_w;
205         int *tidx, *indices = NULL;
206         int numIdx = 0;
207         int i;
208         /* Flags. */
209 #if 0
210         const bool do_prev = (wmd->modifier.mode & eModifierMode_DoWeightPreview) != 0;
211 #endif
212
213         /* Get number of verts. */
214         const int numVerts = mesh->totvert;
215
216         /* Check if we can just return the original mesh.
217          * Must have verts and therefore verts assigned to vgroups to do anything useful!
218          */
219         if ((numVerts == 0) || BLI_listbase_is_empty(&ctx->object->defbase)) {
220                 return mesh;
221         }
222
223         /* Get vgroup idx from its name. */
224         const int defgrp_index = defgroup_name_index(ctx->object, wmd->defgrp_name_a);
225         if (defgrp_index == -1) {
226                 return mesh;
227         }
228         /* Get second vgroup idx from its name, if given. */
229         int defgrp_index_other = -1;
230         if (wmd->defgrp_name_b[0] != '\0') {
231                 defgrp_index_other = defgroup_name_index(ctx->object, wmd->defgrp_name_b);
232                 if (defgrp_index_other == -1) {
233                         return mesh;
234                 }
235         }
236
237         const bool has_mdef = CustomData_has_layer(&mesh->vdata, CD_MDEFORMVERT);
238         /* If no vertices were ever added to an object's vgroup, dvert might be NULL. */
239         if (!has_mdef) {
240                 /* If not affecting all vertices, just return. */
241                 if (wmd->mix_set != MOD_WVG_SET_ALL) {
242                         return mesh;
243                 }
244         }
245
246         Mesh *result;
247         BKE_id_copy_ex(
248                     NULL, &mesh->id, (ID **)&result,
249                     LIB_ID_CREATE_NO_MAIN |
250                     LIB_ID_CREATE_NO_USER_REFCOUNT |
251                     LIB_ID_CREATE_NO_DEG_TAG|
252                     LIB_ID_COPY_NO_PREVIEW,
253                     false);
254
255         if (has_mdef) {
256                 dvert = CustomData_get_layer(&result->vdata, CD_MDEFORMVERT);
257         }
258         else {
259                 /* Add a valid data layer! */
260                 dvert = CustomData_add_layer(&result->vdata, CD_MDEFORMVERT, CD_CALLOC, NULL, numVerts);
261         }
262         /* Ultimate security check. */
263         if (!dvert) {
264                 BKE_id_free(NULL, result);
265                 return mesh;
266         }
267
268         /* Find out which vertices to work on. */
269         tidx = MEM_malloc_arrayN(numVerts, sizeof(int), "WeightVGMix Modifier, tidx");
270         tdw1 = MEM_malloc_arrayN(numVerts, sizeof(MDeformWeight *), "WeightVGMix Modifier, tdw1");
271         tdw2 = MEM_malloc_arrayN(numVerts, sizeof(MDeformWeight *), "WeightVGMix Modifier, tdw2");
272         switch (wmd->mix_set) {
273                 case MOD_WVG_SET_A:
274                         /* All vertices in first vgroup. */
275                         for (i = 0; i < numVerts; i++) {
276                                 MDeformWeight *dw = defvert_find_index(&dvert[i], defgrp_index);
277                                 if (dw) {
278                                         tdw1[numIdx] = dw;
279                                         tdw2[numIdx] = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
280                                         tidx[numIdx++] = i;
281                                 }
282                         }
283                         break;
284                 case MOD_WVG_SET_B:
285                         /* All vertices in second vgroup. */
286                         for (i = 0; i < numVerts; i++) {
287                                 MDeformWeight *dw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
288                                 if (dw) {
289                                         tdw1[numIdx] = defvert_find_index(&dvert[i], defgrp_index);
290                                         tdw2[numIdx] = dw;
291                                         tidx[numIdx++] = i;
292                                 }
293                         }
294                         break;
295                 case MOD_WVG_SET_OR:
296                         /* All vertices in one vgroup or the other. */
297                         for (i = 0; i < numVerts; i++) {
298                                 MDeformWeight *adw = defvert_find_index(&dvert[i], defgrp_index);
299                                 MDeformWeight *bdw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
300                                 if (adw || bdw) {
301                                         tdw1[numIdx] = adw;
302                                         tdw2[numIdx] = bdw;
303                                         tidx[numIdx++] = i;
304                                 }
305                         }
306                         break;
307                 case MOD_WVG_SET_AND:
308                         /* All vertices in both vgroups. */
309                         for (i = 0; i < numVerts; i++) {
310                                 MDeformWeight *adw = defvert_find_index(&dvert[i], defgrp_index);
311                                 MDeformWeight *bdw = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
312                                 if (adw && bdw) {
313                                         tdw1[numIdx] = adw;
314                                         tdw2[numIdx] = bdw;
315                                         tidx[numIdx++] = i;
316                                 }
317                         }
318                         break;
319                 case MOD_WVG_SET_ALL:
320                 default:
321                         /* Use all vertices. */
322                         for (i = 0; i < numVerts; i++) {
323                                 tdw1[i] = defvert_find_index(&dvert[i], defgrp_index);
324                                 tdw2[i] = (defgrp_index_other >= 0) ? defvert_find_index(&dvert[i], defgrp_index_other) : NULL;
325                         }
326                         numIdx = -1;
327                         break;
328         }
329         if (numIdx == 0) {
330                 /* Use no vertices! Hence, return org data. */
331                 MEM_freeN(tdw1);
332                 MEM_freeN(tdw2);
333                 MEM_freeN(tidx);
334                 BKE_id_free(NULL, result);
335                 return mesh;
336         }
337         if (numIdx != -1) {
338                 indices = MEM_malloc_arrayN(numIdx, sizeof(int), "WeightVGMix Modifier, indices");
339                 memcpy(indices, tidx, sizeof(int) * numIdx);
340                 dw1 = MEM_malloc_arrayN(numIdx, sizeof(MDeformWeight *), "WeightVGMix Modifier, dw1");
341                 memcpy(dw1, tdw1, sizeof(MDeformWeight *) * numIdx);
342                 MEM_freeN(tdw1);
343                 dw2 = MEM_malloc_arrayN(numIdx, sizeof(MDeformWeight *), "WeightVGMix Modifier, dw2");
344                 memcpy(dw2, tdw2, sizeof(MDeformWeight *) * numIdx);
345                 MEM_freeN(tdw2);
346         }
347         else {
348                 /* Use all vertices. */
349                 numIdx = numVerts;
350                 /* Just copy MDeformWeight pointers arrays, they will be freed at the end. */
351                 dw1 = tdw1;
352                 dw2 = tdw2;
353         }
354         MEM_freeN(tidx);
355
356         org_w = MEM_malloc_arrayN(numIdx, sizeof(float), "WeightVGMix Modifier, org_w");
357         new_w = MEM_malloc_arrayN(numIdx, sizeof(float), "WeightVGMix Modifier, new_w");
358
359         /* Mix weights. */
360         for (i = 0; i < numIdx; i++) {
361                 float weight2;
362                 org_w[i] = dw1[i] ? dw1[i]->weight : wmd->default_weight_a;
363                 weight2  = dw2[i] ? dw2[i]->weight : wmd->default_weight_b;
364
365                 new_w[i] = mix_weight(org_w[i], weight2, wmd->mix_mode);
366         }
367
368         /* Do masking. */
369         weightvg_do_mask(numIdx, indices, org_w, new_w, ctx->object, result, wmd->mask_constant,
370                          wmd->mask_defgrp_name, wmd->modifier.scene, wmd->mask_texture,
371                          wmd->mask_tex_use_channel, wmd->mask_tex_mapping,
372                          wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);
373
374         /* Update (add to) vgroup.
375          * XXX Depending on the MOD_WVG_SET_xxx option chosen, we might have to add vertices to vgroup.
376          */
377         weightvg_update_vg(dvert, defgrp_index, dw1, numIdx, indices, org_w, true, -FLT_MAX, false, 0.0f);
378
379         /* If weight preview enabled... */
380 #if 0 /* XXX Currently done in mod stack :/ */
381         if (do_prev)
382                 DM_update_weight_mcol(ob, dm, 0, org_w, numIdx, indices);
383 #endif
384
385         /* Freeing stuff. */
386         MEM_freeN(org_w);
387         MEM_freeN(new_w);
388         MEM_freeN(dw1);
389         MEM_freeN(dw2);
390         MEM_SAFE_FREE(indices);
391
392         /* Return the vgroup-modified mesh. */
393         return result;
394 }
395
396
397 ModifierTypeInfo modifierType_WeightVGMix = {
398         /* name */              "VertexWeightMix",
399         /* structName */        "WeightVGMixModifierData",
400         /* structSize */        sizeof(WeightVGMixModifierData),
401         /* type */              eModifierTypeType_NonGeometrical,
402         /* flags */             eModifierTypeFlag_AcceptsMesh |
403                                 eModifierTypeFlag_SupportsMapping |
404                                 eModifierTypeFlag_SupportsEditmode |
405                                 eModifierTypeFlag_UsesPreview,
406
407         /* copyData */          modifier_copyData_generic,
408
409         /* deformVerts_DM */    NULL,
410         /* deformMatrices_DM */ NULL,
411         /* deformVertsEM_DM */  NULL,
412         /* deformMatricesEM_DM*/NULL,
413         /* applyModifier_DM */  NULL,
414         /* applyModifierEM_DM */NULL,
415
416         /* deformVerts */       NULL,
417         /* deformMatrices */    NULL,
418         /* deformVertsEM */     NULL,
419         /* deformMatricesEM */  NULL,
420         /* applyModifier */     applyModifier,
421         /* applyModifierEM */   NULL,
422
423         /* initData */          initData,
424         /* requiredDataMask */  requiredDataMask,
425         /* freeData */          NULL,
426         /* isDisabled */        isDisabled,
427         /* updateDepsgraph */   updateDepsgraph,
428         /* dependsOnTime */     dependsOnTime,
429         /* dependsOnNormals */  NULL,
430         /* foreachObjectLink */ foreachObjectLink,
431         /* foreachIDLink */     foreachIDLink,
432         /* foreachTexLink */    foreachTexLink,
433 };