- mask_tex_map_obj --> mask_tex_map_object
[blender.git] / source / blender / modifiers / intern / MOD_weightvgedit.c
1 /*
2 * $Id$
3 *
4 * ***** BEGIN GPL LICENSE BLOCK *****
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software  Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 *
20 * The Original Code is Copyright (C) 2011 by Bastien Montagne.
21 * All rights reserved.
22 *
23 * Contributor(s): None yet.
24 *
25 * ***** END GPL LICENSE BLOCK *****
26 *
27 */
28
29 /*
30  * XXX I'd like to make modified weights visible in WeightPaint mode,
31  *     but couldn't figure a way to do this…
32  *     Maybe this will need changes in mesh_calc_modifiers (DerivedMesh.c)?
33  *     Or the WeightPaint mode code itself?
34  */
35
36 #include "BLI_utildefines.h"
37 #include "BLI_math.h"
38 #include "BLI_string.h"
39
40 #include "DNA_color_types.h"      /* CurveMapping. */
41 #include "DNA_mesh_types.h"
42 #include "DNA_meshdata_types.h"
43 #include "DNA_modifier_types.h"
44 #include "DNA_object_types.h"
45
46 #include "BKE_cdderivedmesh.h"
47 #include "BKE_colortools.h"       /* CurveMapping. */
48 #include "BKE_deform.h"
49 #include "BKE_mesh.h"
50 #include "BKE_modifier.h"
51 #include "BKE_texture.h"          /* Texture masking. */
52
53 #include "depsgraph_private.h"
54 #include "MEM_guardedalloc.h"
55 #include "MOD_util.h"
56 #include "MOD_weightvg_util.h"
57
58 /**************************************
59  * Modifiers functions.               *
60  **************************************/
61 static void initData(ModifierData *md)
62 {
63         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
64         wmd->edit_flags             = 0;
65         wmd->default_weight         = 0.0f;
66
67         wmd->cmap_curve             = curvemapping_add(1, 0.0, 0.0, 1.0, 1.0);
68         curvemapping_initialize(wmd->cmap_curve);
69
70         wmd->rem_threshold          = 0.01f;
71         wmd->add_threshold          = 0.01f;
72
73         wmd->mask_constant          = 1.0f;
74         wmd->mask_tex_use_channel   = MOD_WVG_MASK_TEX_USE_INT; /* Use intensity by default. */
75         wmd->mask_tex_mapping       = MOD_DISP_MAP_LOCAL;
76 }
77
78 static void freeData(ModifierData *md)
79 {
80         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
81         curvemapping_free(wmd->cmap_curve);
82 }
83
84 static void copyData(ModifierData *md, ModifierData *target)
85 {
86         WeightVGEditModifierData *wmd  = (WeightVGEditModifierData*) md;
87         WeightVGEditModifierData *twmd = (WeightVGEditModifierData*) target;
88
89         BLI_strncpy(twmd->defgrp_name, wmd->defgrp_name, sizeof(twmd->defgrp_name));
90
91         twmd->edit_flags             = wmd->edit_flags;
92         twmd->default_weight         = wmd->default_weight;
93
94         twmd->cmap_curve             = curvemapping_copy(wmd->cmap_curve);
95
96         twmd->add_threshold          = wmd->add_threshold;
97         twmd->rem_threshold          = wmd->rem_threshold;
98
99         twmd->mask_constant          = wmd->mask_constant;
100         BLI_strncpy(twmd->mask_defgrp_name, wmd->mask_defgrp_name, sizeof(twmd->mask_defgrp_name));
101         twmd->mask_texture           = wmd->mask_texture;
102         twmd->mask_tex_use_channel   = wmd->mask_tex_use_channel;
103         twmd->mask_tex_mapping       = wmd->mask_tex_mapping;
104         twmd->mask_tex_map_obj       = wmd->mask_tex_map_obj;
105         BLI_strncpy(twmd->mask_tex_uvlayer_name, wmd->mask_tex_uvlayer_name, sizeof(twmd->mask_tex_uvlayer_name));
106 }
107
108 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
109 {
110         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
111         CustomDataMask dataMask = 0;
112
113         /* We need vertex groups! */
114         dataMask |= CD_MASK_MDEFORMVERT;
115
116         /* Ask for UV coordinates if we need them. */
117         if(wmd->mask_tex_mapping == MOD_DISP_MAP_UV)
118                 dataMask |= CD_MASK_MTFACE;
119
120         return dataMask;
121 }
122
123 static int dependsOnTime(ModifierData *md)
124 {
125         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
126
127         if(wmd->mask_texture)
128                 return BKE_texture_dependsOnTime(wmd->mask_texture);
129         return 0;
130 }
131
132 static void foreachObjectLink(ModifierData *md, Object *ob,
133                               void (*walk)(void *userData, Object *ob, Object **obpoin),
134                               void *userData)
135 {
136         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
137         walk(userData, ob, &wmd->mask_tex_map_obj);
138 }
139
140 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
141 {
142         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
143
144         walk(userData, ob, (ID **)&wmd->mask_texture);
145
146         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
147 }
148
149 static void foreachTexLink(ModifierData *md, Object *ob, TexWalkFunc walk, void *userData)
150 {
151         walk(userData, ob, md, "mask_texture");
152 }
153
154 static void updateDepgraph(ModifierData *md, DagForest *forest, struct Scene *UNUSED(scene),
155                            Object *UNUSED(ob), DagNode *obNode)
156 {
157         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
158         DagNode *curNode;
159
160         if(wmd->mask_tex_map_obj && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
161                 curNode = dag_get_node(forest, wmd->mask_tex_map_obj);
162
163                 dag_add_relation(forest, curNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
164                                  "WeightVGEdit Modifier");
165         }
166
167         if(wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL)
168                 dag_add_relation(forest, obNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
169                                  "WeightVGEdit Modifier");
170 }
171
172 static int isDisabled(ModifierData *md, int UNUSED(useRenderParams))
173 {
174         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
175         /* If no vertex group, bypass. */
176         return (wmd->defgrp_name == NULL);
177 }
178
179 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *derivedData,
180                                   int UNUSED(useRenderParams), int UNUSED(isFinalCalc))
181 {
182         WeightVGEditModifierData *wmd = (WeightVGEditModifierData*) md;
183         DerivedMesh *dm = derivedData, *ret = NULL;
184 #if 0
185         Mesh *ob_m = NULL;
186 #endif
187         MDeformVert *dvert = NULL;
188         float *org_w = NULL; /* Array original weights. */
189         float *new_w = NULL; /* Array new weights. */
190         int numVerts;
191         int defgrp_idx;
192         int i;
193         char rel_ret = 0; /* Boolean, whether we have to release ret dm or not, when not using it! */
194         float *mapf = NULL; /* Cache for mapping factors. */
195         /* Flags. */
196         char do_map = wmd->edit_flags & MOD_WVG_EDIT_CMAP;
197         char do_add = wmd->edit_flags & MOD_WVG_EDIT_ADD2VG;
198         char do_rem = wmd->edit_flags & MOD_WVG_EDIT_REMFVG;
199
200         /* Get number of verts. */
201         numVerts = dm->getNumVerts(dm);
202
203         /* Check if we can just return the original mesh.
204          * Must have verts and therefore verts assigned to vgroups to do anything useful!
205          */
206         if ((numVerts == 0) || (ob->defbase.first == NULL))
207                 return dm;
208
209         /* Get vgroup idx from its name. */
210         defgrp_idx = defgroup_name_index(ob, wmd->defgrp_name);
211         if (defgrp_idx < 0)
212                 return dm;
213
214         /* XXX All this to avoid copying dm when not needed… However, it nearly doubles compute
215          *     time! See scene 5 of the WeighVG test file…
216          */
217 #if 0
218         /* Get actual dverts (ie vertex group data). */
219         dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
220         /* If no dverts, return unmodified data… */
221         if (dvert == NULL)
222                 return dm;
223
224         /* Get org mesh, only to test whether affected cdata layer has already been copied
225          * somewhere up in the modifiers stack.
226          */
227         ob_m = get_mesh(ob);
228         if (ob_m == NULL)
229                 return dm;
230
231         /* Create a copy of our dmesh, only if our affected cdata layer is the same as org mesh. */
232         if (dvert == CustomData_get_layer(&ob_m->vdata, CD_MDEFORMVERT)) {
233                 /* XXX Seems to create problems with weightpaint mode???
234                  *     I'm missing something here, I guess…
235                  */
236 //              DM_set_only_copy(dm, CD_MASK_MDEFORMVERT); /* Only copy defgroup layer. */
237                 ret = CDDM_copy(dm);
238                 dvert = ret->getVertDataArray(ret, CD_MDEFORMVERT);
239                 if (dvert == NULL) {
240                         ret->release(ret);
241                         return dm;
242                 }
243                 rel_ret = 1;
244         }
245         else
246                 ret = dm;
247 #else
248         ret = CDDM_copy(dm);
249         rel_ret = 1;
250         dvert = ret->getVertDataArray(ret, CD_MDEFORMVERT);
251         if (dvert == NULL) {
252                 if (rel_ret)
253                         ret->release(ret);
254                 return dm;
255         }
256 #endif
257
258         /* Get org weights, assuming 0.0 for vertices not in given vgroup. */
259         org_w = MEM_mallocN(sizeof(float) * numVerts, "WeightVGEdit Modifier, org_w");
260         new_w = MEM_mallocN(sizeof(float) * numVerts, "WeightVGEdit Modifier, org_w");
261         for (i = 0; i < numVerts; i++) {
262                 int j;
263                 org_w[i] = new_w[i] = wmd->default_weight;
264                 for (j = 0; j < dvert[i].totweight; j++) {
265                         if(dvert[i].dw[j].def_nr == defgrp_idx) {
266                                 org_w[i] = new_w[i] = dvert[i].dw[j].weight;
267                                 break;
268                         }
269                 }
270                 /* Do mapping. */
271                 if (do_map)
272                         new_w[i] = curvemapping_evaluateF(wmd->cmap_curve, 0, new_w[i]);
273         }
274
275         /* Do masking. */
276         weightvg_do_mask(numVerts, NULL, org_w, new_w, ob, ret, wmd->mask_constant,
277                          wmd->mask_defgrp_name, wmd->mask_texture, wmd->mask_tex_use_channel,
278                          wmd->mask_tex_mapping, wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);
279
280         /* Update/add/remove from vgroup. */
281         weightvg_update_vg(dvert, defgrp_idx, numVerts, NULL, org_w, do_add, wmd->add_threshold,
282                            do_rem, wmd->rem_threshold);
283
284         /* Freeing stuff. */
285         if (org_w)
286                 MEM_freeN(org_w);
287         if (new_w)
288                 MEM_freeN(new_w);
289         if (mapf)
290                 MEM_freeN(mapf);
291
292         /* Return the vgroup-modified mesh. */
293         return ret;
294 }
295
296 static DerivedMesh *applyModifierEM(ModifierData *md, Object *ob,
297                                     struct EditMesh *UNUSED(editData),
298                                     DerivedMesh *derivedData)
299 {
300         return applyModifier(md, ob, derivedData, 0, 1);
301 }
302
303
304 ModifierTypeInfo modifierType_WeightVGEdit = {
305         /* name */              "WeightVGEdit",
306         /* structName */        "WeightVGEditModifierData",
307         /* structSize */        sizeof(WeightVGEditModifierData),
308         /* type */              eModifierTypeType_Nonconstructive,
309         /* flags */             eModifierTypeFlag_AcceptsMesh
310 /*                             |eModifierTypeFlag_SupportsMapping*/
311                                |eModifierTypeFlag_SupportsEditmode,
312
313         /* copyData */          copyData,
314         /* deformVerts */       NULL,
315         /* deformMatrices */    NULL,
316         /* deformVertsEM */     NULL,
317         /* deformMatricesEM */  NULL,
318         /* applyModifier */     applyModifier,
319         /* applyModifierEM */   applyModifierEM,
320         /* initData */          initData,
321         /* requiredDataMask */  requiredDataMask,
322         /* freeData */          freeData,
323         /* isDisabled */        isDisabled,
324         /* updateDepgraph */    updateDepgraph,
325         /* dependsOnTime */     dependsOnTime,
326         /* dependsOnNormals */  NULL,
327         /* foreachObjectLink */ foreachObjectLink,
328         /* foreachIDLink */     foreachIDLink,
329         /* foreachTexLink */    foreachTexLink,
330 };