Initial commit of cloth modifier from branch rev 13453
[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_linklist.h"
39 #include "BKE_collision.h"
40 #include "BKE_customdata.h"
41 #include "BKE_DerivedMesh.h"
42 #include "DNA_cloth_types.h"
43 #include "DNA_customdata_types.h"
44 #include "DNA_meshdata_types.h"
45 #include "DNA_modifier_types.h"
46 #include "DNA_object_types.h"
47
48 struct Object;
49 struct Cloth;
50 struct MFace;
51 struct DerivedMesh;
52 struct ClothModifierData;
53 struct CollisionTree;
54
55 // this is needed for inlining behaviour
56 #ifndef _WIN32
57 #define LINUX
58 #define DO_INLINE inline
59 #else
60 #define DO_INLINE
61 #endif
62
63 #define CLOTH_MAX_THREAD 2
64
65 /**
66  * The definition of a cloth vertex.
67  */
68 typedef struct ClothVertex
69 {
70         int     flags;          /* General flags per vertex.            */
71         float   v [3];          /* The velocity of the point.           */
72         float   xconst [3];     /* constrained position                 */
73         float   x [3];          /* The current position of this vertex. */
74         float   xold [3];       /* The previous position of this vertex.*/
75         float   tx [3];         /* temporary position */
76         float   txold [3];      /* temporary old position */
77         float   tv[3];          /* temporary "velocity", mostly used as tv = tx-txold */
78         float   mass;           /* mass / weight of the vertex          */
79         float   goal;           /* goal, from SB                        */
80         float   impulse[3];     /* used in collision.c */
81         unsigned int impulse_count; /* same as above */
82         float   avg_spring_len; /* average length of connected springs, UNUSED ATM */
83         float   struct_stiff;
84         float   bend_stiff;
85         float   shear_stiff;
86 }
87 ClothVertex;
88
89 /**
90  * The definition of a spring.
91  */
92 typedef struct ClothSpring
93 {
94         int     ij;             /* Pij from the paper, one end of the spring.   */
95         int     kl;             /* Pkl from the paper, one end of the spring.   */
96         float   restlen;        /* The original length of the spring.   */
97         int     matrix_index;   /* needed for implicit solver (fast lookup) */
98         int     type;           /* types defined in BKE_cloth.h ("springType") */
99         int     flags;          /* defined in BKE_cloth.h, e.g. deactivated due to tearing */
100         float dfdx[3][3];
101         float dfdv[3][3];
102         float f[3];
103         float   stiffness;      /* stiffness factor from the vertex groups */
104 }
105 ClothSpring;
106
107 /* goal defines */
108 #define SOFTGOALSNAP  0.999f
109
110 /* This is approximately the smallest number that can be
111 * represented by a float, given its precision. */
112 #define ALMOST_ZERO             FLT_EPSILON
113
114 // some macro enhancements for vector treatment
115 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
116 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
117 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
118 #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;}
119 #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;}
120 #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;}
121 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
122 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
123 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
124 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
125 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
126 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
127
128 /* SIMULATION FLAGS: goal flags,.. */
129 /* These are the bits used in SimSettings.flags. */
130 typedef enum
131 {
132         CLOTH_SIMSETTINGS_FLAG_RESET = ( 1 << 1 ),      // The CM object requires a reinitializaiton.
133                                          CLOTH_SIMSETTINGS_FLAG_COLLOBJ = ( 1 << 2 ),// object is only collision object, no cloth simulation is done
134                                                          CLOTH_SIMSETTINGS_FLAG_GOAL = ( 1 << 3 ),      // we have goals enabled
135                                                                          CLOTH_SIMSETTINGS_FLAG_TEARING = ( 1 << 4 ),// true if tearing is enabled
136                                                                                 CLOTH_SIMSETTINGS_FLAG_CCACHE_PROTECT = ( 1 << 5 ), // true if tearing is enabled
137                                                                                 CLOTH_SIMSETTINGS_FLAG_EDITMODE = ( 1 << 6 ), // are we in editmode? -several things disabled
138                                                                                 CLOTH_SIMSETTINGS_FLAG_CCACHE_FFREE = (1 << 7), /* force cache freeing */
139                                                                                 CLOTH_SIMSETTINGS_FLAG_SCALING = (1 << 8), /* is advanced scaling active? */
140                                                                                 CLOTH_SIMSETTINGS_FLAG_LOADED = (1 << 9), /* did we just got load? */
141 } CLOTH_SIMSETTINGS_FLAGS;
142
143 /* COLLISION FLAGS */
144 typedef enum
145 {
146         CLOTH_COLLSETTINGS_FLAG_ENABLED = ( 1 << 1 ), /* enables cloth - object collisions */
147                                             CLOTH_COLLSETTINGS_FLAG_SELF = ( 1 << 2 ), /* unused */
148 } CLOTH_COLLISIONSETTINGS_FLAGS;
149
150 /* Spring types as defined in the paper.*/
151 typedef enum
152 {
153         CLOTH_SPRING_TYPE_STRUCTURAL = 0,
154  CLOTH_SPRING_TYPE_SHEAR,
155  CLOTH_SPRING_TYPE_BENDING,
156 } CLOTH_SPRING_TYPES;
157
158 /* SPRING FLAGS */
159 typedef enum
160 {
161         CLOTH_SPRING_FLAG_DEACTIVATE = ( 1 << 1 ),
162                                          CLOTH_SPRING_FLAG_NEEDED = ( 1 << 2 ), // springs has values to be applied
163 } CLOTH_SPRINGS_FLAGS;
164
165 /* Bits to or into the ClothVertex.flags. */
166 #define CLOTH_VERT_FLAG_PINNED 1
167 #define CLOTH_VERT_FLAG_COLLISION 2
168
169 typedef void ( *CM_COLLISION_RESPONSE ) ( ClothModifierData *clmd, CollisionModifierData *collmd, CollisionTree *tree1, CollisionTree *tree2 );
170
171
172 /////////////////////////////////////////////////
173 // collision.c
174 ////////////////////////////////////////////////
175
176 // needed for implicit.c
177 void bvh_collision_response ( ClothModifierData *clmd, ClothModifierData *coll_clmd, CollisionTree * tree1, CollisionTree * tree2 );
178 int cloth_bvh_objcollision ( ClothModifierData * clmd, float step, float dt );
179
180 int bvh_traverse ( ClothModifierData * clmd, CollisionModifierData * collmd, CollisionTree * tree1, CollisionTree * tree2, float step, CM_COLLISION_RESPONSE collision_response );
181 ////////////////////////////////////////////////
182
183
184 ////////////////////////////////////////////////
185 // implicit.c
186 ////////////////////////////////////////////////
187                 
188 // needed for cloth.c
189 int implicit_init ( Object *ob, ClothModifierData *clmd );
190 int implicit_free ( ClothModifierData *clmd );
191 int implicit_solver ( Object *ob, float frame, ClothModifierData *clmd, ListBase *effectors );
192 void implicit_set_positions ( ClothModifierData *clmd );
193 ////////////////////////////////////////////////
194
195
196 /////////////////////////////////////////////////
197 // cloth.c
198 ////////////////////////////////////////////////
199
200 // needed for modifier.c
201 void cloth_free_modifier_extern (ClothModifierData *clmd);
202 void cloth_free_modifier (Object *ob, ClothModifierData *clmd);
203 void cloth_init (ClothModifierData *clmd);
204 DerivedMesh *clothModifier_do(ClothModifierData *clmd,Object *ob, DerivedMesh *dm, int useRenderParams, int isFinalCalc);
205
206 void cloth_update_normals (ClothVertex *verts, int nVerts, MFace *face, int totface);
207
208 // needed for collision.c
209 void bvh_update_from_cloth(ClothModifierData *clmd, int moving);
210
211 // needed for editmesh.c
212 void cloth_write_cache(Object *ob, ClothModifierData *clmd, float framenr);
213 int cloth_read_cache(Object *ob, ClothModifierData *clmd, float framenr);
214
215 // needed for button_object.c
216 void cloth_clear_cache(Object *ob, ClothModifierData *clmd, float framenr);
217
218 ////////////////////////////////////////////////
219
220
221 /* Typedefs for function pointers we need for solvers and collision detection. */
222 typedef void ( *CM_COLLISION_SELF ) ( ClothModifierData *clmd, int step );
223 typedef void ( *CM_COLLISION_OBJ ) ( ClothModifierData *clmd, int step, CM_COLLISION_RESPONSE collision_response );
224
225
226 /* This enum provides the IDs for our solvers. */
227 // only one available in the moment
228 typedef enum {
229         CM_IMPLICIT = 0,
230 } CM_SOLVER_ID;
231
232
233 /* This structure defines how to call the solver.
234 */
235 typedef struct
236 {
237         char            *name;
238         CM_SOLVER_ID    id;
239         int     ( *init ) ( Object *ob, ClothModifierData *clmd );
240         int     ( *solver ) ( Object *ob, float framenr, ClothModifierData *clmd, ListBase *effectors );
241         int     ( *free ) ( ClothModifierData *clmd );
242 }
243 CM_SOLVER_DEF;
244
245 /* used for caching in implicit.c */
246 typedef struct Frame
247 {
248         ClothVertex *verts;
249         ClothSpring *springs;
250         unsigned int numverts, numsprings;
251         float time; /* we need float since we want to support sub-frames */
252 }
253 Frame;
254
255 #endif
256