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