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