Merge branch 'master' into blender2.8
[blender.git] / source / blender / modifiers / intern / MOD_meshdeform.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) 2005 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Dunbar
22  *                 Ton Roosendaal,
23  *                 Ben Batt,
24  *                 Brecht Van Lommel,
25  *                 Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 /** \file blender/modifiers/intern/MOD_meshdeform.c
32  *  \ingroup modifiers
33  */
34
35 #include "DNA_meshdata_types.h"
36 #include "DNA_object_types.h"
37 #include "DNA_scene_types.h"
38
39 #include "BLI_math.h"
40 #include "BLI_task.h"
41 #include "BLI_utildefines.h"
42
43 #include "BKE_cdderivedmesh.h"
44 #include "BKE_global.h"
45 #include "BKE_library_query.h"
46 #include "BKE_modifier.h"
47 #include "BKE_deform.h"
48 #include "BKE_editmesh.h"
49
50 #include "MEM_guardedalloc.h"
51
52 #include "MOD_util.h"
53
54 #ifdef __SSE2__
55 #  include <emmintrin.h>
56 #endif
57
58 static void initData(ModifierData *md)
59 {
60         MeshDeformModifierData *mmd = (MeshDeformModifierData *) md;
61
62         mmd->gridsize = 5;
63 }
64
65 static void freeData(ModifierData *md)
66 {
67         MeshDeformModifierData *mmd = (MeshDeformModifierData *) md;
68
69         if (mmd->bindinfluences) MEM_freeN(mmd->bindinfluences);
70         if (mmd->bindoffsets) MEM_freeN(mmd->bindoffsets);
71         if (mmd->bindcagecos) MEM_freeN(mmd->bindcagecos);
72         if (mmd->dyngrid) MEM_freeN(mmd->dyngrid);
73         if (mmd->dyninfluences) MEM_freeN(mmd->dyninfluences);
74         if (mmd->dynverts) MEM_freeN(mmd->dynverts);
75         if (mmd->bindweights) MEM_freeN(mmd->bindweights);  /* deprecated */
76         if (mmd->bindcos) MEM_freeN(mmd->bindcos);  /* deprecated */
77 }
78
79 static void copyData(ModifierData *md, ModifierData *target)
80 {
81         MeshDeformModifierData *mmd = (MeshDeformModifierData *) md;
82         MeshDeformModifierData *tmmd = (MeshDeformModifierData *) target;
83
84         modifier_copyData_generic(md, target);
85
86         if (mmd->bindinfluences) tmmd->bindinfluences = MEM_dupallocN(mmd->bindinfluences);
87         if (mmd->bindoffsets) tmmd->bindoffsets = MEM_dupallocN(mmd->bindoffsets);
88         if (mmd->bindcagecos) tmmd->bindcagecos = MEM_dupallocN(mmd->bindcagecos);
89         if (mmd->dyngrid) tmmd->dyngrid = MEM_dupallocN(mmd->dyngrid);
90         if (mmd->dyninfluences) tmmd->dyninfluences = MEM_dupallocN(mmd->dyninfluences);
91         if (mmd->dynverts) tmmd->dynverts = MEM_dupallocN(mmd->dynverts);
92         if (mmd->bindweights) tmmd->bindweights = MEM_dupallocN(mmd->bindweights);  /* deprecated */
93         if (mmd->bindcos) tmmd->bindcos = MEM_dupallocN(mmd->bindcos);  /* deprecated */
94 }
95
96 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
97 {       
98         MeshDeformModifierData *mmd = (MeshDeformModifierData *)md;
99         CustomDataMask dataMask = 0;
100
101         /* ask for vertexgroups if we need them */
102         if (mmd->defgrp_name[0]) dataMask |= CD_MASK_MDEFORMVERT;
103
104         return dataMask;
105 }
106
107 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
108 {
109         MeshDeformModifierData *mmd = (MeshDeformModifierData *) md;
110
111         return !mmd->object;
112 }
113
114 static void foreachObjectLink(
115         ModifierData *md, Object *ob,
116         ObjectWalkFunc walk, void *userData)
117 {
118         MeshDeformModifierData *mmd = (MeshDeformModifierData *) md;
119
120         walk(userData, ob, &mmd->object, IDWALK_CB_NOP);
121 }
122
123 static void updateDepsgraph(ModifierData *md,
124                             struct Main *UNUSED(bmain),
125                             struct Scene *UNUSED(scene),
126                             Object *UNUSED(ob),
127                             struct DepsNodeHandle *node)
128 {
129         MeshDeformModifierData *mmd = (MeshDeformModifierData *)md;
130         if (mmd->object != NULL) {
131                 /* TODO(sergey): Do we need transform component here? */
132                 DEG_add_object_relation(node, mmd->object, DEG_OB_COMP_GEOMETRY, "Mesh Deform Modifier");
133         }
134 }
135
136 static float meshdeform_dynamic_bind(MeshDeformModifierData *mmd, float (*dco)[3], float vec[3])
137 {
138         MDefCell *cell;
139         MDefInfluence *inf;
140         float gridvec[3], dvec[3], ivec[3], wx, wy, wz;
141         float weight, cageweight, totweight, *cageco;
142         int i, j, a, x, y, z, size;
143 #ifdef __SSE2__
144         __m128 co = _mm_setzero_ps();
145 #else
146         float co[3] = {0.0f, 0.0f, 0.0f};
147 #endif
148
149         totweight = 0.0f;
150         size = mmd->dyngridsize;
151
152         for (i = 0; i < 3; i++) {
153                 gridvec[i] = (vec[i] - mmd->dyncellmin[i] - mmd->dyncellwidth * 0.5f) / mmd->dyncellwidth;
154                 ivec[i] = (int)gridvec[i];
155                 dvec[i] = gridvec[i] - ivec[i];
156         }
157
158         for (i = 0; i < 8; i++) {
159                 if (i & 1) { x = ivec[0] + 1; wx = dvec[0]; }
160                 else {       x = ivec[0]; wx = 1.0f - dvec[0]; }
161
162                 if (i & 2) { y = ivec[1] + 1; wy = dvec[1]; }
163                 else {       y = ivec[1];     wy = 1.0f - dvec[1]; }
164
165                 if (i & 4) { z = ivec[2] + 1; wz = dvec[2]; }
166                 else {       z = ivec[2];     wz = 1.0f - dvec[2]; }
167
168                 CLAMP(x, 0, size - 1);
169                 CLAMP(y, 0, size - 1);
170                 CLAMP(z, 0, size - 1);
171
172                 a = x + y * size + z * size * size;
173                 weight = wx * wy * wz;
174
175                 cell = &mmd->dyngrid[a];
176                 inf = mmd->dyninfluences + cell->offset;
177                 for (j = 0; j < cell->totinfluence; j++, inf++) {
178                         cageco = dco[inf->vertex];
179                         cageweight = weight * inf->weight;
180 #ifdef __SSE2__
181                         {
182                                 __m128 cageweight_r = _mm_set1_ps(cageweight);
183                                 /* This will load one extra element, this is ok because
184                                  * we ignore that part of register anyway.
185                                  */
186                                 __m128 cageco_r = _mm_loadu_ps(cageco);
187                                 co = _mm_add_ps(co,
188                                                 _mm_mul_ps(cageco_r, cageweight_r));
189                         }
190 #else
191                         co[0] += cageweight * cageco[0];
192                         co[1] += cageweight * cageco[1];
193                         co[2] += cageweight * cageco[2];
194 #endif
195                         totweight += cageweight;
196                 }
197         }
198
199 #ifdef __SSE2__
200         copy_v3_v3(vec, (float *)&co);
201 #else
202         copy_v3_v3(vec, co);
203 #endif
204
205         return totweight;
206 }
207
208 typedef struct MeshdeformUserdata {
209         /*const*/ MeshDeformModifierData *mmd;
210         const MDeformVert *dvert;
211         /*const*/ float (*dco)[3];
212         int defgrp_index;
213         float (*vertexCos)[3];
214         float (*cagemat)[4];
215         float (*icagemat)[3];
216 } MeshdeformUserdata;
217
218 static void meshdeform_vert_task(
219         void *__restrict userdata,
220         const int iter,
221         const ParallelRangeTLS *__restrict UNUSED(tls))
222 {
223         MeshdeformUserdata *data = userdata;
224         /*const*/ MeshDeformModifierData *mmd = data->mmd;
225         const MDeformVert *dvert = data->dvert;
226         const int defgrp_index = data->defgrp_index;
227         const int *offsets = mmd->bindoffsets;
228         const MDefInfluence *influences = mmd->bindinfluences;
229         /*const*/ float (*dco)[3] = data->dco;
230         float (*vertexCos)[3] = data->vertexCos;
231         float co[3];
232         float weight, totweight, fac = 1.0f;
233
234         if (mmd->flag & MOD_MDEF_DYNAMIC_BIND)
235                 if (!mmd->dynverts[iter])
236                         return;
237
238         if (dvert) {
239                 fac = defvert_find_weight(&dvert[iter], defgrp_index);
240
241                 if (mmd->flag & MOD_MDEF_INVERT_VGROUP) {
242                         fac = 1.0f - fac;
243                 }
244
245                 if (fac <= 0.0f) {
246                         return;
247                 }
248         }
249
250         if (mmd->flag & MOD_MDEF_DYNAMIC_BIND) {
251                 /* transform coordinate into cage's local space */
252                 mul_v3_m4v3(co, data->cagemat, vertexCos[iter]);
253                 totweight = meshdeform_dynamic_bind(mmd, dco, co);
254         }
255         else {
256                 int a;
257                 totweight = 0.0f;
258                 zero_v3(co);
259
260                 for (a = offsets[iter]; a < offsets[iter + 1]; a++) {
261                         weight = influences[a].weight;
262                         madd_v3_v3fl(co, dco[influences[a].vertex], weight);
263                         totweight += weight;
264                 }
265         }
266
267         if (totweight > 0.0f) {
268                 mul_v3_fl(co, fac / totweight);
269                 mul_m3_v3(data->icagemat, co);
270                 if (G.debug_value != 527)
271                         add_v3_v3(vertexCos[iter], co);
272                 else
273                         copy_v3_v3(vertexCos[iter], co);
274         }
275 }
276
277 static void meshdeformModifier_do(
278         ModifierData *md, const struct EvaluationContext *eval_ctx, Object *ob, DerivedMesh *dm,
279         float (*vertexCos)[3], int numVerts)
280 {
281         MeshDeformModifierData *mmd = (MeshDeformModifierData *) md;
282         DerivedMesh *tmpdm, *cagedm;
283         MDeformVert *dvert = NULL;
284         float imat[4][4], cagemat[4][4], iobmat[4][4], icagemat[3][3], cmat[4][4];
285         float co[3], (*dco)[3], (*bindcagecos)[3];
286         int a, totvert, totcagevert, defgrp_index;
287         float (*cagecos)[3];
288         MeshdeformUserdata data;
289
290         if (!mmd->object || (!mmd->bindcagecos && !mmd->bindfunc))
291                 return;
292
293         /* Get cage derivedmesh.
294          *
295          * Only do this is the target object is in edit mode by itself, meaning
296          * we don't allow linked edit meshes here.
297          * This is because editbmesh_get_derived_cage_and_final() might easily
298          * conflict with the thread which evaluates object which is in the edit
299          * mode for this mesh.
300          *
301          * We'll support this case once granular dependency graph is landed.
302          */
303         if (mmd->object == md->scene->obedit) {
304                 BMEditMesh *em = BKE_editmesh_from_object(mmd->object);
305                 tmpdm = editbmesh_get_derived_cage_and_final(eval_ctx, md->scene, mmd->object, em, 0, &cagedm);
306                 if (tmpdm)
307                         tmpdm->release(tmpdm);
308         }
309         else
310                 cagedm = mmd->object->derivedFinal;
311
312         /* if we don't have one computed, use derivedmesh from data
313          * without any modifiers */
314         if (!cagedm) {
315                 cagedm = get_dm(mmd->object, NULL, NULL, NULL, false, false);
316                 if (cagedm)
317                         cagedm->needsFree = 1;
318         }
319         
320         if (!cagedm) {
321                 modifier_setError(md, "Cannot get mesh from cage object");
322                 return;
323         }
324
325         /* compute matrices to go in and out of cage object space */
326         invert_m4_m4(imat, mmd->object->obmat);
327         mul_m4_m4m4(cagemat, imat, ob->obmat);
328         mul_m4_m4m4(cmat, mmd->bindmat, cagemat);
329         invert_m4_m4(iobmat, cmat);
330         copy_m3_m4(icagemat, iobmat);
331
332         /* bind weights if needed */
333         if (!mmd->bindcagecos) {
334                 static int recursive = 0;
335
336                 /* progress bar redraw can make this recursive .. */
337                 if (!recursive) {
338                         recursive = 1;
339                         mmd->bindfunc(md->scene, mmd, cagedm, (float *)vertexCos, numVerts, cagemat);
340                         recursive = 0;
341                 }
342         }
343
344         /* verify we have compatible weights */
345         totvert = numVerts;
346         totcagevert = cagedm->getNumVerts(cagedm);
347
348         if (mmd->totvert != totvert) {
349                 modifier_setError(md, "Verts changed from %d to %d", mmd->totvert, totvert);
350                 cagedm->release(cagedm);
351                 return;
352         }
353         else if (mmd->totcagevert != totcagevert) {
354                 modifier_setError(md, "Cage verts changed from %d to %d", mmd->totcagevert, totcagevert);
355                 cagedm->release(cagedm);
356                 return;
357         }
358         else if (mmd->bindcagecos == NULL) {
359                 modifier_setError(md, "Bind data missing");
360                 cagedm->release(cagedm);
361                 return;
362         }
363
364         cagecos = MEM_mallocN(sizeof(*cagecos) * totcagevert, "meshdeformModifier vertCos");
365
366         /* setup deformation data */
367         cagedm->getVertCos(cagedm, cagecos);
368         bindcagecos = (float(*)[3])mmd->bindcagecos;
369
370         /* We allocate 1 element extra to make it possible to
371          * load the values to SSE registers, which are float4.
372          */
373         dco = MEM_callocN(sizeof(*dco) * (totcagevert + 1), "MDefDco");
374         zero_v3(dco[totcagevert]);
375         for (a = 0; a < totcagevert; a++) {
376                 /* get cage vertex in world space with binding transform */
377                 copy_v3_v3(co, cagecos[a]);
378
379                 if (G.debug_value != 527) {
380                         mul_m4_v3(mmd->bindmat, co);
381                         /* compute difference with world space bind coord */
382                         sub_v3_v3v3(dco[a], co, bindcagecos[a]);
383                 }
384                 else
385                         copy_v3_v3(dco[a], co);
386         }
387
388         modifier_get_vgroup(ob, dm, mmd->defgrp_name, &dvert, &defgrp_index);
389
390         /* Initialize data to be pass to the for body function. */
391         data.mmd = mmd;
392         data.dvert = dvert;
393         data.dco = dco;
394         data.defgrp_index = defgrp_index;
395         data.vertexCos = vertexCos;
396         data.cagemat = cagemat;
397         data.icagemat = icagemat;
398
399         /* Do deformation. */
400         ParallelRangeSettings settings;
401         BLI_parallel_range_settings_defaults(&settings);
402         settings.use_threading = (totvert > 1000);
403         BLI_task_parallel_range(0, totvert,
404                                 &data,
405                                 meshdeform_vert_task,
406                                 &settings);
407
408         /* release cage derivedmesh */
409         MEM_freeN(dco);
410         MEM_freeN(cagecos);
411         cagedm->release(cagedm);
412 }
413
414 static void deformVerts(ModifierData *md, const struct EvaluationContext *eval_ctx, Object *ob,
415                         DerivedMesh *derivedData,
416                         float (*vertexCos)[3],
417                         int numVerts,
418                         ModifierApplyFlag UNUSED(flag))
419 {
420         DerivedMesh *dm = get_dm(ob, NULL, derivedData, NULL, false, false);
421
422         modifier_vgroup_cache(md, vertexCos); /* if next modifier needs original vertices */
423
424         meshdeformModifier_do(md, eval_ctx, ob, dm, vertexCos, numVerts);
425
426         if (dm && dm != derivedData)
427                 dm->release(dm);
428 }
429
430 static void deformVertsEM(ModifierData *md, const struct EvaluationContext *eval_ctx, Object *ob,
431                           struct BMEditMesh *UNUSED(editData),
432                           DerivedMesh *derivedData,
433                           float (*vertexCos)[3],
434                           int numVerts)
435 {
436         DerivedMesh *dm = get_dm(ob, NULL, derivedData, NULL, false, false);
437
438         meshdeformModifier_do(md, eval_ctx, ob, dm, vertexCos, numVerts);
439
440         if (dm && dm != derivedData)
441                 dm->release(dm);
442 }
443
444 #define MESHDEFORM_MIN_INFLUENCE 0.00001f
445
446 void modifier_mdef_compact_influences(ModifierData *md)
447 {
448         MeshDeformModifierData *mmd = (MeshDeformModifierData *)md;
449         float weight, *weights, totweight;
450         int totinfluence, totvert, totcagevert, a, b;
451
452         weights = mmd->bindweights;
453         if (!weights)
454                 return;
455         
456         totvert = mmd->totvert;
457         totcagevert = mmd->totcagevert;
458
459         /* count number of influences above threshold */
460         for (b = 0; b < totvert; b++) {
461                 for (a = 0; a < totcagevert; a++) {
462                         weight = weights[a + b * totcagevert];
463
464                         if (weight > MESHDEFORM_MIN_INFLUENCE)
465                                 mmd->totinfluence++;
466                 }
467         }
468
469         /* allocate bind influences */
470         mmd->bindinfluences = MEM_callocN(sizeof(MDefInfluence) * mmd->totinfluence, "MDefBindInfluence");
471         mmd->bindoffsets = MEM_callocN(sizeof(int) * (totvert + 1), "MDefBindOffset");
472
473         /* write influences */
474         totinfluence = 0;
475
476         for (b = 0; b < totvert; b++) {
477                 mmd->bindoffsets[b] = totinfluence;
478                 totweight = 0.0f;
479
480                 /* sum total weight */
481                 for (a = 0; a < totcagevert; a++) {
482                         weight = weights[a + b * totcagevert];
483
484                         if (weight > MESHDEFORM_MIN_INFLUENCE)
485                                 totweight += weight;
486                 }
487
488                 /* assign weights normalized */
489                 for (a = 0; a < totcagevert; a++) {
490                         weight = weights[a + b * totcagevert];
491
492                         if (weight > MESHDEFORM_MIN_INFLUENCE) {
493                                 mmd->bindinfluences[totinfluence].weight = weight / totweight;
494                                 mmd->bindinfluences[totinfluence].vertex = a;
495                                 totinfluence++;
496                         }
497                 }
498         }
499
500         mmd->bindoffsets[b] = totinfluence;
501         
502         /* free */
503         MEM_freeN(mmd->bindweights);
504         mmd->bindweights = NULL;
505 }
506
507 ModifierTypeInfo modifierType_MeshDeform = {
508         /* name */              "MeshDeform",
509         /* structName */        "MeshDeformModifierData",
510         /* structSize */        sizeof(MeshDeformModifierData),
511         /* type */              eModifierTypeType_OnlyDeform,
512         /* flags */             eModifierTypeFlag_AcceptsCVs |
513                                 eModifierTypeFlag_AcceptsLattice |
514                                 eModifierTypeFlag_SupportsEditmode,
515
516         /* copyData */          copyData,
517         /* deformVerts */       deformVerts,
518         /* deformMatrices */    NULL,
519         /* deformVertsEM */     deformVertsEM,
520         /* deformMatricesEM */  NULL,
521         /* applyModifier */     NULL,
522         /* applyModifierEM */   NULL,
523         /* initData */          initData,
524         /* requiredDataMask */  requiredDataMask,
525         /* freeData */          freeData,
526         /* isDisabled */        isDisabled,
527         /* updateDepsgraph */   updateDepsgraph,
528         /* dependsOnTime */     NULL,
529         /* dependsOnNormals */  NULL,
530         /* foreachObjectLink */ foreachObjectLink,
531         /* foreachIDLink */     NULL,
532         /* foreachTexLink */    NULL,
533 };