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