Merging r38740 through r38764 from trunk into vgroup_modifiers.
[blender.git] / source / blender / modifiers / intern / MOD_weightvgproximity.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 #include "BLI_editVert.h"
40
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_deform.h"
48 #include "BKE_mesh.h"
49 #include "BKE_modifier.h"
50 #include "BKE_shrinkwrap.h"       /* For SpaceTransform stuff. */
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  * Util functions.                    *
60  **************************************/
61
62 /* Util macro. */
63 #define OUT_OF_MEMORY() ((void)printf("WeightVGProximity: Out of memory.\n"))
64
65 /**
66  * Returns the squared distance between two given points.
67  */
68 static float squared_dist(const float *a, const float *b)
69 {
70         float tmp[3];
71         VECSUB(tmp, a, b);
72         return INPR(tmp, tmp);
73 }
74
75 /**
76  * Find nearest vertex and/or edge and/or face, for each vertex (adapted from shrinkwrap.c).
77  */
78 static void get_vert2geom_distance(int numVerts, float (*v_cos)[3],
79                                    float *dist_v, float *dist_e, float *dist_f,
80                                    DerivedMesh *target, const SpaceTransform *loc2trgt)
81 {
82         int i;
83         BVHTreeFromMesh treeData_v = NULL_BVHTreeFromMesh;
84         BVHTreeFromMesh treeData_e = NULL_BVHTreeFromMesh;
85         BVHTreeFromMesh treeData_f = NULL_BVHTreeFromMesh;
86         BVHTreeNearest  nearest_v  = NULL_BVHTreeNearest;
87         BVHTreeNearest  nearest_e  = NULL_BVHTreeNearest;
88         BVHTreeNearest  nearest_f  = NULL_BVHTreeNearest;
89
90         if (dist_v) {
91                 /* Create a bvh-tree of the given target's verts. */
92                 bvhtree_from_mesh_verts(&treeData_v, target, 0.0, 2, 6);
93                 if(treeData_v.tree == NULL) {
94                         OUT_OF_MEMORY();
95                         return;
96                 }
97         }
98         if (dist_e) {
99                 /* Create a bvh-tree of the given target's edges. */
100                 bvhtree_from_mesh_edges(&treeData_e, target, 0.0, 2, 6);
101                 if(treeData_e.tree == NULL) {
102                         OUT_OF_MEMORY();
103                         return;
104                 }
105         }
106         if (dist_f) {
107                 /* Create a bvh-tree of the given target's faces. */
108                 bvhtree_from_mesh_faces(&treeData_f, target, 0.0, 2, 6);
109                 if(treeData_f.tree == NULL) {
110                         OUT_OF_MEMORY();
111                         return;
112                 }
113         }
114
115         /* Setup nearest. */
116         nearest_v.index = nearest_e.index = nearest_f.index = -1;
117         /*nearest_v.dist  = nearest_e.dist  = nearest_f.dist  = FLT_MAX;*/
118         /* Find the nearest vert/edge/face. */
119 #ifndef __APPLE__
120 #pragma omp parallel for default(none) private(i) firstprivate(nearest_v,nearest_e,nearest_f) \
121                          shared(treeData_v,treeData_e,treeData_f,numVerts,v_cos,dist_v,dist_e, \
122                                 dist_f,loc2trgt) \
123                          schedule(static)
124 #endif
125         for (i = 0; i < numVerts; ++i) {
126                 float tmp_co[3];
127
128                 /* Convert the vertex to tree coordinates. */
129                 VECCOPY(tmp_co, v_cos[i]);
130                 space_transform_apply(loc2trgt, tmp_co);
131
132                 /* Use local proximity heuristics (to reduce the nearest search).
133                  *
134                  * If we already had an hit before, we assume this vertex is going to have a close hit to
135                  * that other vertex, so we can initiate the "nearest.dist" with the expected value to that
136                  * last hit.
137                  * This will lead in prunning of the search tree.
138                  */
139                 if (dist_v) {
140                         nearest_v.dist = nearest_v.index != -1 ? squared_dist(tmp_co, nearest_v.co) : FLT_MAX;
141                         /* Compute and store result. If invalid (-1 idx), keep FLT_MAX dist. */
142                         BLI_bvhtree_find_nearest(treeData_v.tree, tmp_co, &nearest_v, treeData_v.nearest_callback, &treeData_v);
143                         dist_v[i] = sqrtf(nearest_v.dist);
144                 }
145                 if (dist_e) {
146                         nearest_e.dist = nearest_e.index != -1 ? squared_dist(tmp_co, nearest_e.co) : FLT_MAX;
147                         /* Compute and store result. If invalid (-1 idx), keep FLT_MAX dist. */
148                         BLI_bvhtree_find_nearest(treeData_e.tree, tmp_co, &nearest_e, treeData_e.nearest_callback, &treeData_e);
149                         dist_e[i] = sqrtf(nearest_e.dist);
150                 }
151                 if (dist_f) {
152                         nearest_f.dist = nearest_f.index != -1 ? squared_dist(tmp_co, nearest_f.co) : FLT_MAX;
153                         /* Compute and store result. If invalid (-1 idx), keep FLT_MAX dist. */
154                         BLI_bvhtree_find_nearest(treeData_f.tree, tmp_co, &nearest_f, treeData_f.nearest_callback, &treeData_f);
155                         dist_f[i] = sqrtf(nearest_f.dist);
156                 }
157         }
158
159         if (dist_v)
160                 free_bvhtree_from_mesh(&treeData_v);
161         if (dist_e)
162                 free_bvhtree_from_mesh(&treeData_e);
163         if (dist_f)
164                 free_bvhtree_from_mesh(&treeData_f);
165 }
166
167 /**
168  * Returns the real distance between a vertex and another reference object.
169  * Note that it works in final world space (i.e. with constraints etc. applied).
170  */
171 static void get_vert2ob_distance(int numVerts, float (*v_cos)[3], float *dist,
172                                  const Object* ob, const Object* obr)
173 {
174         /* Vertex and ref object coordinates. */
175         float v_wco[3],
176               or_wco[3],
177               or_wro[3][3], /*unused*/
178               or_wsz[3];    /*unused*/
179         int i;
180
181         /* Get world-coordinates of the reference object (constraints and anim included).
182          * We also get rotation and scale, even though we do not want them…
183          */
184         mat4_to_loc_rot_size(or_wco, or_wro, or_wsz, (float (*)[4])obr->obmat);
185
186         for (i = 0; i < numVerts; i++) {
187                 /* Get world-coordinates of the vertex (constraints and anim included). */
188                 mul_v3_m4v3(v_wco, (float (*)[4])ob->obmat, v_cos[i]);
189                 /* Return distance between both coordinates. */
190                 dist[i] = len_v3v3(v_wco, or_wco);
191         }
192 }
193
194 /**
195  * Returns the real distance between an object and another reference object.
196  * Note that it works in final world space (i.e. with constraints etc. applied).
197  */
198 static float get_ob2ob_distance(const Object* ob, const Object* obr)
199 {
200         return len_v3v3(ob->obmat[3], obr->obmat[3]); 
201 }
202
203 /**************************************
204  * Modifiers functions.               *
205  **************************************/
206 static void initData(ModifierData *md)
207 {
208         WeightVGProximityModifierData *wmd = (WeightVGProximityModifierData*) md;
209
210         wmd->proximity_mode       = MOD_WVG_PROXIMITY_OBJ2OBJDIST;
211         wmd->proximity_flags      = MOD_WVG_PROXIMITY_O2VD_VERTS;
212
213         wmd->mask_constant        = 1.0f;
214         wmd->mask_tex_use_channel = MOD_WVG_MASK_TEX_USE_INT; /* Use intensity by default. */
215         wmd->mask_tex_mapping     = MOD_DISP_MAP_LOCAL;
216 }
217
218 static void copyData(ModifierData *md, ModifierData *target)
219 {
220         WeightVGProximityModifierData *wmd  = (WeightVGProximityModifierData*) md;
221         WeightVGProximityModifierData *twmd = (WeightVGProximityModifierData*) target;
222
223         BLI_strncpy(twmd->defgrp_name, wmd->defgrp_name, sizeof(twmd->defgrp_name));
224         twmd->proximity_mode         = wmd->proximity_mode;
225         twmd->proximity_flags        = wmd->proximity_flags;
226         twmd->proximity_ob_target    = wmd->proximity_ob_target;
227
228         twmd->mask_constant          = wmd->mask_constant;
229         BLI_strncpy(twmd->mask_defgrp_name, wmd->mask_defgrp_name, sizeof(twmd->mask_defgrp_name));
230         twmd->mask_texture           = wmd->mask_texture;
231         twmd->mask_tex_use_channel   = wmd->mask_tex_use_channel;
232         twmd->mask_tex_mapping       = wmd->mask_tex_mapping;
233         twmd->mask_tex_map_obj       = wmd->mask_tex_map_obj;
234         BLI_strncpy(twmd->mask_tex_uvlayer_name, wmd->mask_tex_uvlayer_name,
235                     sizeof(twmd->mask_tex_uvlayer_name));
236 }
237
238 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
239 {
240         WeightVGProximityModifierData *wmd = (WeightVGProximityModifierData*) md;
241         CustomDataMask dataMask = 0;
242
243         /* We need vertex groups! */
244         dataMask |= CD_MASK_MDEFORMVERT;
245
246         /* Ask for UV coordinates if we need them. */
247         if(wmd->mask_tex_mapping == MOD_DISP_MAP_UV)
248                 dataMask |= CD_MASK_MTFACE;
249
250         return dataMask;
251 }
252
253 static int dependsOnTime(ModifierData *md)
254 {
255         WeightVGProximityModifierData *wmd = (WeightVGProximityModifierData*) md;
256
257         if(wmd->mask_texture)
258                 return BKE_texture_dependsOnTime(wmd->mask_texture);
259         return 0;
260 }
261
262 static void foreachObjectLink(ModifierData *md, Object *ob,
263                               void (*walk)(void *userData, Object *ob, Object **obpoin),
264                               void *userData)
265 {
266         WeightVGProximityModifierData *wmd = (WeightVGProximityModifierData*) md;
267         walk(userData, ob, &wmd->proximity_ob_target);
268         walk(userData, ob, &wmd->mask_tex_map_obj);
269 }
270
271 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
272 {
273         WeightVGProximityModifierData *wmd = (WeightVGProximityModifierData*) md;
274
275         walk(userData, ob, (ID **)&wmd->mask_texture);
276
277         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
278 }
279
280 static void updateDepgraph(ModifierData *md, DagForest *forest, struct Scene *UNUSED(scene),
281                            Object *UNUSED(ob), DagNode *obNode)
282 {
283         WeightVGProximityModifierData *wmd = (WeightVGProximityModifierData*) md;
284         DagNode *curNode;
285
286         if (wmd->proximity_ob_target) {
287                 curNode = dag_get_node(forest, wmd->proximity_ob_target);
288                 dag_add_relation(forest, curNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
289                                  "WeightVGProximity Modifier");
290         }
291
292         if(wmd->mask_tex_map_obj && wmd->mask_tex_mapping == MOD_DISP_MAP_OBJECT) {
293                 curNode = dag_get_node(forest, wmd->mask_tex_map_obj);
294
295                 dag_add_relation(forest, curNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
296                                  "WeightVGProximity Modifier");
297         }
298
299         if(wmd->mask_tex_mapping == MOD_DISP_MAP_GLOBAL)
300                 dag_add_relation(forest, obNode, obNode, DAG_RL_DATA_DATA|DAG_RL_OB_DATA,
301                                  "WeightVGProximity Modifier");
302 }
303
304 static int isDisabled(ModifierData *md, int UNUSED(useRenderParams))
305 {
306         WeightVGProximityModifierData *wmd = (WeightVGProximityModifierData*) md;
307         /* If no vertex group, bypass. */
308         if (wmd->defgrp_name == NULL) return 1;
309         /* If no target object, bypass. */
310         return (wmd->proximity_ob_target == NULL);
311 }
312
313 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, DerivedMesh *derivedData,
314                                   int UNUSED(useRenderParams), int UNUSED(isFinalCalc))
315 {
316         WeightVGProximityModifierData *wmd = (WeightVGProximityModifierData*) md;
317         DerivedMesh *dm = derivedData, *ret = NULL;
318         Mesh *ob_m = NULL;
319         MDeformVert *dvert = NULL;
320         int numVerts;
321         float (*v_cos)[3] = NULL; /* The vertices coordinates. */
322         Object *obr = NULL; /* Our target object. */
323         int defgrp_idx;
324         float *tw = NULL;
325         float *org_w = NULL;
326         float *new_w =NULL;
327         int *tidx, *indices = NULL;
328         int numIdx = 0;
329         int i, j;
330         char rel_ret = 0; /* Boolean, whether we have to release ret dm or not, when not using it! */
331
332         /* Get number of verts. */
333         numVerts = dm->getNumVerts(dm);
334
335         /* Check if we can just return the original mesh.
336          * Must have verts and therefore verts assigned to vgroups to do anything useful!
337          */
338         if ((numVerts == 0) || (ob->defbase.first == NULL))
339                 return dm;
340
341         /* Get our target object. */
342         obr = wmd->proximity_ob_target;
343         if (obr == NULL)
344                 return dm;
345
346         /* Get vgroup idx from its name. */
347         defgrp_idx = defgroup_name_index(ob, wmd->defgrp_name);
348         if (defgrp_idx < 0)
349                 return dm;
350
351         /* XXX All this to avoid copying dm when not needed… However, it nearly doubles compute
352          *     time! See scene 5 of the WeighVG test file…
353          */
354 #if 0
355         /* Get actual dverts (ie vertex group data). */
356         dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
357         /* If no dverts, return unmodified data… */
358         if (dvert == NULL)
359                 return dm;
360
361         /* Get org mesh, only to test whether affected cdata layer has already been copied
362          * somewhere up in the modifiers stack.
363          */
364         ob_m = get_mesh(ob);
365         if (ob_m == NULL)
366                 return dm;
367
368         /* Create a copy of our dmesh, only if our affected cdata layer is the same as org mesh. */
369         if (dvert == CustomData_get_layer(&ob_m->vdata, CD_MDEFORMVERT)) {
370                 /* XXX Seems to create problems with weightpaint mode???
371                  *     I’m missing something here, I guess…
372                  */
373 //              DM_set_only_copy(dm, CD_MASK_MDEFORMVERT); /* Only copy defgroup layer. */
374                 ret = CDDM_copy(dm);
375                 dvert = ret->getVertDataArray(ret, CD_MDEFORMVERT);
376                 if (dvert == NULL) {
377                         ret->release(ret);
378                         return dm;
379                 }
380                 rel_ret = 1;
381         }
382         else
383                 ret = dm;
384 #else
385         ret = CDDM_copy(dm);
386         rel_ret = 1;
387         dvert = ret->getVertDataArray(ret, CD_MDEFORMVERT);
388         if (dvert == NULL) {
389                 if (rel_ret)
390                         ret->release(ret);
391                 return dm;
392         }
393 #endif
394
395         /* Find out which vertices to work on (all vertices in vgroup), and get their relevant weight.
396          */
397         tidx = MEM_mallocN(sizeof(int) * numVerts, "WeightVGProximity Modifier, tidx");
398         tw = MEM_mallocN(sizeof(float) * numVerts, "WeightVGProximity Modifier, tw");
399         for (i = 0; i < numVerts; i++) {
400                 for (j = 0; j < dvert[i].totweight; j++) {
401                         if(dvert[i].dw[j].def_nr == defgrp_idx) {
402                                 tidx[numIdx] = i;
403                                 tw[numIdx++] = dvert[i].dw[j].weight;
404                                 break;
405                         }
406                 }
407         }
408         indices = MEM_mallocN(sizeof(int) * numIdx, "WeightVGProximity Modifier, indices");
409         memcpy(indices, tidx, sizeof(int) * numIdx);
410         org_w = MEM_mallocN(sizeof(float) * numIdx, "WeightVGProximity Modifier, org_w");
411         new_w = MEM_mallocN(sizeof(float) * numIdx, "WeightVGProximity Modifier, new_w");
412         memcpy(org_w, tw, sizeof(float) * numIdx);
413         MEM_freeN(tidx);
414         MEM_freeN(tw);
415
416         /* Get our vertex coordinates. */
417         v_cos = MEM_mallocN(sizeof(float[3]) * numIdx, "WeightVGProximity Modifier, v_cos");
418         for (i = 0; i < numIdx; i++)
419                 ret->getVertCo(ret, indices[i], v_cos[i]);
420
421         /* Compute wanted distances. */
422         if (wmd->proximity_mode == MOD_WVG_PROXIMITY_OBJ2OBJDIST) {
423                 float dist = get_ob2ob_distance(ob, obr);
424                 for(i = 0; i < numIdx; i++)
425                         new_w[i] = dist;
426         }
427         else if (wmd->proximity_mode == MOD_WVG_PROXIMITY_OBJ2VERTDIST) {
428                 char use_trgt_verts = (wmd->proximity_flags & MOD_WVG_PROXIMITY_O2VD_VERTS);
429                 char use_trgt_edges = (wmd->proximity_flags & MOD_WVG_PROXIMITY_O2VD_EDGES);
430                 char use_trgt_faces = (wmd->proximity_flags & MOD_WVG_PROXIMITY_O2VD_FACES);
431
432                 if (use_trgt_verts || use_trgt_edges || use_trgt_faces) {
433                         DerivedMesh *target_dm = obr->derivedFinal;
434                         if (!target_dm) {
435                                 if (ELEM3(obr->type, OB_CURVE, OB_SURF, OB_FONT))
436                                         target_dm = CDDM_from_curve(obr);
437                                 else if (obr->type == OB_MESH) {
438                                         Mesh *me = (Mesh*)obr->data;
439                                         if (me->edit_mesh)
440                                                 target_dm = CDDM_from_editmesh((EditMesh*)me->edit_mesh, me);
441                                         else
442                                                 target_dm = CDDM_from_mesh(me, obr);
443                                 }
444                         }
445
446                         /* We must check that we do have a valid target_dm! */
447                         if (target_dm) {
448                                 SpaceTransform loc2trgt;
449                                 float *dists_v = use_trgt_verts ? MEM_mallocN(sizeof(float) * numIdx, "WeightVGProximity Modifier, dists_v") : NULL;
450                                 float *dists_e = use_trgt_edges ? MEM_mallocN(sizeof(float) * numIdx, "WeightVGProximity Modifier, dists_e") : NULL;
451                                 float *dists_f = use_trgt_faces ? MEM_mallocN(sizeof(float) * numIdx, "WeightVGProximity Modifier, dists_f") : NULL;
452
453                                 space_transform_setup(&loc2trgt, ob, obr);
454                                 get_vert2geom_distance(numIdx, v_cos, dists_v, dists_e, dists_f,
455                                                        target_dm, &loc2trgt);
456                                 for(i = 0; i < numIdx; i++) {
457                                         new_w[i] = dists_v ? dists_v[i] : FLT_MAX;
458                                         new_w[i] = dists_e ? minf(dists_e[i], new_w[i]) : new_w[i];
459                                         new_w[i] = dists_f ? minf(dists_f[i], new_w[i]) : new_w[i];
460                                 }
461                         }
462                         /* Else, fall back to default obj2vert behavior. */
463                         else
464                                 get_vert2ob_distance(numIdx, v_cos, new_w, ob, obr);
465                 }
466                 else
467                         get_vert2ob_distance(numIdx, v_cos, new_w, ob, obr);
468         }
469
470         /* Do masking. */
471         weightvg_do_mask(numIdx, indices, org_w, new_w, ob, ret, wmd->mask_constant,
472                          wmd->mask_defgrp_name, wmd->mask_texture, wmd->mask_tex_use_channel,
473                          wmd->mask_tex_mapping, wmd->mask_tex_map_obj, wmd->mask_tex_uvlayer_name);
474
475         /* Update vgroup. Note we never add nor remove vertices from vgroup here. */
476         weightvg_update_vg(dvert, defgrp_idx, numIdx, indices, org_w, 0, 0.0f, 0, 0.0f);
477
478         /* Freeing stuff. */
479         if (org_w)
480                 MEM_freeN(org_w);
481         if (new_w)
482                 MEM_freeN(new_w);
483         if (indices)
484                 MEM_freeN(indices);
485         if (v_cos)
486                 MEM_freeN(v_cos);
487
488         /* Return the vgroup-modified mesh. */
489         return ret;
490 }
491
492 static DerivedMesh *applyModifierEM(ModifierData *md, Object *ob,
493                                     struct EditMesh *UNUSED(editData),
494                                     DerivedMesh *derivedData)
495 {
496         return applyModifier(md, ob, derivedData, 0, 1);
497 }
498
499
500 ModifierTypeInfo modifierType_WeightVGProximity = {
501         /* name */              "WeightVGProximity",
502         /* structName */        "WeightVGProximityModifierData",
503         /* structSize */        sizeof(WeightVGProximityModifierData),
504         /* type */              eModifierTypeType_Nonconstructive,
505         /* flags */             eModifierTypeFlag_AcceptsMesh
506                                |eModifierTypeFlag_SupportsMapping
507                                |eModifierTypeFlag_SupportsEditmode,
508
509         /* copyData */          copyData,
510         /* deformVerts */       NULL,
511         /* deformMatrices */    NULL,
512         /* deformVertsEM */     NULL,
513         /* deformMatricesEM */  NULL,
514         /* applyModifier */     applyModifier,
515         /* applyModifierEM */   applyModifierEM,
516         /* initData */          initData,
517         /* requiredDataMask */  requiredDataMask,
518         /* freeData */          NULL,
519         /* isDisabled */        isDisabled,
520         /* updateDepgraph */    updateDepgraph,
521         /* dependsOnTime */     dependsOnTime,
522         /* dependsOnNormals */  NULL,
523         /* foreachObjectLink */ foreachObjectLink,
524         /* foreachIDLink */     foreachIDLink,
525 };
526