f5bd028ba0d23bbd6d047073a05bf5b4a798111b
[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/BL DUAL 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. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) Blender Foundation.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34 #ifndef BKE_CLOTH_H
35 #define BKE_CLOTH_H
36
37 #include "float.h"
38 #include "BLI_editVert.h"
39 #include "BLI_linklist.h"
40
41 #include "BKE_collision.h"
42 #include "BKE_customdata.h"
43 #include "BKE_DerivedMesh.h"
44
45 #include "DNA_cloth_types.h"
46 #include "DNA_customdata_types.h"
47 #include "DNA_meshdata_types.h"
48 #include "DNA_modifier_types.h"
49 #include "DNA_object_types.h"
50
51 struct Object;
52 struct Cloth;
53 struct MFace;
54 struct DerivedMesh;
55 struct ClothModifierData;
56 struct CollisionTree;
57
58 // this is needed for inlining behaviour
59 #ifndef _WIN32
60 #define LINUX
61 #define DO_INLINE inline
62 #else
63 #define DO_INLINE
64 #endif
65
66 #define CLOTH_MAX_THREAD 2
67
68 /* goal defines */
69 #define SOFTGOALSNAP  0.999f
70
71 /* This is approximately the smallest number that can be
72 * represented by a float, given its precision. */
73 #define ALMOST_ZERO             FLT_EPSILON
74
75 /* Bits to or into the ClothVertex.flags. */
76 #define CLOTH_VERT_FLAG_PINNED 1
77 #define CLOTH_VERT_FLAG_COLLISION 2
78 #define CLOTH_VERT_FLAG_PINNED_EM 3
79
80 /**
81  * The definition of a cloth vertex.
82  */
83 typedef struct ClothVertex
84 {
85         int     flags;          /* General flags per vertex.            */
86         float   v [3];          /* The velocity of the point.           */
87         float   xconst [3];     /* constrained position                 */
88         float   x [3];          /* The current position of this vertex. */
89         float   xold [3];       /* The previous position of this vertex.*/
90         float   tx [3];         /* temporary position */
91         float   txold [3];      /* temporary old position */
92         float   tv[3];          /* temporary "velocity", mostly used as tv = tx-txold */
93         float   mass;           /* mass / weight of the vertex          */
94         float   goal;           /* goal, from SB                        */
95         float   impulse[3];     /* used in collision.c */
96         unsigned int impulse_count; /* same as above */
97         float   avg_spring_len; /* average length of connected springs */
98         float   struct_stiff;
99         float   bend_stiff;
100         float   shear_stiff;
101         int     spring_count; /* how many springs attached? */
102 }
103 ClothVertex;
104
105 /**
106  * The definition of a spring.
107  */
108 typedef struct ClothSpring
109 {
110         int     ij;             /* Pij from the paper, one end of the spring.   */
111         int     kl;             /* Pkl from the paper, one end of the spring.   */
112         float   restlen;        /* The original length of the spring.   */
113         int     matrix_index;   /* needed for implicit solver (fast lookup) */
114         int     type;           /* types defined in BKE_cloth.h ("springType") */
115         int     flags;          /* defined in BKE_cloth.h, e.g. deactivated due to tearing */
116         float dfdx[3][3];
117         float dfdv[3][3];
118         float f[3];
119         float   stiffness;      /* stiffness factor from the vertex groups */
120         float editrestlen;
121 }
122 ClothSpring;
123
124 // some macro enhancements for vector treatment
125 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
126 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
127 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
128 #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;}
129 #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;}
130 #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;}
131 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
132 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
133 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
134 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
135 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
136 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
137
138 /* SIMULATION FLAGS: goal flags,.. */
139 /* These are the bits used in SimSettings.flags. */
140 typedef enum
141 {
142         CLOTH_SIMSETTINGS_FLAG_RESET = ( 1 << 1 ),      // The CM object requires a reinitializaiton.
143         CLOTH_SIMSETTINGS_FLAG_COLLOBJ = ( 1 << 2 ),// object is only collision object, no cloth simulation is done
144         CLOTH_SIMSETTINGS_FLAG_GOAL = ( 1 << 3 ),       // we have goals enabled
145         CLOTH_SIMSETTINGS_FLAG_TEARING = ( 1 << 4 ),// true if tearing is enabled
146         CLOTH_SIMSETTINGS_FLAG_CCACHE_PROTECT = ( 1 << 5 ), // true if tearing is enabled
147         CLOTH_SIMSETTINGS_FLAG_EDITMODE = ( 1 << 6 ), // are we in editmode? -several things disabled
148         CLOTH_SIMSETTINGS_FLAG_CCACHE_FFREE = ( 1 << 7 ), /* force cache freeing */
149         CLOTH_SIMSETTINGS_FLAG_SCALING = ( 1 << 8 ), /* is advanced scaling active? */
150         CLOTH_SIMSETTINGS_FLAG_LOADED = ( 1 << 9 ), /* did we just got load? */
151         CLOTH_SIMSETTINGS_FLAG_AUTOPROTECT = ( 1 << 10 ), /* is autoprotect enabled? */
152 } CLOTH_SIMSETTINGS_FLAGS;
153
154 /* COLLISION FLAGS */
155 typedef enum
156 {
157         CLOTH_COLLSETTINGS_FLAG_ENABLED = ( 1 << 1 ), /* enables cloth - object collisions */
158         CLOTH_COLLSETTINGS_FLAG_SELF = ( 1 << 2 ), /* enables selfcollisions */
159 } CLOTH_COLLISIONSETTINGS_FLAGS;
160
161 /* Spring types as defined in the paper.*/
162 typedef enum
163 {
164         CLOTH_SPRING_TYPE_STRUCTURAL  = ( 1 << 1 ),
165         CLOTH_SPRING_TYPE_SHEAR  = ( 1 << 2 ) ,
166         CLOTH_SPRING_TYPE_BENDING  = ( 1 << 3 ),
167         CLOTH_SPRING_TYPE_GOAL  = ( 1 << 4 ),
168 } CLOTH_SPRING_TYPES;
169
170 /* SPRING FLAGS */
171 typedef enum
172 {
173         CLOTH_SPRING_FLAG_DEACTIVATE = ( 1 << 1 ),
174         CLOTH_SPRING_FLAG_NEEDED = ( 1 << 2 ), // springs has values to be applied
175 } CLOTH_SPRINGS_FLAGS;
176
177 /////////////////////////////////////////////////
178 // collision.c
179 ////////////////////////////////////////////////
180
181 // needed for implicit.c
182 int cloth_bvh_objcollision ( ClothModifierData * clmd, float step, float dt );
183
184 ////////////////////////////////////////////////
185
186
187 ////////////////////////////////////////////////
188 // implicit.c
189 ////////////////////////////////////////////////
190
191 // needed for cloth.c
192 int implicit_init ( Object *ob, ClothModifierData *clmd );
193 int implicit_free ( ClothModifierData *clmd );
194 int implicit_solver ( Object *ob, float frame, ClothModifierData *clmd, ListBase *effectors );
195 void implicit_set_positions ( ClothModifierData *clmd );
196
197 // globally needed
198 void clmdSetInterruptCallBack ( int ( *f ) ( void ) );
199 ////////////////////////////////////////////////
200
201
202 /////////////////////////////////////////////////
203 // cloth.c
204 ////////////////////////////////////////////////
205
206 // needed for modifier.c
207 void cloth_free_modifier_extern ( ClothModifierData *clmd );
208 void cloth_free_modifier ( Object *ob, ClothModifierData *clmd );
209 void cloth_init ( ClothModifierData *clmd );
210 DerivedMesh *clothModifier_do ( ClothModifierData *clmd,Object *ob, DerivedMesh *dm, int useRenderParams, int isFinalCalc );
211
212 void cloth_update_normals ( ClothVertex *verts, int nVerts, MFace *face, int totface );
213
214 // needed for collision.c
215 void bvh_update_from_cloth ( ClothModifierData *clmd, int moving );
216
217 // needed for editmesh.c
218 void cloth_write_cache ( Object *ob, ClothModifierData *clmd, float framenr );
219 int cloth_read_cache ( Object *ob, ClothModifierData *clmd, float framenr );
220
221 // needed for button_object.c
222 void cloth_clear_cache ( Object *ob, ClothModifierData *clmd, float framenr );
223
224 // needed for cloth.c
225 int cloth_add_spring ( ClothModifierData *clmd, unsigned int indexA, unsigned int indexB, float restlength, int spring_type);
226
227 ////////////////////////////////////////////////
228
229
230 /* Typedefs for function pointers we need for solvers and collision detection. */
231 typedef void ( *CM_COLLISION_SELF ) ( ClothModifierData *clmd, int step );
232 typedef void ( *CM_COLLISION_OBJ ) ( ClothModifierData *clmd, int step, CM_COLLISION_RESPONSE collision_response );
233
234
235 /* This enum provides the IDs for our solvers. */
236 // only one available in the moment
237 typedef enum
238 {
239         CM_IMPLICIT = 0,
240 } CM_SOLVER_ID;
241
242
243 /* This structure defines how to call the solver.
244 */
245 typedef struct
246 {
247         char            *name;
248         CM_SOLVER_ID    id;
249         int     ( *init ) ( Object *ob, ClothModifierData *clmd );
250         int     ( *solver ) ( Object *ob, float framenr, ClothModifierData *clmd, ListBase *effectors );
251         int     ( *free ) ( ClothModifierData *clmd );
252 }
253 CM_SOLVER_DEF;
254
255 /* used for caching in implicit.c */
256 typedef struct Frame
257 {
258         ClothVertex *verts;
259         ClothSpring *springs;
260         unsigned int numverts, numsprings;
261         float time; /* we need float since we want to support sub-frames */
262 }
263 Frame;
264
265 #endif
266