Commit of fluid fix for 32/64bit and max 2.5gb ram issue
[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_DerivedMesh.h"
39 #include "DNA_customdata_types.h"
40 #include "BKE_customdata.h"
41 #include "DNA_meshdata_types.h"
42
43 struct Object;
44 struct Cloth;
45 struct MFace;
46 struct DerivedMesh;
47
48 // this is needed for inlining behaviour
49
50 #ifndef _WIN32
51 #define LINUX
52 #define DO_INLINE inline
53 #else
54 #define DO_INLINE
55 #endif
56
57 #define CLOTH_MAX_THREAD 2
58
59
60 typedef struct ClothVertex {
61         int     flags;          /* General flags per vertex.            */
62         float   mass;           /* mass / weight of the vertex          */
63         float   goal;           /* goal, from SB                        */
64         float   impulse[3];     /* used in collision.c */
65         unsigned int impulse_count; /* same as above */
66         float collball;
67 } ClothVertex;
68
69 typedef struct ClothSpring {
70         int     ij;             /* Pij from the paper, one end of the spring.   */
71         int     kl;             /* Pkl from the paper, one end of the spring.   */
72         float   restlen;        /* The original length of the spring.   */
73         int     matrix_index;   /* needed for implicit solver (fast lookup) */
74         int     type;           /* types defined in BKE_cloth.h ("springType") */
75         int     flags;          /* defined in BKE_cloth.h, e.g. deactivated due to tearing */
76         float dfdx[3][3];
77         float dfdv[3][3];
78         float f[3];
79 } ClothSpring;
80
81 typedef struct Cloth {
82         struct ClothVertex      *verts;                 /* The vertices that represent this cloth. */
83         struct LinkNode         *springs;               /* The springs connecting the mesh. */
84         struct BVH              *tree;          /* collision tree for this cloth object */
85         struct BVH              *selftree;              /* self collision tree for this cloth object */
86         struct MFace            *mfaces;
87         struct Implicit_Data    *implicit;      /* our implicit solver connects to this pointer */
88         struct EdgeHash         *edgehash; /* used for fast checking adjacent points */
89         unsigned int            numverts;               /* The number of verts == m * n. */
90         unsigned int            numsprings;             /* The count of springs. */
91         unsigned int            numfaces;
92         unsigned int            numothersprings;
93         unsigned int            numspringssave;
94         unsigned int            old_solver_type;
95         float                   (*x)[3]; /* The current position of all vertices.*/
96         float                   (*xold)[3]; /* The previous position of all vertices.*/
97         float                   (*current_x)[3]; /* The TEMPORARY current position of all vertices.*/
98         float                   (*current_xold)[3]; /* The TEMPORARY previous position of all vertices.*/
99         float                   (*v)[4]; /* the current velocity of all vertices */
100         float                   (*current_v)[3];
101         float                   (*xconst)[3];
102 } Cloth;
103
104 /* goal defines */
105 #define SOFTGOALSNAP  0.999f
106
107 /* This is approximately the smallest number that can be
108 * represented by a float, given its precision. */
109 #define ALMOST_ZERO             0.000001
110
111 // some macro enhancements for vector treatment
112 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
113 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
114 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
115 #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;}
116 #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;}
117 #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;}
118 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
119 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
120 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
121 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
122 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
123 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
124
125 /* SIMULATION FLAGS: goal flags,.. */
126 /* These are the bits used in SimSettings.flags. */
127 typedef enum
128 {
129     CLOTH_SIMSETTINGS_FLAG_RESET = ( 1 << 1 ),          // The CM object requires a reinitializaiton.
130     CLOTH_SIMSETTINGS_FLAG_COLLOBJ = ( 1 << 2 ),        // object is only collision object, no cloth simulation is done
131     CLOTH_SIMSETTINGS_FLAG_GOAL = ( 1 << 3 ),           // we have goals enabled
132     CLOTH_SIMSETTINGS_FLAG_TEARING = ( 1 << 4 ), // true if tearing is enabled
133     CLOTH_SIMSETTINGS_FLAG_CCACHE_PROTECT = ( 1 << 5 ),
134     CLOTH_SIMSETTINGS_FLAG_BIG_FORCE = ( 1 << 6 ), // true if we have big spring force for bending
135     CLOTH_SIMSETTINGS_FLAG_SLEEP = ( 1 << 7 ), // true if we let the cloth go to sleep
136 } CLOTH_SIMSETTINGS_FLAGS;
137
138 /* SPRING FLAGS */
139 typedef enum
140 {
141     CLOTH_COLLISIONSETTINGS_FLAG_ENABLED = ( 1 << 1 ),
142 } CLOTH_COLLISIONSETTINGS_FLAGS;
143
144 /* Spring types as defined in the paper.*/
145 typedef enum
146 {
147     CLOTH_SPRING_TYPE_STRUCTURAL = 0,
148     CLOTH_SPRING_TYPE_SHEAR,
149     CLOTH_SPRING_TYPE_BENDING,
150 } CLOTH_SPRING_TYPES;
151
152 /* SPRING FLAGS */
153 typedef enum
154 {
155     CLOTH_SPRING_FLAG_DEACTIVATE = ( 1 << 1 ),
156     CLOTH_SPRING_FLAG_NEEDED = ( 1 << 2 ), // springs has values to be applied
157 } CLOTH_SPRINGS_FLAGS;
158
159 /* Bits to or into the ClothVertex.flags. */
160 #define CVERT_FLAG_PINNED       1
161 #define CVERT_FLAG_COLLISION    2
162
163
164 // needed for buttons_object.c
165 void cloth_clear_cache(Object *ob, ClothModifierData *clmd, float framenr);
166 void cloth_free_modifier ( ClothModifierData *clmd );
167
168 // needed for cloth.c
169 void implicit_set_positions ( ClothModifierData *clmd );
170
171 // from cloth.c, needed for modifier.c
172 DerivedMesh *clothModifier_do(ClothModifierData *clmd,Object *ob, DerivedMesh *dm, int useRenderParams, int isFinalCalc);
173
174 // needed in implicit.c
175 int cloth_bvh_objcollision(ClothModifierData * clmd, float step, float prevstep, float dt);
176
177 ////////////////////////////////////////////////
178
179
180 /////////////////////////////////////////////////
181 // cloth.c
182 ////////////////////////////////////////////////
183 void cloth_free_modifier ( ClothModifierData *clmd );
184 void cloth_init ( ClothModifierData *clmd );
185 ////////////////////////////////////////////////
186
187
188 /* Typedefs for function pointers we need for solvers and collision detection. */
189 typedef void ( *CM_COLLISION_SELF ) ( ClothModifierData *clmd, int step );
190 // typedef void ( *CM_COLLISION_OBJ ) ( ClothModifierData *clmd, int step, CM_COLLISION_RESPONSE collision_response );
191
192
193 /* This enum provides the IDs for our solvers. */
194 // only one available in the moment
195 typedef enum {
196     CM_IMPLICIT = 0,
197     CM_VERLET = 1,
198 } CM_SOLVER_ID;
199
200
201 /* This structure defines how to call the solver.
202 */
203 typedef struct
204 {
205         char            *name;
206         CM_SOLVER_ID    id;
207         int     ( *init ) ( Object *ob, ClothModifierData *clmd );
208         int     ( *solver ) ( Object *ob, float framenr, ClothModifierData *clmd, ListBase *effectors );
209         int     ( *free ) ( ClothModifierData *clmd );
210 }
211 CM_SOLVER_DEF;
212
213
214 /* new C implicit simulator */
215 int implicit_init ( Object *ob, ClothModifierData *clmd );
216 int implicit_free ( ClothModifierData *clmd );
217 int implicit_solver ( Object *ob, float frame, ClothModifierData *clmd, ListBase *effectors );
218
219 /* explicit verlet simulator */
220 int verlet_init ( Object *ob, ClothModifierData *clmd );
221 int verlet_free ( ClothModifierData *clmd );
222 int verlet_solver ( Object *ob, float frame, ClothModifierData *clmd, ListBase *effectors );
223
224
225 /* used for collisions in collision.c */
226 /*
227 typedef struct CollPair
228 {
229         unsigned int face1; // cloth face
230         unsigned int face2; // object face
231         double distance; // magnitude of vector
232         float normal[3];
233         float vector[3]; // unnormalized collision vector: p2-p1
234         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
235         int lastsign; // indicates if the distance sign has changed, unused itm
236         float time; // collision time, from 0 up to 1
237         unsigned int ap1, ap2, ap3, bp1, bp2, bp3, bp4;
238         unsigned int pointsb[4];
239 }
240 CollPair;
241 */
242
243 /* used for collisions in collision.c */
244 typedef struct EdgeCollPair
245 {
246         unsigned int p11, p12, p21, p22;
247         float normal[3];
248         float vector[3];
249         float time;
250         int lastsign;
251         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
252 }
253 EdgeCollPair;
254
255 /* used for collisions in collision.c */
256 typedef struct FaceCollPair
257 {
258         unsigned int p11, p12, p13, p21;
259         float normal[3];
260         float vector[3];
261         float time;
262         int lastsign;
263         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
264 }
265 FaceCollPair;
266
267 // function definitions from implicit.c
268 DO_INLINE void mul_fvector_S(float to[3], float from[3], float scalar);
269
270 #endif
271