2nd try to merge sim_physics with trunk rev 19825
[blender.git] / source / blender / blenkernel / BKE_cloth.h
1 /**
2  * BKE_cloth.h
3  *
4  * $Id: BKE_cloth.h,v 1.1 2007/08/01 02:07:27 daniel Exp $
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) Blender Foundation.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): Daniel Genrich
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef BKE_CLOTH_H
32 #define BKE_CLOTH_H
33
34 #include <float.h>
35
36 #include "BLI_linklist.h"
37 #include "BKE_customdata.h"
38 #include "BKE_DerivedMesh.h"
39
40 #include "BLI_blenlib.h"
41 #include "BLI_arithb.h"
42 #include "BLI_edgehash.h"
43
44 #include "DNA_cloth_types.h"
45 #include "DNA_customdata_types.h"
46 #include "DNA_meshdata_types.h"
47 #include "DNA_modifier_types.h"
48 #include "DNA_object_types.h"
49
50 #include "BKE_collision.h"
51
52 struct Object;
53
54 struct MFace;
55 struct DerivedMesh;
56 struct ClothModifierData;
57 struct CollisionTree;
58
59 // this is needed for inlining behaviour
60 #if defined _WIN32
61 #   define DO_INLINE __inline
62 #elif defined (__sgi)
63 #   define DO_INLINE
64 #elif defined (__sun) || defined (__sun__)
65 #   define DO_INLINE
66 #else
67 #   define DO_INLINE inline
68 #   define LINUX
69 #endif
70
71 #define CLOTH_MAX_THREAD 2
72
73 /* goal defines */
74 #define SOFTGOALSNAP  0.999f
75
76 /* This is approximately the smallest number that can be
77 * represented by a float, given its precision. */
78 #define ALMOST_ZERO             FLT_EPSILON
79
80 /* Bits to or into the ClothVertex.flags. */
81 #define CLOTH_VERT_FLAG_PINNED 1
82 #define CLOTH_VERT_FLAG_COLLISION 2
83 #define CLOTH_VERT_FLAG_PINNED_EM 3
84
85 /**
86 * This structure describes a cloth object against which the
87 * simulation can run.
88 *
89 * The m and n members of this structure represent the assumed
90 * rectangular ordered grid for which the original paper is written.
91 * At some point they need to disappear and we need to determine out
92 * own connectivity of the mesh based on the actual edges in the mesh.
93 *
94 **/
95 typedef struct Cloth
96 {
97         struct ClothVertex      *verts;                 /* The vertices that represent this cloth. */
98         struct  LinkNode        *springs;               /* The springs connecting the mesh. */
99         unsigned int            numverts;               /* The number of verts == m * n. */
100         unsigned int            numsprings;             /* The count of springs. */
101         unsigned int            numfaces;
102         unsigned char           old_solver_type;        /* unused, only 1 solver here */
103         unsigned char           pad2;
104         short                   pad3;
105         struct BVHTree          *bvhtree;                       /* collision tree for this cloth object */
106         struct BVHTree          *bvhselftree;                   /* collision tree for this cloth object */
107         struct MFace            *mfaces;
108         struct Implicit_Data    *implicit;              /* our implicit solver connects to this pointer */
109         struct Implicit_Data    *implicitEM;            /* our implicit solver connects to this pointer */
110         struct EdgeHash         *edgehash;              /* used for selfcollisions */
111 } Cloth;
112
113 /**
114  * The definition of a cloth vertex.
115  */
116 typedef struct ClothVertex
117 {
118         int     flags;          /* General flags per vertex.            */
119         float   v [3];          /* The velocity of the point.           */
120         float   xconst [3];     /* constrained position                 */
121         float   x [3];          /* The current position of this vertex. */
122         float   xold [3];       /* The previous position of this vertex.*/
123         float   tx [3];         /* temporary position */
124         float   txold [3];      /* temporary old position */
125         float   tv[3];          /* temporary "velocity", mostly used as tv = tx-txold */
126         float   mass;           /* mass / weight of the vertex          */
127         float   goal;           /* goal, from SB                        */
128         float   impulse[3];     /* used in collision.c */
129         unsigned int impulse_count; /* same as above */
130         float   avg_spring_len; /* average length of connected springs */
131         float   struct_stiff;
132         float   bend_stiff;
133         float   shear_stiff;
134         int     spring_count; /* how many springs attached? */
135 }
136 ClothVertex;
137
138 /**
139  * The definition of a spring.
140  */
141 typedef struct ClothSpring
142 {
143         int     ij;             /* Pij from the paper, one end of the spring.   */
144         int     kl;             /* Pkl from the paper, one end of the spring.   */
145         float   restlen;        /* The original length of the spring.   */
146         int     matrix_index;   /* needed for implicit solver (fast lookup) */
147         int     type;           /* types defined in BKE_cloth.h ("springType") */
148         int     flags;          /* defined in BKE_cloth.h, e.g. deactivated due to tearing */
149         float dfdx[3][3];
150         float dfdv[3][3];
151         float f[3];
152         float   stiffness;      /* stiffness factor from the vertex groups */
153         float editrestlen;
154 }
155 ClothSpring;
156
157 // some macro enhancements for vector treatment
158 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
159 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
160 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
161 #define VECSUBADDSS(v1,v2,aS,v3,bS)     {*(v1)-= *(v2)*aS + *(v3)*bS; *(v1+1)-= *(v2+1)*aS + *(v3+1)*bS; *(v1+2)-= *(v2+2)*aS + *(v3+2)*bS;}
162 #define VECADDSUBSS(v1,v2,aS,v3,bS)     {*(v1)+= *(v2)*aS - *(v3)*bS; *(v1+1)+= *(v2+1)*aS - *(v3+1)*bS; *(v1+2)+= *(v2+2)*aS - *(v3+2)*bS;}
163 #define VECADDSS(v1,v2,aS,v3,bS)        {*(v1)= *(v2)*aS + *(v3)*bS; *(v1+1)= *(v2+1)*aS + *(v3+1)*bS; *(v1+2)= *(v2+2)*aS + *(v3+2)*bS;}
164 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
165 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
166 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
167 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
168 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
169 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
170
171 /* SIMULATION FLAGS: goal flags,.. */
172 /* These are the bits used in SimSettings.flags. */
173 typedef enum
174 {
175         CLOTH_SIMSETTINGS_FLAG_COLLOBJ = ( 1 << 2 ),// object is only collision object, no cloth simulation is done
176         CLOTH_SIMSETTINGS_FLAG_GOAL = ( 1 << 3 ),       // we have goals enabled
177         CLOTH_SIMSETTINGS_FLAG_TEARING = ( 1 << 4 ),// true if tearing is enabled
178         CLOTH_SIMSETTINGS_FLAG_SCALING = ( 1 << 8 ), /* is advanced scaling active? */
179         CLOTH_SIMSETTINGS_FLAG_CCACHE_EDIT = (1 << 12)  /* edit cache in editmode */
180 } CLOTH_SIMSETTINGS_FLAGS;
181
182 /* COLLISION FLAGS */
183 typedef enum
184 {
185         CLOTH_COLLSETTINGS_FLAG_ENABLED = ( 1 << 1 ), /* enables cloth - object collisions */
186         CLOTH_COLLSETTINGS_FLAG_SELF = ( 1 << 2 ), /* enables selfcollisions */
187 } CLOTH_COLLISIONSETTINGS_FLAGS;
188
189 /* Spring types as defined in the paper.*/
190 typedef enum
191 {
192         CLOTH_SPRING_TYPE_STRUCTURAL  = ( 1 << 1 ),
193         CLOTH_SPRING_TYPE_SHEAR  = ( 1 << 2 ) ,
194         CLOTH_SPRING_TYPE_BENDING  = ( 1 << 3 ),
195         CLOTH_SPRING_TYPE_GOAL  = ( 1 << 4 ),
196 } CLOTH_SPRING_TYPES;
197
198 /* SPRING FLAGS */
199 typedef enum
200 {
201         CLOTH_SPRING_FLAG_DEACTIVATE = ( 1 << 1 ),
202         CLOTH_SPRING_FLAG_NEEDED = ( 1 << 2 ), // springs has values to be applied
203 } CLOTH_SPRINGS_FLAGS;
204
205
206 /////////////////////////////////////////////////
207 // collision.c
208 ////////////////////////////////////////////////
209
210 // needed for implicit.c
211 int cloth_bvh_objcollision ( Object *ob, ClothModifierData * clmd, float step, float dt );
212
213 ////////////////////////////////////////////////
214
215
216 ////////////////////////////////////////////////
217 // implicit.c
218 ////////////////////////////////////////////////
219
220 // needed for cloth.c
221 int implicit_init ( Object *ob, ClothModifierData *clmd );
222 int implicit_free ( ClothModifierData *clmd );
223 int implicit_solver ( Object *ob, float frame, ClothModifierData *clmd, ListBase *effectors );
224 void implicit_set_positions ( ClothModifierData *clmd );
225
226 // globally needed
227 void clmdSetInterruptCallBack ( int ( *f ) ( void ) );
228 ////////////////////////////////////////////////
229
230
231 /////////////////////////////////////////////////
232 // cloth.c
233 ////////////////////////////////////////////////
234
235 // needed for modifier.c
236 void cloth_free_modifier_extern ( ClothModifierData *clmd );
237 void cloth_free_modifier ( Object *ob, ClothModifierData *clmd );
238 void cloth_init ( ClothModifierData *clmd );
239 DerivedMesh *clothModifier_do ( ClothModifierData *clmd,Object *ob, DerivedMesh *dm, int useRenderParams, int isFinalCalc );
240
241 void cloth_update_normals ( ClothVertex *verts, int nVerts, MFace *face, int totface );
242
243 // needed for collision.c
244 void bvhtree_update_from_cloth ( ClothModifierData *clmd, int moving );
245 void bvhselftree_update_from_cloth ( ClothModifierData *clmd, int moving );
246
247 // needed for editmesh.c
248 void cloth_write_cache ( Object *ob, ClothModifierData *clmd, float framenr );
249 int cloth_read_cache ( Object *ob, ClothModifierData *clmd, float framenr );
250
251 // needed for button_object.c
252 void cloth_clear_cache ( Object *ob, ClothModifierData *clmd, float framenr );
253
254 // needed for cloth.c
255 int cloth_add_spring ( ClothModifierData *clmd, unsigned int indexA, unsigned int indexB, float restlength, int spring_type);
256
257 ////////////////////////////////////////////////
258
259
260 /* This enum provides the IDs for our solvers. */
261 // only one available in the moment
262 typedef enum
263 {
264         CM_IMPLICIT = 0,
265 } CM_SOLVER_ID;
266
267
268 /* This structure defines how to call the solver.
269 */
270 typedef struct
271 {
272         char            *name;
273         CM_SOLVER_ID    id;
274         int     ( *init ) ( Object *ob, ClothModifierData *clmd );
275         int     ( *solver ) ( Object *ob, float framenr, ClothModifierData *clmd, ListBase *effectors );
276         int     ( *free ) ( ClothModifierData *clmd );
277 }
278 CM_SOLVER_DEF;
279
280
281 #endif
282