svn merge -r 12208:12294 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_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 #ifndef _WIN32
50 #define LINUX
51 #define DO_INLINE inline
52 #else
53 #define DO_INLINE
54 #endif
55
56 #define CLOTH_MAX_THREAD 2
57
58
59 /* goal defines */
60 #define SOFTGOALSNAP  0.999f
61
62 /* This is approximately the smallest number that can be
63 * represented by a float, given its precision. */
64 #define ALMOST_ZERO             0.000001
65
66 // some macro enhancements for vector treatment
67 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
68 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
69 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
70 #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;}
71 #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;}
72 #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;}
73 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
74 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
75 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
76 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
77 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
78 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
79
80 /* SIMULATION FLAGS: goal flags,.. */
81 /* These are the bits used in SimSettings.flags. */
82 typedef enum
83 {
84     CLOTH_SIMSETTINGS_FLAG_RESET = ( 1 << 1 ),          // The CM object requires a reinitializaiton.
85     CLOTH_SIMSETTINGS_FLAG_COLLOBJ = ( 1 << 2 ),        // object is only collision object, no cloth simulation is done
86     CLOTH_SIMSETTINGS_FLAG_GOAL = ( 1 << 3 ),           // we have goals enabled
87     CLOTH_SIMSETTINGS_FLAG_TEARING = ( 1 << 4 ), // true if tearing is enabled
88     CLOTH_SIMSETTINGS_FLAG_CCACHE_PROTECT = ( 1 << 5 ), // true if tearing is enabled
89 } CLOTH_SIMSETTINGS_FLAGS;
90
91 /* SPRING FLAGS */
92 typedef enum
93 {
94     CLOTH_COLLISIONSETTINGS_FLAG_ENABLED = ( 1 << 1 ),
95 } CLOTH_COLLISIONSETTINGS_FLAGS;
96
97 /* Spring types as defined in the paper.*/
98 typedef enum
99 {
100     CLOTH_SPRING_TYPE_STRUCTURAL = 0,
101     CLOTH_SPRING_TYPE_SHEAR,
102     CLOTH_SPRING_TYPE_BENDING,
103 } CLOTH_SPRING_TYPES;
104
105 /* SPRING FLAGS */
106 typedef enum
107 {
108     CLOTH_SPRING_FLAG_DEACTIVATE = ( 1 << 1 ),
109     CLOTH_SPRING_FLAG_NEEDED = ( 1 << 2 ), // springs has values to be applied
110 } CLOTH_SPRINGS_FLAGS;
111
112 /* Bits to or into the ClothVertex.flags. */
113 #define CVERT_FLAG_PINNED       1
114 #define CVERT_FLAG_COLLISION    2
115
116
117 // needed for buttons_object.c
118 void cloth_cache_free ( ClothModifierData *clmd, float time );
119 void cloth_free_modifier ( ClothModifierData *clmd );
120
121 // needed for cloth.c
122 void implicit_set_positions ( ClothModifierData *clmd );
123
124 // from cloth.c, needed for modifier.c
125 void clothModifier_do ( ClothModifierData *clmd, Object *ob, DerivedMesh *dm, float ( *vertexCos ) [3], int numverts );
126
127 // used in collision.c
128 typedef struct Tree
129 {
130         struct Tree *nodes[4]; // 4 children --> quad-tree
131         struct Tree *parent;
132         struct Tree *nextLeaf;
133         struct Tree *prevLeaf;
134         float   bv[26]; // Bounding volume of all nodes / we have 7 axes on a 14-DOP
135         unsigned int tri_index; // this saves the index of the face
136         int     count_nodes; // how many nodes are used
137         int     traversed;  // how many nodes already traversed until this level?
138         int     isleaf;
139 }
140 Tree;
141
142 typedef struct Tree TreeNode;
143
144 typedef struct BVH
145 {
146         unsigned int    numfaces;
147         unsigned int    numverts;
148         ClothVertex     *verts; // just a pointer to the original datastructure
149         MFace           *mfaces; // just a pointer to the original datastructure
150         struct LinkNode *tree;
151         TreeNode        *root; // TODO: saving the root --> is this really needed? YES!
152         TreeNode        *leaf_tree; /* Tail of the leaf linked list.    */
153         TreeNode        *leaf_root;     /* Head of the leaf linked list.        */
154         float           epsilon; /* epslion is used for inflation of the k-dop     */
155         int             flags; /* bvhFlags */
156 }
157 BVH;
158
159 typedef void ( *CM_COLLISION_RESPONSE ) ( ClothModifierData *clmd, ClothModifierData *coll_clmd, Tree * tree1, Tree * tree2 );
160
161
162 /////////////////////////////////////////////////
163 // collision.c
164 ////////////////////////////////////////////////
165
166 // needed for implicit.c
167 void bvh_collision_response ( ClothModifierData *clmd, ClothModifierData *coll_clmd, Tree * tree1, Tree * tree2 );
168 int cloth_bvh_objcollision ( ClothModifierData * clmd, float step, float dt );
169
170 ////////////////////////////////////////////////
171
172
173 /////////////////////////////////////////////////
174 // kdop.c
175 ////////////////////////////////////////////////
176
177 // needed for cloth.c
178 void bvh_free ( BVH * bvh );
179 BVH *bvh_build ( ClothModifierData *clmd, float epsilon );
180 LinkNode *BLI_linklist_append_fast ( LinkNode **listp, void *ptr );
181
182 // needed for collision.c
183 int bvh_traverse ( ClothModifierData * clmd, ClothModifierData * coll_clmd, Tree * tree1, Tree * tree2, float step, CM_COLLISION_RESPONSE collision_response );
184 void bvh_update ( ClothModifierData * clmd, BVH * bvh, int moving );
185
186 ////////////////////////////////////////////////
187
188
189
190 /////////////////////////////////////////////////
191 // cloth.c
192 ////////////////////////////////////////////////
193 void cloth_free_modifier ( ClothModifierData *clmd );
194 void cloth_init ( ClothModifierData *clmd );
195 void cloth_deform_verts ( struct Object *ob, float framenr, float ( *vertexCos ) [3], int numVerts, void *derivedData, ClothModifierData *clmd );
196 void cloth_update_normals ( ClothVertex *verts, int nVerts, MFace *face, int totface );
197
198 ////////////////////////////////////////////////
199
200
201 /* Typedefs for function pointers we need for solvers and collision detection. */
202 typedef void ( *CM_COLLISION_SELF ) ( ClothModifierData *clmd, int step );
203 typedef void ( *CM_COLLISION_OBJ ) ( ClothModifierData *clmd, int step, CM_COLLISION_RESPONSE collision_response );
204
205
206 /* This enum provides the IDs for our solvers. */
207 // only one available in the moment
208 typedef enum {
209     CM_IMPLICIT = 0,
210 } CM_SOLVER_ID;
211
212
213 /* This structure defines how to call the solver.
214 */
215 typedef struct
216 {
217         char            *name;
218         CM_SOLVER_ID    id;
219         int     ( *init ) ( Object *ob, ClothModifierData *clmd );
220         int     ( *solver ) ( Object *ob, float framenr, ClothModifierData *clmd, ListBase *effectors );
221         int     ( *free ) ( ClothModifierData *clmd );
222 }
223 CM_SOLVER_DEF;
224
225
226 /* new C implicit simulator */
227 int implicit_init ( Object *ob, ClothModifierData *clmd );
228 int implicit_free ( ClothModifierData *clmd );
229 int implicit_solver ( Object *ob, float frame, ClothModifierData *clmd, ListBase *effectors );
230
231 /* used for caching in implicit.c */
232 typedef struct Frame
233 {
234         ClothVertex *verts;
235         ClothSpring *springs;
236         unsigned int numverts, numsprings;
237         float time; /* we need float since we want to support sub-frames */
238 }
239 Frame;
240
241 /* used for collisions in collision.c */
242 typedef struct CollPair
243 {
244         unsigned int face1; // cloth face
245         unsigned int face2; // object face
246         double distance; // magnitude of vector
247         float normal[3];
248         float vector[3]; // unnormalized collision vector: p2-p1
249         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
250         int lastsign; // indicates if the distance sign has changed, unused itm
251         float time; // collision time, from 0 up to 1
252         unsigned int ap1, ap2, ap3, bp1, bp2, bp3, bp4;
253         unsigned int pointsb[4];
254 }
255 CollPair;
256
257 /* used for collisions in collision.c */
258 typedef struct EdgeCollPair
259 {
260         unsigned int p11, p12, p21, p22;
261         float normal[3];
262         float vector[3];
263         float time;
264         int lastsign;
265         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
266 }
267 EdgeCollPair;
268
269 /* used for collisions in collision.c */
270 typedef struct FaceCollPair
271 {
272         unsigned int p11, p12, p13, p21;
273         float normal[3];
274         float vector[3];
275         float time;
276         int lastsign;
277         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
278 }
279 FaceCollPair;
280
281 #endif
282