Code comments add to collision interface
[blender.git] / source / blender / blenkernel / intern / cloth.c
1 /*  cloth.c
2 *
3 *
4 * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version. The Blender
10 * Foundation also sells licenses for use in proprietary software under
11 * the Blender License.  See http://www.blender.org/BL/ for information
12 * about this.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 *
23 * The Original Code is Copyright (C) Blender Foundation
24 * All rights reserved.
25 *
26 * The Original Code is: all of this file.
27 *
28 * Contributor(s): none yet.
29 *
30 * ***** END GPL/BL DUAL LICENSE BLOCK *****
31 */
32
33
34 #include <math.h>
35 #include <stdlib.h>
36 #include <string.h>
37
38 #include "MEM_guardedalloc.h"
39
40 /* types */
41 #include "DNA_curve_types.h"
42 #include "DNA_object_types.h"
43 #include "DNA_object_force.h"
44 #include "DNA_cloth_types.h"
45 #include "DNA_key_types.h"
46 #include "DNA_mesh_types.h"
47 #include "DNA_meshdata_types.h"
48 #include "DNA_lattice_types.h"
49 #include "DNA_scene_types.h"
50 #include "DNA_modifier_types.h"
51
52 #include "BLI_blenlib.h"
53 #include "BLI_arithb.h"
54 #include "BLI_edgehash.h"
55 #include "BLI_linklist.h"
56
57 #include "BKE_curve.h"
58 #include "BKE_deform.h"
59 #include "BKE_DerivedMesh.h"
60 #include "BKE_cdderivedmesh.h"
61 #include "BKE_displist.h"
62 #include "BKE_effect.h"
63 #include "BKE_global.h"
64 #include "BKE_key.h"
65 #include "BKE_mesh.h"
66 #include "BKE_object.h"
67 #include "BKE_cloth.h"
68 #include "BKE_collisions.h"
69 #include "BKE_modifier.h"
70 #include "BKE_utildefines.h"
71 #include "BKE_DerivedMesh.h"
72 #include "BIF_editdeform.h"
73 #include "BIF_editkey.h"
74 #include "DNA_screen_types.h"
75 #include "BSE_headerbuttons.h"
76 #include "BIF_screen.h"
77 #include "BIF_space.h"
78 #include "mydevice.h"
79
80 #ifdef _WIN32
81 void tstart ( void )
82 {}
83 void tend ( void )
84 {
85 }
86 double tval()
87 {
88         return 0;
89 }
90 #else
91 #include <sys/time.h>
92 static struct timeval _tstart, _tend;
93 static struct timezone tz;
94 void tstart ( void )
95 {
96         gettimeofday ( &_tstart, &tz );
97 }
98 void tend ( void )
99 {
100         gettimeofday ( &_tend,&tz );
101 }
102 double tval()
103 {
104         double t1, t2;
105         t1 = ( double ) _tstart.tv_sec + ( double ) _tstart.tv_usec/ ( 1000*1000 );
106         t2 = ( double ) _tend.tv_sec + ( double ) _tend.tv_usec/ ( 1000*1000 );
107         return t2-t1;
108 }
109 #endif
110
111 /* Our available solvers. */
112 // 255 is the magic reserved number, so NEVER try to put 255 solvers in here!
113 // 254 = MAX!
114 static CM_SOLVER_DEF    solvers [] =
115     {
116         { "Implicit", CM_IMPLICIT, implicit_init, implicit_solver, implicit_free },
117         // { "Implicit C++", CM_IMPLICITCPP, implicitcpp_init, implicitcpp_solver, implicitcpp_free },
118     };
119
120 /* ********** cloth engine ******* */
121 /* Prototypes for internal functions.
122 */
123 static void cloth_to_object ( Object *ob, ClothModifierData *clmd, float ( *vertexCos ) [3], unsigned int numverts );
124 static void cloth_from_mesh ( Object *ob, ClothModifierData *clmd, DerivedMesh *dm );
125 static int cloth_from_object ( Object *ob, ClothModifierData *clmd, DerivedMesh *dm, float ( *vertexCos ) [3], unsigned int numverts );
126 static int collobj_from_object ( Object *ob, ClothModifierData *clmd, DerivedMesh *dm, float ( *vertexCos ) [3], unsigned int numverts );
127 int cloth_build_springs ( Cloth *cloth, DerivedMesh *dm );
128 static void cloth_apply_vgroup ( ClothModifierData *clmd, DerivedMesh *dm, short vgroup );
129
130
131 /******************************************************************************
132 *
133 * External interface called by modifier.c clothModifier functions.
134 *
135 ******************************************************************************/
136 /**
137 * cloth_init -  creates a new cloth simulation.
138 *
139 * 1. create object
140 * 2. fill object with standard values or with the GUI settings if given
141 */
142 void cloth_init ( ClothModifierData *clmd )
143 {
144         /* Initialize our new data structure to reasonable values. */
145         clmd->sim_parms.gravity [0] = 0.0;
146         clmd->sim_parms.gravity [1] = 0.0;
147         clmd->sim_parms.gravity [2] = -9.81;
148         clmd->sim_parms.structural = 100.0;
149         clmd->sim_parms.shear = 100.0;
150         clmd->sim_parms.bending = 1.0;
151         clmd->sim_parms.Cdis = 5.0;
152         clmd->sim_parms.Cvi = 1.0;
153         clmd->sim_parms.mass = 1.0f;
154         clmd->sim_parms.stepsPerFrame = 5;
155         clmd->sim_parms.sim_time = 1.0;
156         clmd->sim_parms.flags = CLOTH_SIMSETTINGS_FLAG_RESET;
157         clmd->sim_parms.solver_type = 0;
158         clmd->sim_parms.preroll = 0;
159         clmd->sim_parms.maxspringlen = 10;
160         clmd->sim_parms.firstframe = 1;
161         clmd->sim_parms.lastframe = 250;
162         clmd->coll_parms.self_friction = 5.0;
163         clmd->coll_parms.friction = 10.0;
164         clmd->coll_parms.loop_count = 1;
165         clmd->coll_parms.epsilon = 0.01f;
166         clmd->coll_parms.flags = 0;
167
168         /* These defaults are copied from softbody.c's
169         * softbody_calc_forces() function.
170         */
171         clmd->sim_parms.eff_force_scale = 1000.0;
172         clmd->sim_parms.eff_wind_scale = 250.0;
173
174         // also from softbodies
175         clmd->sim_parms.maxgoal = 1.0f;
176         clmd->sim_parms.mingoal = 0.0f;
177         clmd->sim_parms.defgoal = 0.7f;
178         clmd->sim_parms.goalspring = 100.0f;
179         clmd->sim_parms.goalfrict = 0.0f;
180
181         clmd->sim_parms.cache = NULL;
182 }
183
184 // unused in the moment, cloth needs quads from mesh
185 DerivedMesh *CDDM_convert_to_triangle ( DerivedMesh *dm )
186 {
187         DerivedMesh *result = NULL;
188         int i;
189         int numverts = dm->getNumVerts ( dm );
190         int numedges = dm->getNumEdges ( dm );
191         int numfaces = dm->getNumFaces ( dm );
192
193         MVert *mvert = CDDM_get_verts ( dm );
194         MEdge *medge = CDDM_get_edges ( dm );
195         MFace *mface = CDDM_get_faces ( dm );
196
197         MVert *mvert2;
198         MFace *mface2;
199         unsigned int numtris=0;
200         unsigned int numquads=0;
201         int a = 0;
202         int random = 0;
203         int firsttime = 0;
204         float vec1[3], vec2[3], vec3[3], vec4[3], vec5[3];
205         float mag1=0, mag2=0;
206
207         for ( i = 0; i < numfaces; i++ )
208         {
209                 if ( mface[i].v4 )
210                         numquads++;
211                 else
212                         numtris++;
213         }
214
215         result = CDDM_from_template ( dm, numverts, 0, numtris + 2*numquads );
216
217         if ( !result )
218                 return NULL;
219
220         // do verts
221         mvert2 = CDDM_get_verts ( result );
222         for ( a=0; a<numverts; a++ )
223         {
224                 MVert *inMV;
225                 MVert *mv = &mvert2[a];
226
227                 inMV = &mvert[a];
228
229                 DM_copy_vert_data ( dm, result, a, a, 1 );
230                 *mv = *inMV;
231         }
232
233
234         // do faces
235         mface2 = CDDM_get_faces ( result );
236         for ( a=0, i=0; a<numfaces; a++ )
237         {
238                 MFace *mf = &mface2[i];
239                 MFace *inMF;
240                 inMF = &mface[a];
241
242                 /*
243                 DM_copy_face_data(dm, result, a, i, 1);
244
245                 *mf = *inMF;
246                 */
247
248                 if ( mface[a].v4 && random==1 )
249                 {
250                         mf->v1 = mface[a].v2;
251                         mf->v2 = mface[a].v3;
252                         mf->v3 = mface[a].v4;
253                 }
254                 else
255                 {
256                         mf->v1 = mface[a].v1;
257                         mf->v2 = mface[a].v2;
258                         mf->v3 = mface[a].v3;
259                 }
260
261                 mf->v4 = 0;
262                 mf->flag |= ME_SMOOTH;
263
264                 test_index_face ( mf, NULL, 0, 3 );
265
266                 if ( mface[a].v4 )
267                 {
268                         MFace *mf2;
269
270                         i++;
271
272                         mf2 = &mface2[i];
273                         /*
274                         DM_copy_face_data(dm, result, a, i, 1);
275
276                         *mf2 = *inMF;
277                         */
278
279                         if ( random==1 )
280                         {
281                                 mf2->v1 = mface[a].v1;
282                                 mf2->v2 = mface[a].v2;
283                                 mf2->v3 = mface[a].v4;
284                         }
285                         else
286                         {
287                                 mf2->v1 = mface[a].v4;
288                                 mf2->v2 = mface[a].v1;
289                                 mf2->v3 = mface[a].v3;
290                         }
291                         mf2->v4 = 0;
292                         mf2->flag |= ME_SMOOTH;
293
294                         test_index_face ( mf2, NULL, 0, 3 );
295                 }
296
297                 i++;
298         }
299
300         CDDM_calc_edges ( result );
301         CDDM_calc_normals ( result );
302
303         return result;
304
305 }
306
307
308 DerivedMesh *CDDM_create_tearing ( ClothModifierData *clmd, DerivedMesh *dm )
309 {
310         DerivedMesh *result = NULL;
311         unsigned int i = 0, a = 0, j=0;
312         int numverts = dm->getNumVerts ( dm );
313         int numedges = dm->getNumEdges ( dm );
314         int numfaces = dm->getNumFaces ( dm );
315
316         MVert *mvert = CDDM_get_verts ( dm );
317         MEdge *medge = CDDM_get_edges ( dm );
318         MFace *mface = CDDM_get_faces ( dm );
319
320         MVert *mvert2;
321         MFace *mface2;
322         unsigned int numtris=0;
323         unsigned int numquads=0;
324         EdgeHash *edgehash = NULL;
325         Cloth *cloth = clmd->clothObject;
326         ClothSpring *springs = cloth->springs;
327         unsigned int numsprings = cloth->numsprings;
328
329         // create spring tearing hash
330         edgehash = BLI_edgehash_new();
331
332         for ( i = 0; i < numsprings; i++ )
333         {
334                 if ( ( springs[i].flags & CLOTH_SPRING_FLAG_DEACTIVATE )
335                         && ( !BLI_edgehash_haskey ( edgehash, springs[i].ij, springs[i].kl ) ) )
336                 {
337                         BLI_edgehash_insert ( edgehash, springs[i].ij, springs[i].kl, NULL );
338                         BLI_edgehash_insert ( edgehash, springs[i].kl, springs[i].ij, NULL );
339                         j++;
340                 }
341         }
342
343         // printf("found %d tears\n", j);
344
345         result = CDDM_from_template ( dm, numverts, 0, numfaces );
346
347         if ( !result )
348                 return NULL;
349
350         // do verts
351         mvert2 = CDDM_get_verts ( result );
352         for ( a=0; a<numverts; a++ )
353         {
354                 MVert *inMV;
355                 MVert *mv = &mvert2[a];
356
357                 inMV = &mvert[a];
358
359                 DM_copy_vert_data ( dm, result, a, a, 1 );
360                 *mv = *inMV;
361         }
362
363
364         // do faces
365         mface2 = CDDM_get_faces ( result );
366         for ( a=0, i=0; a<numfaces; a++ )
367         {
368                 MFace *mf = &mface2[i];
369                 MFace *inMF;
370                 inMF = &mface[a];
371
372                 /*
373                 DM_copy_face_data(dm, result, a, i, 1);
374
375                 *mf = *inMF;
376                 */
377
378                 if ( ( !BLI_edgehash_haskey ( edgehash, mface[a].v1, mface[a].v2 ) )
379                         && ( !BLI_edgehash_haskey ( edgehash, mface[a].v2, mface[a].v3 ) )
380                         && ( !BLI_edgehash_haskey ( edgehash, mface[a].v3, mface[a].v4 ) )
381                         && ( !BLI_edgehash_haskey ( edgehash, mface[a].v4, mface[a].v1 ) ) )
382                 {
383                         mf->v1 = mface[a].v1;
384                         mf->v2 = mface[a].v2;
385                         mf->v3 = mface[a].v3;
386                         mf->v4 = mface[a].v4;
387
388                         test_index_face ( mf, NULL, 0, 4 );
389
390                         i++;
391                 }
392         }
393
394         CDDM_lower_num_faces ( result, i );
395         CDDM_calc_edges ( result );
396         CDDM_calc_normals ( result );
397
398         BLI_edgehash_free ( edgehash, NULL );
399
400         return result;
401 }
402
403
404 int cloth_cache_search_frame ( ClothModifierData *clmd, float time )
405 {
406         Frame *frame = NULL;
407         LinkNode *search = NULL;
408
409         if ( clmd->clothObject )
410         {
411                 search = clmd->sim_parms.cache;
412
413                 while ( search )
414                 {
415                         frame = ( Frame * ) search->link;
416
417                         if ( frame )
418                         {
419                                 if ( frame->time == time )
420                                         return 1;
421                         }
422
423                         search = search->next;
424                 }
425         }
426
427         return 0;
428
429 }
430
431 float cloth_cache_last_frame ( ClothModifierData *clmd )
432 {
433         Frame *frame = NULL;
434         LinkNode *search = NULL;
435         float time = 0;
436
437         if ( clmd->clothObject )
438         {
439                 search = clmd->sim_parms.cache;
440
441                 while ( search )
442                 {
443                         frame = ( Frame * ) search->link;
444
445                         if ( frame )
446                         {
447                                 if ( frame->time > time )
448                                         time = frame->time;
449                         }
450                 }
451         }
452         return time;
453 }
454
455 float cloth_cache_first_frame ( ClothModifierData *clmd )
456 {
457         Frame *frame = NULL;
458         LinkNode *search = NULL;
459         float time = -1.0;
460
461         if ( clmd->clothObject )
462         {
463                 search = clmd->sim_parms.cache;
464
465                 while ( search )
466                 {
467                         frame = ( Frame * ) search->link;
468
469                         if ( frame )
470                         {
471                                 if ( time < 0.0 )
472                                         time = frame->time;
473                                 else
474                                 {
475                                         if ( frame->time < time )
476                                                 time = frame->time;
477                                 }
478                         }
479                 }
480         }
481         return time;
482 }
483
484 void cloth_cache_get_frame ( ClothModifierData *clmd, float time )
485 {
486         Frame *frame = NULL;
487         LinkNode *search = NULL;
488         float newtime = time + clmd->sim_parms.preroll;
489
490         if ( clmd->clothObject )
491         {
492                 search = clmd->sim_parms.cache;
493
494                 while ( search )
495                 {
496                         frame = ( Frame * ) search->link;
497
498                         if ( frame )
499                         {
500                                 if ( frame->time == newtime )
501                                 {
502                                         // something changed, free cache!
503                                         if ( clmd->clothObject->numverts != frame->numverts )
504                                         {
505                                                 cloth_cache_free ( clmd, 0 );
506                                                 printf ( "clmd->clothObject->numverts != frame->numverts\n" );
507                                                 return;
508                                         }
509
510                                         memcpy ( clmd->clothObject->verts, frame->verts, sizeof ( ClothVertex ) *frame->numverts );
511                                         implicit_set_positions ( clmd );
512
513                                         return;
514                                 }
515                         }
516
517                         search = search->next;
518                 }
519         }
520 }
521
522 void cloth_cache_set_frame ( ClothModifierData *clmd, float time )
523 {
524         Frame *frame = NULL;
525         LinkNode *search = NULL;
526
527         if ( clmd->clothObject )
528         {
529                 frame = ( Frame * ) MEM_callocN ( sizeof ( Frame ), "cloth_cache_frame" );
530
531                 if ( frame )
532                 {
533                         frame->time = time;
534                         frame->numverts = clmd->clothObject->numverts;
535                         frame->verts = MEM_dupallocN ( clmd->clothObject->verts );
536
537                         if ( !frame->verts )
538                         {
539                                 MEM_freeN ( frame );
540                                 return;
541                         }
542
543                         BLI_linklist_append ( &clmd->sim_parms.cache, frame );
544
545                 }
546         }
547
548 }
549
550 // free cloth cache
551 void cloth_cache_free ( ClothModifierData *clmd, float time )
552 {
553         Frame *frame = NULL;
554         LinkNode *search = NULL, *lastsearch = NULL;
555         float newtime = time + clmd->sim_parms.preroll;
556
557         if ( time <= 2.0 )
558                 newtime = time;
559
560         if ( clmd->clothObject )
561         {
562                 if ( clmd->sim_parms.cache )
563                 {
564                         lastsearch = search = clmd->sim_parms.cache;
565
566                         while ( search )
567                         {
568                                 frame = ( Frame * ) search->link;
569
570                                 if ( frame->time >= newtime )
571                                 {
572                                         if ( frame->verts )
573                                         {
574                                                 MEM_freeN ( frame->verts );
575                                         }
576                                         MEM_freeN ( frame );
577
578                                         lastsearch->next = search->next;
579                                         MEM_freeN ( search );
580                                         search = lastsearch->next;
581                                         lastsearch->next = NULL;
582                                 }
583                                 else
584                                 {
585                                         lastsearch = search;
586                                         search = search->next;
587                                 }
588                         }
589
590                         if ( time <= 1.0 )
591                         {
592                                 clmd->sim_parms.cache = NULL;
593                         }
594
595                         if ( time <= 2.0 )
596                                 clmd->sim_parms.preroll = 0;
597                 }
598         }
599 }
600
601
602 /**
603 * cloth_deform_verts - simulates one step, framenr is in frames.
604 *
605 **/
606 void clothModifier_do ( ClothModifierData *clmd, Object *ob, DerivedMesh *dm,
607                         float ( *vertexCos ) [3], int numverts )
608 {
609         unsigned int i;
610         unsigned int numedges = -1;
611         unsigned int numfaces = -1;
612         MVert *mvert = NULL;
613         MEdge *medge = NULL;
614         MFace *mface = NULL;
615         DerivedMesh *result = NULL, *result2 = NULL;
616         Cloth *cloth = clmd->clothObject;
617         unsigned int framenr = ( float ) G.scene->r.cfra;
618         float current_time = bsystem_time ( ob, ( float ) G.scene->r.cfra, 0.0 );
619         ListBase        *effectors = NULL;
620         ClothVertex *newframe= NULL, *verts;
621         Frame *frame = NULL;
622         LinkNode *search = NULL;
623         float deltaTime = current_time - clmd->sim_parms.sim_time;
624         
625         // only be active during a specific period:
626         // that's "first frame" and "last frame" on GUI
627         if ( ! ( clmd->sim_parms.flags & CLOTH_SIMSETTINGS_FLAG_COLLOBJ ) )
628         {
629                 if ( clmd->clothObject )
630                 {
631                         if ( clmd->sim_parms.cache )
632                         {
633                                 if ( current_time < clmd->sim_parms.firstframe )
634                                 {
635                                         int frametime = cloth_cache_first_frame ( clmd );
636                                         if ( cloth_cache_search_frame ( clmd, frametime ) )
637                                         {
638                                                 cloth_cache_get_frame ( clmd, frametime );
639                                                 cloth_to_object ( ob, clmd, vertexCos, numverts );
640                                         }
641                                         return;
642                                 }
643                                 else if ( current_time > clmd->sim_parms.lastframe )
644                                 {
645                                         int frametime = cloth_cache_last_frame ( clmd );
646                                         if ( cloth_cache_search_frame ( clmd, frametime ) )
647                                         {
648                                                 cloth_cache_get_frame ( clmd, frametime );
649                                                 cloth_to_object ( ob, clmd, vertexCos, numverts );
650                                         }
651                                         return;
652                                 }
653                                 else if ( ABS ( deltaTime ) >= 2.0f ) // no timewarps allowed
654                                 {
655                                         if ( cloth_cache_search_frame ( clmd, framenr ) )
656                                         {
657                                                 cloth_cache_get_frame ( clmd, framenr );
658                                                 cloth_to_object ( ob, clmd, vertexCos, numverts );
659                                         }
660                                         clmd->sim_parms.sim_time = current_time;
661                                         return;
662                                 }
663                         }
664
665                 }
666         }
667
668
669         // unused in the moment, calculated seperately in implicit.c
670         clmd->sim_parms.dt = 1.0f / clmd->sim_parms.stepsPerFrame;
671
672         clmd->sim_parms.sim_time = current_time;
673         
674         if ( deltaTime == 1.0f )
675         {
676                 if ( ( clmd->clothObject == NULL ) || ( numverts != clmd->clothObject->numverts ) )
677                 {
678                         if ( !cloth_from_object ( ob, clmd, dm, vertexCos, numverts ) )
679                                 return;
680
681                         if ( clmd->clothObject == NULL )
682                                 return;
683
684                         cloth = clmd->clothObject;
685                 }
686
687                 clmd->clothObject->old_solver_type = clmd->sim_parms.solver_type;
688
689                 // Insure we have a clmd->clothObject, in case allocation failed.
690                 if ( clmd->clothObject != NULL )
691                 {
692                         if ( !cloth_cache_search_frame ( clmd, framenr ) )
693                         {
694                                 verts = cloth->verts;
695
696                                 // Force any pinned verts to their constrained location.
697                                 for ( i = 0; i < clmd->clothObject->numverts; i++, verts++ )
698                                 {
699                                         // Save the previous position.
700                                         VECCOPY ( verts->xold, verts->xconst );
701                                         VECCOPY ( verts->txold, verts->x );
702
703                                         // Get the current position.
704                                         VECCOPY ( verts->xconst, vertexCos[i] );
705                                         Mat4MulVecfl ( ob->obmat, verts->xconst );
706                                 }
707
708                                 tstart();
709
710                                 // Call the solver.
711                                 if ( solvers [clmd->sim_parms.solver_type].solver )
712                                         solvers [clmd->sim_parms.solver_type].solver ( ob, framenr, clmd, effectors );
713
714                                 tend();
715                                 printf ( "Cloth simulation time: %f\n", ( float ) tval() );
716
717                                 cloth_cache_set_frame ( clmd, framenr );
718
719                         }
720                         else // just retrieve the cached frame
721                         {
722                                 cloth_cache_get_frame ( clmd, framenr );
723                         }
724
725                         // Copy the result back to the object.
726                         cloth_to_object ( ob, clmd, vertexCos, numverts );
727
728                         // bvh_free(clmd->clothObject->tree);
729                         // clmd->clothObject->tree = bvh_build(clmd, clmd->coll_parms.epsilon);
730                 }
731
732         }
733         else if ( ( deltaTime <= 0.0f ) || ( deltaTime > 1.0f ) )
734         {
735                 if ( ( clmd->clothObject != NULL ) && ( clmd->sim_parms.cache ) )
736                 {
737                         if ( cloth_cache_search_frame ( clmd, framenr ) )
738                         {
739                                 cloth_cache_get_frame ( clmd, framenr );
740                                 cloth_to_object ( ob, clmd, vertexCos, numverts );
741                         }
742                 }
743         }
744
745 }
746
747 /* frees all */
748 void cloth_free_modifier ( ClothModifierData *clmd )
749 {
750         Cloth   *cloth = NULL;
751
752         if ( !clmd )
753                 return;
754
755         cloth = clmd->clothObject;
756
757         if ( ! ( clmd->sim_parms.flags & CLOTH_SIMSETTINGS_FLAG_CCACHE_PROTECT ) )
758         {
759                 // free our frame cache, TODO: but get to first position before
760                 cloth_cache_free ( clmd, 0 );
761
762                 if ( cloth )
763                 {
764
765                         // If our solver provides a free function, call it
766                         if ( cloth->old_solver_type < 255 && solvers [cloth->old_solver_type].free )
767                         {
768                                 solvers [cloth->old_solver_type].free ( clmd );
769                         }
770
771                         // Free the verts.
772                         if ( cloth->verts != NULL )
773                                 MEM_freeN ( cloth->verts );
774
775                         cloth->verts = NULL;
776                         cloth->numverts = 0;
777
778                         // Free the springs.
779                         if ( cloth->springs != NULL )
780                         {
781                                 LinkNode *search = cloth->springs;
782                                 while(search)
783                                 {
784                                         ClothSpring *spring = search->link;
785                                                         
786                                         MEM_freeN ( spring );
787                                         search = search->next;
788                                 }
789                                 BLI_linklist_free(cloth->springs, NULL);
790                         
791                                 cloth->springs = NULL;
792                         }
793
794                         cloth->springs = NULL;
795                         cloth->numsprings = 0;
796 /*
797                         // free BVH collision tree
798                         if ( cloth->tree )
799                                 bvh_free ( ( BVH * ) cloth->tree );
800 */
801                         // we save our faces for collision objects
802                         if ( cloth->mfaces )
803                                 MEM_freeN ( cloth->mfaces );
804                         /*
805                         if(clmd->clothObject->facemarks)
806                                 MEM_freeN(clmd->clothObject->facemarks);
807                         */
808                         MEM_freeN ( cloth );
809                         clmd->clothObject = NULL;
810                 }
811         }
812 }
813
814
815 /******************************************************************************
816 *
817 * Internal functions.
818 *
819 ******************************************************************************/
820
821 /**
822 * cloth_to_object - copies the deformed vertices to the object.
823 *
824 * This function is a modified version of the softbody.c:softbody_to_object() function.
825 **/
826 static void cloth_to_object ( Object *ob, ClothModifierData *clmd, float ( *vertexCos ) [3], unsigned int numverts )
827 {
828         ClothVertex     *verts = NULL;
829         unsigned int    i = 0;
830
831         if ( clmd->clothObject )
832         {
833                 verts = clmd->clothObject->verts;
834
835                 /* inverse matrix is not uptodate... */
836                 Mat4Invert ( ob->imat, ob->obmat );
837
838                 for ( i = 0; i < numverts; i++, verts++ )
839                 {
840                         VECCOPY ( vertexCos[i], verts->x );
841                         Mat4MulVecfl ( ob->imat, vertexCos[i] );        /* softbody is in global coords */
842                 }
843         }
844 }
845
846
847 /**
848 * cloth_apply_vgroup - applies a vertex group as specified by type
849 *
850 **/
851 static void cloth_apply_vgroup ( ClothModifierData *clmd, DerivedMesh *dm, short vgroup )
852 {
853         unsigned int i = 0;
854         unsigned int j = 0;
855         MDeformVert *dvert = NULL;
856         Cloth *clothObj = NULL;
857         unsigned int numverts = dm->getNumVerts ( dm );
858         float goalfac = 0;
859         ClothVertex *verts = NULL;
860
861         clothObj = clmd->clothObject;
862
863         if ( !dm )
864                 return;
865
866         numverts = dm->getNumVerts ( dm );
867
868         /* vgroup is 1 based, decrement so we can match the right group. */
869         --vgroup;
870
871         verts = clothObj->verts;
872
873         for ( i = 0; i < numverts; i++, verts++ )
874         {
875                 // LATER ON, support also mass painting here
876                 if ( clmd->sim_parms.flags & CLOTH_SIMSETTINGS_FLAG_GOAL )
877                 {
878                         dvert = dm->getVertData ( dm, i, CD_MDEFORMVERT );
879                         if ( dvert )
880                         {
881                                 for ( j = 0; j < dvert->totweight; j++ )
882                                 {
883                                         if ( dvert->dw[j].def_nr == vgroup )
884                                         {
885                                                 verts->goal = dvert->dw [j].weight;
886
887                                                 goalfac= ABS ( clmd->sim_parms.maxgoal - clmd->sim_parms.mingoal );
888                                                 verts->goal  = ( float ) pow ( verts->goal , 4.0f );
889
890                                                 if ( dvert->dw [j].weight >=SOFTGOALSNAP )
891                                                 {
892                                                         verts->flags |= CVERT_FLAG_PINNED;
893                                                 }
894
895                                                 // TODO enable mass painting here, for the moment i let "goals" go first
896
897                                                 break;
898                                         }
899                                 }
900                         }
901                 }
902         }
903 }
904
905 // only meshes supported at the moment
906 static int cloth_from_object ( Object *ob, ClothModifierData *clmd, DerivedMesh *dm, float ( *vertexCos ) [3], unsigned int numverts )
907 {
908         unsigned int i = 0;
909         // dm->getNumVerts(dm);
910         MVert *mvert = NULL; // CDDM_get_verts(dm);
911         ClothVertex *verts = NULL;
912         float tnull[3] = {0,0,0};
913
914         /* If we have a clothObject, free it. */
915         if ( clmd->clothObject != NULL )
916                 cloth_free_modifier ( clmd );
917
918         /* Allocate a new cloth object. */
919         clmd->clothObject = MEM_callocN ( sizeof ( Cloth ), "cloth" );
920         if ( clmd->clothObject )
921         {
922                 clmd->clothObject->old_solver_type = 255;
923                 // clmd->clothObject->old_collision_type = 255;
924         }
925         else if ( !clmd->clothObject )
926         {
927                 modifier_setError ( & ( clmd->modifier ), "Out of memory on allocating clmd->clothObject." );
928                 return 0;
929         }
930
931         switch ( ob->type )
932         {
933                 case OB_MESH:
934
935                         // mesh input objects need DerivedMesh
936                         if ( !dm )
937                                 return 0;
938
939                         cloth_from_mesh ( ob, clmd, dm );
940
941                         if ( clmd->clothObject != NULL )
942                         {
943                                 /* create springs */
944                                 clmd->clothObject->springs = NULL;
945                                 clmd->clothObject->numsprings = -1;
946
947                                 if ( !cloth_build_springs ( clmd->clothObject, dm ) )
948                                 {
949                                         modifier_setError ( & ( clmd->modifier ), "Can't build springs." );
950                                         return 0;
951                                 }
952
953                                 mvert = dm->getVertArray ( dm ); // CDDM_get_verts ( dm );
954                                 verts = clmd->clothObject->verts;
955
956                                 /* set initial values */
957                                 for ( i = 0; i < numverts; i++, verts++ )
958                                 {
959                                         VECCOPY ( verts->x, mvert[i].co );
960                                         Mat4MulVecfl ( ob->obmat, verts->x );
961
962                                         verts->mass = clmd->sim_parms.mass;
963
964                                         if ( clmd->sim_parms.flags & CLOTH_SIMSETTINGS_FLAG_GOAL )
965                                                 verts->goal= clmd->sim_parms.defgoal;
966                                         else
967                                                 verts->goal= 0.0f;
968
969                                         verts->flags = 0;
970                                         VECCOPY ( verts->xold, verts->x );
971                                         VECCOPY ( verts->xconst, verts->x );
972                                         VECCOPY ( verts->txold, verts->x );
973                                         VecMulf ( verts->v, 0.0f );
974
975                                         verts->impulse_count = 0;
976                                         VECCOPY ( verts->impulse, tnull );
977                                 }
978
979                                 // apply / set vertex groups
980                                 if ( clmd->sim_parms.vgroup_mass > 0 )
981                                         cloth_apply_vgroup ( clmd, dm, clmd->sim_parms.vgroup_mass );
982
983                                 // init our solver
984                                 if ( solvers [clmd->sim_parms.solver_type].init )
985                                         solvers [clmd->sim_parms.solver_type].init ( ob, clmd );
986
987                                 // clmd->clothObject->tree = bvh_build ( dm, clmd->coll_parms.epsilon );
988
989                                 cloth_cache_set_frame ( clmd, 1 );
990                         }
991
992                         return 1;
993                 case OB_LATTICE:
994                         printf ( "Not supported: OB_LATTICE\n" );
995                         // lattice_to_softbody(ob);
996                         return 1;
997                 case OB_CURVE:
998                 case OB_SURF:
999                         printf ( "Not supported: OB_SURF| OB_CURVE\n" );
1000                         return 1;
1001                 default: return 0; // TODO - we do not support changing meshes
1002         }
1003
1004         return 0;
1005 }
1006
1007 static void cloth_from_mesh ( Object *ob, ClothModifierData *clmd, DerivedMesh *dm )
1008 {
1009         unsigned int numverts = dm->getNumVerts ( dm );
1010         unsigned int numfaces = dm->getNumFaces ( dm );
1011         MFace *mface = dm->getFaceArray ( dm );
1012         unsigned int i = 0;
1013
1014         /* Allocate our vertices.
1015         */
1016         clmd->clothObject->numverts = numverts;
1017         clmd->clothObject->verts = MEM_callocN ( sizeof ( ClothVertex ) * clmd->clothObject->numverts, "clothVertex" );
1018         if ( clmd->clothObject->verts == NULL )
1019         {
1020                 cloth_free_modifier ( clmd );
1021                 modifier_setError ( & ( clmd->modifier ), "Out of memory on allocating clmd->clothObject->verts." );
1022                 return;
1023         }
1024
1025         // save face information
1026         clmd->clothObject->numfaces = numfaces;
1027         clmd->clothObject->mfaces = MEM_callocN ( sizeof ( MFace ) * clmd->clothObject->numfaces, "clothMFaces" );
1028         if ( clmd->clothObject->mfaces == NULL )
1029         {
1030                 cloth_free_modifier ( clmd );
1031                 modifier_setError ( & ( clmd->modifier ), "Out of memory on allocating clmd->clothObject->mfaces." );
1032                 return;
1033         }
1034         for ( i = 0; i < numfaces; i++ )
1035                 memcpy ( &clmd->clothObject->mfaces[i], &mface[i], sizeof ( MFace ) );
1036
1037         /* Free the springs since they can't be correct if the vertices
1038         * changed.
1039         */
1040         if ( clmd->clothObject->springs != NULL )
1041                 MEM_freeN ( clmd->clothObject->springs );
1042
1043 }
1044
1045 /***************************************************************************************
1046 * SPRING NETWORK BUILDING IMPLEMENTATION BEGIN
1047 ***************************************************************************************/
1048
1049 // be carefull: implicit solver has to be resettet when using this one!
1050 int cloth_add_spring ( ClothModifierData *clmd, unsigned int indexA, unsigned int indexB, float restlength, int spring_type)
1051 {
1052         Cloth *cloth = clmd->clothObject;
1053         ClothSpring *spring = NULL;
1054         
1055         if(cloth)
1056         {
1057                 // TODO: look if this spring is already there
1058                 
1059                 spring = ( ClothSpring * ) MEM_callocN ( sizeof ( ClothSpring ), "cloth spring" );
1060                 
1061                 spring->ij = indexA;
1062                 spring->kl = indexB;
1063                 spring->restlen =  restlength;
1064                 spring->type = spring_type;
1065                 spring->flags = 0;
1066                 
1067                 cloth->numsprings++;
1068         
1069                 BLI_linklist_append ( &cloth->springs, spring );
1070         }
1071 }
1072
1073 int cloth_build_springs ( Cloth *cloth, DerivedMesh *dm )
1074 {
1075         ClothSpring *spring = NULL, *tspring = NULL, *tspring2 = NULL;
1076         unsigned int struct_springs = 0, shear_springs=0, bend_springs = 0;
1077         unsigned int i = 0;
1078         unsigned int numverts = dm->getNumVerts ( dm );
1079         unsigned int numedges = dm->getNumEdges ( dm );
1080         unsigned int numfaces = dm->getNumFaces ( dm );
1081         MVert *mvert = CDDM_get_verts ( dm );
1082         MEdge *medge = CDDM_get_edges ( dm );
1083         MFace *mface = CDDM_get_faces ( dm );
1084         unsigned int index2 = 0; // our second vertex index
1085         LinkNode **edgelist = NULL;
1086         EdgeHash *edgehash = NULL;
1087         LinkNode *search = NULL, *search2 = NULL;
1088         float temp[3];
1089
1090         // error handling
1091         if ( numedges==0 )
1092                 return 0;
1093
1094         cloth->springs = NULL;
1095
1096         edgelist = MEM_callocN ( sizeof ( LinkNode * ) * numverts, "cloth_edgelist_alloc" );
1097         for ( i = 0; i < numverts; i++ )
1098         {
1099                 edgelist[i] = NULL;
1100         }
1101
1102         if ( cloth->springs )
1103                 MEM_freeN ( cloth->springs );
1104
1105         // create spring network hash
1106         edgehash = BLI_edgehash_new();
1107
1108         // structural springs
1109         for ( i = 0; i < numedges; i++ )
1110         {
1111                 spring = ( ClothSpring * ) MEM_callocN ( sizeof ( ClothSpring ), "cloth spring" );
1112
1113                 if ( spring )
1114                 {
1115                         spring->ij = medge[i].v1;
1116                         spring->kl = medge[i].v2;
1117                         VECSUB ( temp, mvert[spring->kl].co, mvert[spring->ij].co );
1118                         spring->restlen =  sqrt ( INPR ( temp, temp ) );
1119                         spring->type = CLOTH_SPRING_TYPE_STRUCTURAL;
1120                         spring->flags = 0;
1121                         struct_springs++;
1122
1123                         BLI_linklist_append ( &cloth->springs, spring );
1124                 }
1125         }
1126
1127         // shear springs
1128         for ( i = 0; i < numfaces; i++ )
1129         {
1130                 spring = ( ClothSpring *) MEM_callocN ( sizeof ( ClothSpring ), "cloth spring" );
1131
1132                 spring->ij = mface[i].v1;
1133                 spring->kl = mface[i].v3;
1134                 VECSUB ( temp, mvert[spring->kl].co, mvert[spring->ij].co );
1135                 spring->restlen =  sqrt ( INPR ( temp, temp ) );
1136                 spring->type = CLOTH_SPRING_TYPE_SHEAR;
1137
1138                 BLI_linklist_append ( &edgelist[spring->ij], spring );
1139                 BLI_linklist_append ( &edgelist[spring->kl], spring );
1140                 shear_springs++;
1141
1142                 BLI_linklist_append ( &cloth->springs, spring );
1143
1144                 if ( mface[i].v4 )
1145                 {
1146                         spring = ( ClothSpring * ) MEM_callocN ( sizeof ( ClothSpring ), "cloth spring" );
1147
1148                         spring->ij = mface[i].v1;
1149                         spring->kl = mface[i].v3;
1150                         VECSUB ( temp, mvert[spring->kl].co, mvert[spring->ij].co );
1151                                 spring->restlen =  sqrt ( INPR ( temp, temp ) );
1152                                 spring->type = CLOTH_SPRING_TYPE_SHEAR;
1153
1154                                 BLI_linklist_append ( &edgelist[spring->ij], spring );
1155                                 BLI_linklist_append ( &edgelist[spring->kl], spring );
1156                                 shear_springs++;
1157
1158                                 BLI_linklist_append ( &cloth->springs, spring );
1159                 }
1160         }
1161
1162         // bending springs
1163         search2 = cloth->springs;
1164         for ( i = struct_springs; i < struct_springs+shear_springs; i++ )
1165         {
1166                 if ( !search2 )
1167                         break;
1168
1169                 tspring2 = search2->link;
1170                 search = edgelist[tspring2->kl];
1171                 while ( search )
1172                 {
1173                         tspring = search->link;
1174                         index2 = ( ( tspring->ij==tspring2->kl ) ? ( tspring->kl ) : ( tspring->ij ) );
1175                         
1176                         // check for existing spring
1177                         // check also if startpoint is equal to endpoint
1178                         if ( !BLI_edgehash_haskey ( edgehash, index2, tspring2->ij )
1179                                 && !BLI_edgehash_haskey ( edgehash, tspring2->ij, index2 )
1180                                 && ( index2!=tspring2->ij ) )
1181                         {
1182                                 spring = ( ClothSpring * ) MEM_callocN ( sizeof ( ClothSpring ), "cloth spring" );
1183
1184                                 spring->ij = tspring2->ij;
1185                                 spring->kl = index2;
1186                                 VECSUB ( temp, mvert[index2].co, mvert[tspring2->ij].co );
1187                                 spring->restlen =  sqrt ( INPR ( temp, temp ) );
1188                                 spring->type = CLOTH_SPRING_TYPE_BENDING;
1189                                 BLI_edgehash_insert ( edgehash, spring->ij, index2, NULL );
1190                                 bend_springs++;
1191
1192                                 BLI_linklist_append ( &cloth->springs, spring );
1193                         }
1194                         search = search->next;
1195                 }
1196                 search2 = search2->next;
1197         }
1198
1199         cloth->numsprings = struct_springs + shear_springs + bend_springs;
1200
1201         for ( i = 0; i < numverts; i++ )
1202         {
1203                 BLI_linklist_free ( edgelist[i],NULL );
1204         }
1205         if ( edgelist )
1206                 MEM_freeN ( edgelist );
1207
1208         BLI_edgehash_free ( edgehash, NULL );
1209
1210         return 1;
1211
1212 } /* cloth_build_springs */
1213 /***************************************************************************************
1214 * SPRING NETWORK BUILDING IMPLEMENTATION END
1215 ***************************************************************************************/
1216