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