style cleanup: comments
[blender.git] / source / blender / blenkernel / intern / shrinkwrap.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) Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Andr Pinto
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/shrinkwrap.c
29  *  \ingroup bke
30  */
31
32 #include <string.h>
33 #include <float.h>
34 #include <math.h>
35 #include <memory.h>
36 #include <stdio.h>
37 #include <time.h>
38 #include <assert.h>
39
40 #include "DNA_object_types.h"
41 #include "DNA_modifier_types.h"
42 #include "DNA_meshdata_types.h"
43 #include "DNA_mesh_types.h"
44 #include "DNA_scene_types.h"
45
46 #include "BLI_math.h"
47 #include "BLI_utildefines.h"
48
49 #include "BKE_shrinkwrap.h"
50 #include "BKE_DerivedMesh.h"
51 #include "BKE_lattice.h"
52
53 #include "BKE_deform.h"
54 #include "BKE_mesh.h"
55 #include "BKE_subsurf.h"
56 #include "BKE_mesh.h"
57 #include "BKE_tessmesh.h"
58
59 /* Util macros */
60 #define OUT_OF_MEMORY() ((void)printf("Shrinkwrap: Out of memory\n"))
61
62 /* Benchmark macros */
63 #if !defined(_WIN32) && 0
64
65 #include <sys/time.h>
66
67 #define BENCH(a)        \
68         do {                    \
69                 double _t1, _t2;                                \
70                 struct timeval _tstart, _tend;  \
71                 clock_t _clock_init = clock();  \
72                 gettimeofday ( &_tstart, NULL); \
73                 (a);                                                    \
74                 gettimeofday ( &_tend, NULL);   \
75                 _t1 = ( double ) _tstart.tv_sec + ( double ) _tstart.tv_usec/ ( 1000*1000 );    \
76                 _t2 = ( double )   _tend.tv_sec + ( double )   _tend.tv_usec/ ( 1000*1000 );    \
77                 printf("%s: %fs (real) %fs (cpu)\n", #a, _t2-_t1, (float)(clock()-_clock_init)/CLOCKS_PER_SEC);\
78         } while (0)
79
80 #else
81
82 #define BENCH(a)    (a)
83
84 #endif
85
86 /* get derived mesh */
87 /* TODO is anyfunction that does this? returning the derivedFinal without we caring if its in edit mode or not? */
88 DerivedMesh *object_get_derived_final(Object *ob)
89 {
90         Mesh *me = ob->data;
91         BMEditMesh *em = me->edit_btmesh;
92
93         if (em) {
94                 DerivedMesh *dm = em->derivedFinal;
95                 return dm;
96         }
97
98         return ob->derivedFinal;
99 }
100
101 /* Space transform */
102 void space_transform_from_matrixs(SpaceTransform *data, float local[4][4], float target[4][4])
103 {
104         float itarget[4][4];
105         invert_m4_m4(itarget, target);
106         mul_serie_m4(data->local2target, itarget, local, NULL, NULL, NULL, NULL, NULL, NULL);
107         invert_m4_m4(data->target2local, data->local2target);
108 }
109
110 void space_transform_apply(const SpaceTransform *data, float co[3])
111 {
112         mul_v3_m4v3(co, ((SpaceTransform *)data)->local2target, co);
113 }
114
115 void space_transform_invert(const SpaceTransform *data, float co[3])
116 {
117         mul_v3_m4v3(co, ((SpaceTransform *)data)->target2local, co);
118 }
119
120 static void space_transform_apply_normal(const SpaceTransform *data, float no[3])
121 {
122         mul_mat3_m4_v3(((SpaceTransform *)data)->local2target, no);
123         normalize_v3(no); /* TODO: could we just determine de scale value from the matrix? */
124 }
125
126 static void space_transform_invert_normal(const SpaceTransform *data, float no[3])
127 {
128         mul_mat3_m4_v3(((SpaceTransform *)data)->target2local, no);
129         normalize_v3(no); /* TODO: could we just determine de scale value from the matrix? */
130 }
131
132 /*
133  * Shrinkwrap to the nearest vertex
134  *
135  * it builds a kdtree of vertexs we can attach to and then
136  * for each vertex performs a nearest vertex search on the tree
137  */
138 static void shrinkwrap_calc_nearest_vertex(ShrinkwrapCalcData *calc)
139 {
140         int i;
141
142         BVHTreeFromMesh treeData = NULL_BVHTreeFromMesh;
143         BVHTreeNearest nearest  = NULL_BVHTreeNearest;
144
145
146         BENCH(bvhtree_from_mesh_verts(&treeData, calc->target, 0.0, 2, 6));
147         if (treeData.tree == NULL) {
148                 OUT_OF_MEMORY();
149                 return;
150         }
151
152         /* Setup nearest */
153         nearest.index = -1;
154         nearest.dist = FLT_MAX;
155 #ifndef __APPLE__
156 #pragma omp parallel for default(none) private(i) firstprivate(nearest) shared(treeData,calc) schedule(static)
157 #endif
158         for (i = 0; i < calc->numVerts; ++i) {
159                 float *co = calc->vertexCos[i];
160                 float tmp_co[3];
161                 float weight = defvert_array_find_weight_safe(calc->dvert, i, calc->vgroup);
162                 if (weight == 0.0f) continue;
163
164
165                 /* Convert the vertex to tree coordinates */
166                 if (calc->vert) {
167                         copy_v3_v3(tmp_co, calc->vert[i].co);
168                 }
169                 else {
170                         copy_v3_v3(tmp_co, co);
171                 }
172                 space_transform_apply(&calc->local2target, tmp_co);
173
174                 /* Use local proximity heuristics (to reduce the nearest search)
175                  *
176                  * If we already had an hit before.. we assume this vertex is going to have a close hit to that other vertex
177                  * so we can initiate the "nearest.dist" with the expected value to that last hit.
178                  * This will lead in prunning of the search tree. */
179                 if (nearest.index != -1)
180                         nearest.dist = len_squared_v3v3(tmp_co, nearest.co);
181                 else
182                         nearest.dist = FLT_MAX;
183
184                 BLI_bvhtree_find_nearest(treeData.tree, tmp_co, &nearest, treeData.nearest_callback, &treeData);
185
186
187                 /* Found the nearest vertex */
188                 if (nearest.index != -1) {
189                         /* Adjusting the vertex weight,
190                          * so that after interpolating it keeps a certain distance from the nearest position */
191                         float dist = sasqrt(nearest.dist);
192                         if (dist > FLT_EPSILON) weight *= (dist - calc->keepDist) / dist;
193
194                         /* Convert the coordinates back to mesh coordinates */
195                         copy_v3_v3(tmp_co, nearest.co);
196                         space_transform_invert(&calc->local2target, tmp_co);
197
198                         interp_v3_v3v3(co, co, tmp_co, weight);  /* linear interpolation */
199                 }
200         }
201
202         free_bvhtree_from_mesh(&treeData);
203 }
204
205 /*
206  * This function raycast a single vertex and updates the hit if the "hit" is considered valid.
207  * Returns TRUE if "hit" was updated.
208  * Opts control whether an hit is valid or not
209  * Supported options are:
210  *      MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE (front faces hits are ignored)
211  *      MOD_SHRINKWRAP_CULL_TARGET_BACKFACE (back faces hits are ignored)
212  */
213 int normal_projection_project_vertex(char options, const float vert[3], const float dir[3], const SpaceTransform *transf, BVHTree *tree, BVHTreeRayHit *hit, BVHTree_RayCastCallback callback, void *userdata)
214 {
215         float tmp_co[3], tmp_no[3];
216         const float *co, *no;
217         BVHTreeRayHit hit_tmp;
218
219         /* Copy from hit (we need to convert hit rays from one space coordinates to the other */
220         memcpy(&hit_tmp, hit, sizeof(hit_tmp));
221
222         /* Apply space transform (TODO readjust dist) */
223         if (transf) {
224                 copy_v3_v3(tmp_co, vert);
225                 space_transform_apply(transf, tmp_co);
226                 co = tmp_co;
227
228                 copy_v3_v3(tmp_no, dir);
229                 space_transform_apply_normal(transf, tmp_no);
230                 no = tmp_no;
231
232                 hit_tmp.dist *= mat4_to_scale(((SpaceTransform *)transf)->local2target);
233         }
234         else {
235                 co = vert;
236                 no = dir;
237         }
238
239         hit_tmp.index = -1;
240
241         BLI_bvhtree_ray_cast(tree, co, no, 0.0f, &hit_tmp, callback, userdata);
242
243         if (hit_tmp.index != -1) {
244                 /* invert the normal first so face culling works on rotated objects */
245                 if (transf) {
246                         space_transform_invert_normal(transf, hit_tmp.no);
247                 }
248
249                 if (options & (MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE | MOD_SHRINKWRAP_CULL_TARGET_BACKFACE)) {
250                         /* apply backface */
251                         const float dot = dot_v3v3(dir, hit_tmp.no);
252                         if (((options & MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE) && dot <= 0.0f) ||
253                             ((options & MOD_SHRINKWRAP_CULL_TARGET_BACKFACE) && dot >= 0.0f))
254                         {
255                                 return FALSE; /* Ignore hit */
256                         }
257                 }
258
259                 if (transf) {
260                         /* Inverting space transform (TODO make coeherent with the initial dist readjust) */
261                         space_transform_invert(transf, hit_tmp.co);
262                         hit_tmp.dist = len_v3v3((float *)vert, hit_tmp.co);
263                 }
264
265                 memcpy(hit, &hit_tmp, sizeof(hit_tmp));
266                 return TRUE;
267         }
268         return FALSE;
269 }
270
271
272 static void shrinkwrap_calc_normal_projection(ShrinkwrapCalcData *calc)
273 {
274         int i;
275
276         /* Options about projection direction */
277         const char use_normal   = calc->smd->shrinkOpts;
278         float proj_axis[3]      = {0.0f, 0.0f, 0.0f};
279
280         /* Raycast and tree stuff */
281         BVHTreeRayHit hit;
282         BVHTreeFromMesh treeData = NULL_BVHTreeFromMesh;
283
284         /* auxiliary target */
285         DerivedMesh *auxMesh    = NULL;
286         BVHTreeFromMesh auxData = NULL_BVHTreeFromMesh;
287         SpaceTransform local2aux;
288
289         /* If the user doesn't allows to project in any direction of projection axis
290          * then theres nothing todo. */
291         if ((use_normal & (MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR | MOD_SHRINKWRAP_PROJECT_ALLOW_NEG_DIR)) == 0)
292                 return;
293
294
295         /* Prepare data to retrieve the direction in which we should project each vertex */
296         if (calc->smd->projAxis == MOD_SHRINKWRAP_PROJECT_OVER_NORMAL) {
297                 if (calc->vert == NULL) return;
298         }
299         else {
300                 /* The code supports any axis that is a combination of X,Y,Z
301                  * although currently UI only allows to set the 3 different axis */
302                 if (calc->smd->projAxis & MOD_SHRINKWRAP_PROJECT_OVER_X_AXIS) proj_axis[0] = 1.0f;
303                 if (calc->smd->projAxis & MOD_SHRINKWRAP_PROJECT_OVER_Y_AXIS) proj_axis[1] = 1.0f;
304                 if (calc->smd->projAxis & MOD_SHRINKWRAP_PROJECT_OVER_Z_AXIS) proj_axis[2] = 1.0f;
305
306                 normalize_v3(proj_axis);
307
308                 /* Invalid projection direction */
309                 if (dot_v3v3(proj_axis, proj_axis) < FLT_EPSILON)
310                         return; 
311         }
312
313         if (calc->smd->auxTarget) {
314                 auxMesh = object_get_derived_final(calc->smd->auxTarget);
315                 if (!auxMesh)
316                         return;
317                 SPACE_TRANSFORM_SETUP(&local2aux, calc->ob, calc->smd->auxTarget);
318         }
319
320         /* After sucessufuly build the trees, start projection vertexs */
321         if (bvhtree_from_mesh_faces(&treeData, calc->target, 0.0, 4, 6) &&
322             (auxMesh == NULL || bvhtree_from_mesh_faces(&auxData, auxMesh, 0.0, 4, 6)))
323         {
324
325 #ifndef __APPLE__
326 #pragma omp parallel for private(i,hit) schedule(static)
327 #endif
328                 for (i = 0; i < calc->numVerts; ++i) {
329                         float *co = calc->vertexCos[i];
330                         float tmp_co[3], tmp_no[3];
331                         float weight = defvert_array_find_weight_safe(calc->dvert, i, calc->vgroup);
332
333                         if (weight == 0.0f) continue;
334
335                         if (calc->vert) {
336                                 /* calc->vert contains verts from derivedMesh  */
337                                 /* this coordinated are deformed by vertexCos only for normal projection (to get correct normals) */
338                                 /* for other cases calc->varts contains undeformed coordinates and vertexCos should be used */
339                                 if (calc->smd->projAxis == MOD_SHRINKWRAP_PROJECT_OVER_NORMAL) {
340                                         copy_v3_v3(tmp_co, calc->vert[i].co);
341                                         normal_short_to_float_v3(tmp_no, calc->vert[i].no);
342                                 }
343                                 else {
344                                         copy_v3_v3(tmp_co, co);
345                                         copy_v3_v3(tmp_no, proj_axis);
346                                 }
347                         }
348                         else {
349                                 copy_v3_v3(tmp_co, co);
350                                 copy_v3_v3(tmp_no, proj_axis);
351                         }
352
353
354                         hit.index = -1;
355                         hit.dist = 10000.0f; /* TODO: we should use FLT_MAX here, but sweepsphere code isn't prepared for that */
356
357                         /* Project over positive direction of axis */
358                         if (use_normal & MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR) {
359
360                                 if (auxData.tree)
361                                         normal_projection_project_vertex(0, tmp_co, tmp_no, &local2aux, auxData.tree, &hit, auxData.raycast_callback, &auxData);
362
363                                 normal_projection_project_vertex(calc->smd->shrinkOpts, tmp_co, tmp_no, &calc->local2target, treeData.tree, &hit, treeData.raycast_callback, &treeData);
364                         }
365
366                         /* Project over negative direction of axis */
367                         if (use_normal & MOD_SHRINKWRAP_PROJECT_ALLOW_NEG_DIR && hit.index == -1) {
368                                 float inv_no[3];
369                                 negate_v3_v3(inv_no, tmp_no);
370
371                                 if (auxData.tree)
372                                         normal_projection_project_vertex(0, tmp_co, inv_no, &local2aux, auxData.tree, &hit, auxData.raycast_callback, &auxData);
373
374                                 normal_projection_project_vertex(calc->smd->shrinkOpts, tmp_co, inv_no, &calc->local2target, treeData.tree, &hit, treeData.raycast_callback, &treeData);
375                         }
376
377
378                         if (hit.index != -1) {
379                                 madd_v3_v3v3fl(hit.co, hit.co, tmp_no, calc->keepDist);
380                                 interp_v3_v3v3(co, co, hit.co, weight);
381                         }
382                 }
383         }
384
385         /* free data structures */
386         free_bvhtree_from_mesh(&treeData);
387         free_bvhtree_from_mesh(&auxData);
388 }
389
390 /*
391  * Shrinkwrap moving vertexs to the nearest surface point on the target
392  *
393  * it builds a BVHTree from the target mesh and then performs a
394  * NN matches for each vertex
395  */
396 static void shrinkwrap_calc_nearest_surface_point(ShrinkwrapCalcData *calc)
397 {
398         int i;
399
400         BVHTreeFromMesh treeData = NULL_BVHTreeFromMesh;
401         BVHTreeNearest nearest  = NULL_BVHTreeNearest;
402
403         /* Create a bvh-tree of the given target */
404         BENCH(bvhtree_from_mesh_faces(&treeData, calc->target, 0.0, 2, 6));
405         if (treeData.tree == NULL) {
406                 OUT_OF_MEMORY();
407                 return;
408         }
409
410         /* Setup nearest */
411         nearest.index = -1;
412         nearest.dist = FLT_MAX;
413
414
415         /* Find the nearest vertex */
416 #ifndef __APPLE__
417 #pragma omp parallel for default(none) private(i) firstprivate(nearest) shared(calc,treeData) schedule(static)
418 #endif
419         for (i = 0; i < calc->numVerts; ++i) {
420                 float *co = calc->vertexCos[i];
421                 float tmp_co[3];
422                 float weight = defvert_array_find_weight_safe(calc->dvert, i, calc->vgroup);
423                 if (weight == 0.0f) continue;
424
425                 /* Convert the vertex to tree coordinates */
426                 if (calc->vert) {
427                         copy_v3_v3(tmp_co, calc->vert[i].co);
428                 }
429                 else {
430                         copy_v3_v3(tmp_co, co);
431                 }
432                 space_transform_apply(&calc->local2target, tmp_co);
433
434                 /* Use local proximity heuristics (to reduce the nearest search)
435                  *
436                  * If we already had an hit before.. we assume this vertex is going to have a close hit to that other vertex
437                  * so we can initiate the "nearest.dist" with the expected value to that last hit.
438                  * This will lead in prunning of the search tree. */
439                 if (nearest.index != -1)
440                         nearest.dist = len_squared_v3v3(tmp_co, nearest.co);
441                 else
442                         nearest.dist = FLT_MAX;
443
444                 BLI_bvhtree_find_nearest(treeData.tree, tmp_co, &nearest, treeData.nearest_callback, &treeData);
445
446                 /* Found the nearest vertex */
447                 if (nearest.index != -1) {
448                         if (calc->smd->shrinkOpts & MOD_SHRINKWRAP_KEEP_ABOVE_SURFACE) {
449                                 /* Make the vertex stay on the front side of the face */
450                                 madd_v3_v3v3fl(tmp_co, nearest.co, nearest.no, calc->keepDist);
451                         }
452                         else {
453                                 /* Adjusting the vertex weight,
454                                  * so that after interpolating it keeps a certain distance from the nearest position */
455                                 float dist = sasqrt(nearest.dist);
456                                 if (dist > FLT_EPSILON)
457                                         interp_v3_v3v3(tmp_co, tmp_co, nearest.co, (dist - calc->keepDist) / dist);  /* linear interpolation */
458                                 else
459                                         copy_v3_v3(tmp_co, nearest.co);
460                         }
461
462                         /* Convert the coordinates back to mesh coordinates */
463                         space_transform_invert(&calc->local2target, tmp_co);
464                         interp_v3_v3v3(co, co, tmp_co, weight);  /* linear interpolation */
465                 }
466         }
467
468         free_bvhtree_from_mesh(&treeData);
469 }
470
471 /* Main shrinkwrap function */
472 void shrinkwrapModifier_deform(ShrinkwrapModifierData *smd, Object *ob, DerivedMesh *dm, float (*vertexCos)[3], int numVerts)
473 {
474
475         DerivedMesh *ss_mesh    = NULL;
476         ShrinkwrapCalcData calc = NULL_ShrinkwrapCalcData;
477
478         /* remove loop dependencies on derived meshs (TODO should this be done elsewhere?) */
479         if (smd->target == ob) smd->target = NULL;
480         if (smd->auxTarget == ob) smd->auxTarget = NULL;
481
482
483         /* Configure Shrinkwrap calc data */
484         calc.smd = smd;
485         calc.ob = ob;
486         calc.numVerts = numVerts;
487         calc.vertexCos = vertexCos;
488
489         /* DeformVertex */
490         calc.vgroup = defgroup_name_index(calc.ob, calc.smd->vgroup_name);
491         if (dm) {
492                 calc.dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
493         }
494         else if (calc.ob->type == OB_LATTICE) {
495                 calc.dvert = BKE_lattice_deform_verts_get(calc.ob);
496         }
497
498
499         if (smd->target) {
500                 calc.target = object_get_derived_final(smd->target);
501
502                 /* TODO there might be several "bugs" on non-uniform scales matrixs
503                  * because it will no longer be nearest surface, not sphere projection
504                  * because space has been deformed */
505                 SPACE_TRANSFORM_SETUP(&calc.local2target, ob, smd->target);
506
507                 /* TODO: smd->keepDist is in global units.. must change to local */
508                 calc.keepDist = smd->keepDist;
509         }
510
511
512
513         calc.vgroup = defgroup_name_index(calc.ob, smd->vgroup_name);
514
515         if (dm != NULL && smd->shrinkType == MOD_SHRINKWRAP_PROJECT) {
516                 /* Setup arrays to get vertexs positions, normals and deform weights */
517                 calc.vert   = dm->getVertDataArray(dm, CD_MVERT);
518                 calc.dvert  = dm->getVertDataArray(dm, CD_MDEFORMVERT);
519
520                 /* Using vertexs positions/normals as if a subsurface was applied */
521                 if (smd->subsurfLevels) {
522                         SubsurfModifierData ssmd = {{NULL}};
523                         ssmd.subdivType = ME_CC_SUBSURF;        /* catmull clark */
524                         ssmd.levels     = smd->subsurfLevels;   /* levels */
525
526                         ss_mesh = subsurf_make_derived_from_derived(dm, &ssmd, NULL, (ob->mode & OB_MODE_EDIT) ? SUBSURF_IN_EDIT_MODE : 0);
527
528                         if (ss_mesh) {
529                                 calc.vert = ss_mesh->getVertDataArray(ss_mesh, CD_MVERT);
530                                 if (calc.vert) {
531                                         /* TRICKY: this code assumes subsurface will have the transformed original vertices
532                                          * in their original order at the end of the vert array. */
533                                         calc.vert = calc.vert + ss_mesh->getNumVerts(ss_mesh) - dm->getNumVerts(dm);
534                                 }
535                         }
536
537                         /* Just to make sure we are not leaving any memory behind */
538                         assert(ssmd.emCache == NULL);
539                         assert(ssmd.mCache == NULL);
540                 }
541         }
542
543         /* Projecting target defined - lets work! */
544         if (calc.target) {
545                 switch (smd->shrinkType) {
546                         case MOD_SHRINKWRAP_NEAREST_SURFACE:
547                                 BENCH(shrinkwrap_calc_nearest_surface_point(&calc));
548                                 break;
549
550                         case MOD_SHRINKWRAP_PROJECT:
551                                 BENCH(shrinkwrap_calc_normal_projection(&calc));
552                                 break;
553
554                         case MOD_SHRINKWRAP_NEAREST_VERTEX:
555                                 BENCH(shrinkwrap_calc_nearest_vertex(&calc));
556                                 break;
557                 }
558         }
559
560         /* free memory */
561         if (ss_mesh)
562                 ss_mesh->release(ss_mesh);
563 }
564