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