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