Extract common modifier parameters into ModifierEvalContext struct
[blender.git] / source / blender / modifiers / intern / MOD_weightvgedit.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_weightvgedit.c
28  *  \ingroup modifiers
29  */
30
31 #include "BLI_utildefines.h"
32 #include "BLI_ghash.h"
33 #include "BLI_listbase.h"
34 #include "BLI_rand.h"
35
36 #include "DNA_color_types.h"      /* CurveMapping. */
37 #include "DNA_meshdata_types.h"
38 #include "DNA_modifier_types.h"
39 #include "DNA_object_types.h"
40
41 #include "BKE_cdderivedmesh.h"
42 #include "BKE_colortools.h"       /* CurveMapping. */
43 #include "BKE_deform.h"
44 #include "BKE_library.h"
45 #include "BKE_library_query.h"
46 #include "BKE_modifier.h"
47 #include "BKE_texture.h"          /* Texture masking. */
48
49 #include "DEG_depsgraph_build.h"
50
51 #include "MEM_guardedalloc.h"
52
53 #include "MOD_weightvg_util.h"
54 #include "MOD_modifiertypes.h"
55
56 /**************************************
57  * Modifiers functions.               *
58  **************************************/
59 static void initData(ModifierData *md)
60 {
61         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *) md;
62         wmd->edit_flags             = 0;
63         wmd->falloff_type           = MOD_WVG_MAPPING_NONE;
64         wmd->default_weight         = 0.0f;
65
66         wmd->cmap_curve             = curvemapping_add(1, 0.0, 0.0, 1.0, 1.0);
67         curvemapping_initialize(wmd->cmap_curve);
68
69         wmd->rem_threshold          = 0.01f;
70         wmd->add_threshold          = 0.01f;
71
72         wmd->mask_constant          = 1.0f;
73         wmd->mask_tex_use_channel   = MOD_WVG_MASK_TEX_USE_INT; /* Use intensity by default. */
74         wmd->mask_tex_mapping       = MOD_DISP_MAP_LOCAL;
75 }
76
77 static void freeData(ModifierData *md)
78 {
79         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *) md;
80         curvemapping_free(wmd->cmap_curve);
81 }
82
83 static void copyData(ModifierData *md, ModifierData *target)
84 {
85         WeightVGEditModifierData *wmd  = (WeightVGEditModifierData *) md;
86         WeightVGEditModifierData *twmd = (WeightVGEditModifierData *) target;
87
88         modifier_copyData_generic(md, target);
89
90         twmd->cmap_curve = curvemapping_copy(wmd->cmap_curve);
91 }
92
93 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
94 {
95         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *) md;
96         CustomDataMask dataMask = 0;
97
98         /* We need vertex groups! */
99         dataMask |= CD_MASK_MDEFORMVERT;
100
101         /* Ask for UV coordinates if we need them. */
102         if (wmd->mask_tex_mapping == MOD_DISP_MAP_UV)
103                 dataMask |= CD_MASK_MTFACE;
104
105         /* No need to ask for CD_PREVIEW_MLOOPCOL... */
106
107         return dataMask;
108 }
109
110 static bool dependsOnTime(ModifierData *md)
111 {
112         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *) md;
113
114         if (wmd->mask_texture)
115                 return BKE_texture_dependsOnTime(wmd->mask_texture);
116         return false;
117 }
118
119 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
120 {
121         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *) md;
122         walk(userData, ob, &wmd->mask_tex_map_obj, IDWALK_CB_NOP);
123 }
124
125 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
126 {
127         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *) md;
128
129         walk(userData, ob, (ID **)&wmd->mask_texture, IDWALK_CB_USER);
130
131         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
132 }
133
134 static void foreachTexLink(ModifierData *md, Object *ob, TexWalkFunc walk, void *userData)
135 {
136         walk(userData, ob, md, "mask_texture");
137 }
138
139 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
140 {
141         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *)md;
142         if (wmd->mask_tex_map_obj != NULL && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
143                 DEG_add_object_relation(ctx->node, wmd->mask_tex_map_obj, DEG_OB_COMP_TRANSFORM, "WeightVGEdit Modifier");
144         }
145         if (wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL) {
146                 DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "WeightVGEdit Modifier");
147         }
148 }
149
150 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
151 {
152         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *) md;
153         /* If no vertex group, bypass. */
154         return (wmd->defgrp_name[0] == '\0');
155 }
156
157 static DerivedMesh *applyModifier(ModifierData *md,
158                                   const ModifierEvalContext *ctx,
159                                   DerivedMesh *derivedData)
160 {
161         WeightVGEditModifierData *wmd = (WeightVGEditModifierData *) md;
162         DerivedMesh *dm = derivedData;
163         MDeformVert *dvert = NULL;
164         MDeformWeight **dw = NULL;
165         float *org_w; /* Array original weights. */
166         float *new_w; /* Array new weights. */
167         int numVerts;
168         int defgrp_index;
169         int i;
170         /* Flags. */
171         const bool do_add  = (wmd->edit_flags & MOD_WVG_EDIT_ADD2VG) != 0;
172         const bool do_rem  = (wmd->edit_flags & MOD_WVG_EDIT_REMFVG) != 0;
173         /* Only do weight-preview in Object, Sculpt and Pose modes! */
174 #if 0
175         const bool do_prev = (wmd->modifier.mode & eModifierMode_DoWeightPreview);
176 #endif
177
178         /* Get number of verts. */
179         numVerts = dm->getNumVerts(dm);
180
181         /* Check if we can just return the original mesh.
182          * Must have verts and therefore verts assigned to vgroups to do anything useful!
183          */
184         if ((numVerts == 0) || BLI_listbase_is_empty(&ctx->object->defbase))
185                 return dm;
186
187         /* Get vgroup idx from its name. */
188         defgrp_index = defgroup_name_index(ctx->object, wmd->defgrp_name);
189         if (defgrp_index == -1)
190                 return dm;
191
192         dvert = CustomData_duplicate_referenced_layer(&dm->vertData, CD_MDEFORMVERT, numVerts);
193         /* If no vertices were ever added to an object's vgroup, dvert might be NULL. */
194         if (!dvert) {
195                 /* If this modifier is not allowed to add vertices, just return. */
196                 if (!do_add)
197                         return dm;
198                 /* Else, add a valid data layer! */
199                 dvert = CustomData_add_layer(&dm->vertData, CD_MDEFORMVERT, CD_CALLOC, NULL, numVerts);
200                 /* Ultimate security check. */
201                 if (!dvert)
202                         return dm;
203         }
204
205         /* Get org weights, assuming 0.0 for vertices not in given vgroup. */
206         org_w = MEM_malloc_arrayN(numVerts, sizeof(float), "WeightVGEdit Modifier, org_w");
207         new_w = MEM_malloc_arrayN(numVerts, sizeof(float), "WeightVGEdit Modifier, new_w");
208         dw = MEM_malloc_arrayN(numVerts, sizeof(MDeformWeight *), "WeightVGEdit Modifier, dw");
209         for (i = 0; i < numVerts; i++) {
210                 dw[i] = defvert_find_index(&dvert[i], defgrp_index);
211                 if (dw[i]) {
212                         org_w[i] = new_w[i] = dw[i]->weight;
213                 }
214                 else {
215                         org_w[i] = new_w[i] = wmd->default_weight;
216                 }
217         }
218
219         /* Do mapping. */
220         if (wmd->falloff_type != MOD_WVG_MAPPING_NONE) {
221                 RNG *rng = NULL;
222
223                 if (wmd->falloff_type == MOD_WVG_MAPPING_RANDOM)
224                         rng = BLI_rng_new_srandom(BLI_ghashutil_strhash(ctx->object->id.name + 2));
225
226                 weightvg_do_map(numVerts, new_w, wmd->falloff_type, wmd->cmap_curve, rng);
227
228                 if (rng)
229                         BLI_rng_free(rng);
230         }
231
232         /* Do masking. */
233         weightvg_do_mask(numVerts, NULL, org_w, new_w, ctx->object, dm, wmd->mask_constant,
234                          wmd->mask_defgrp_name, wmd->modifier.scene, wmd->mask_texture,
235                          wmd->mask_tex_use_channel, wmd->mask_tex_mapping,
236                          wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);
237
238         /* Update/add/remove from vgroup. */
239         weightvg_update_vg(dvert, defgrp_index, dw, numVerts, NULL, org_w, do_add, wmd->add_threshold,
240                            do_rem, wmd->rem_threshold);
241
242         /* If weight preview enabled... */
243 #if 0 /* XXX Currently done in mod stack :/ */
244         if (do_prev)
245                 DM_update_weight_mcol(ob, dm, 0, org_w, 0, NULL);
246 #endif
247
248         /* Freeing stuff. */
249         MEM_freeN(org_w);
250         MEM_freeN(new_w);
251         MEM_freeN(dw);
252
253         /* Return the vgroup-modified mesh. */
254         return dm;
255 }
256
257
258 ModifierTypeInfo modifierType_WeightVGEdit = {
259         /* name */              "VertexWeightEdit",
260         /* structName */        "WeightVGEditModifierData",
261         /* structSize */        sizeof(WeightVGEditModifierData),
262         /* type */              eModifierTypeType_NonGeometrical,
263         /* flags */             eModifierTypeFlag_AcceptsMesh |
264                                 eModifierTypeFlag_SupportsMapping |
265                                 eModifierTypeFlag_SupportsEditmode |
266                                 eModifierTypeFlag_UsesPreview,
267
268         /* copyData */          copyData,
269
270         /* deformVerts_DM */    NULL,
271         /* deformMatrices_DM */ NULL,
272         /* deformVertsEM_DM */  NULL,
273         /* deformMatricesEM_DM*/NULL,
274         /* applyModifier_DM */  applyModifier,
275         /* applyModifierEM_DM */NULL,
276
277         /* deformVerts */       NULL,
278         /* deformMatrices */    NULL,
279         /* deformVertsEM */     NULL,
280         /* deformMatricesEM */  NULL,
281         /* applyModifier */     NULL,
282         /* applyModifierEM */   NULL,
283
284         /* initData */          initData,
285         /* requiredDataMask */  requiredDataMask,
286         /* freeData */          freeData,
287         /* isDisabled */        isDisabled,
288         /* updateDepsgraph */   updateDepsgraph,
289         /* dependsOnTime */     dependsOnTime,
290         /* dependsOnNormals */  NULL,
291         /* foreachObjectLink */ foreachObjectLink,
292         /* foreachIDLink */     foreachIDLink,
293         /* foreachTexLink */    foreachTexLink,
294 };