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