New: Collision detection for inter-timestep-collisions for triangle-point contacts...
[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 /* Bits to or into the ClothVertex.flags. */
67 #define CVERT_FLAG_PINNED       1
68 #define CVERT_FLAG_COLLISION    2
69
70
71 // some macro enhancements for vector treatment
72 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
73 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
74 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
75 #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;}
76 #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;}
77 #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;}
78 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
79 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
80 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
81 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
82 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
83 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
84
85 /* SIMULATION FLAGS: goal flags,.. */
86 /* These are the bits used in SimSettings.flags. */
87 typedef enum 
88 {
89         CSIMSETT_FLAG_RESET = (1 << 1),         // The CM object requires a reinitializaiton.
90                         CSIMSETT_FLAG_COLLOBJ = (1 << 2),       // object is only collision object, no cloth simulation is done
91                         CSIMSETT_FLAG_GOAL = (1 << 3),          // we have goals enabled
92                         CSIMSETT_FLAG_TEARING_ENABLED = (1 << 4), // true if tearing is enabled
93                         CSIMSETT_FLAG_CCACHE_PROTECT = (1 << 5), // true if tearing is enabled
94 } CSIMSETT_FLAGS;
95
96 /* Spring types as defined in the paper.*/
97 typedef enum 
98 {
99         STRUCTURAL = 0,
100  SHEAR,
101  BENDING,
102 } springType;
103
104 /* SPRING FLAGS */
105 typedef enum 
106 {
107         CSPRING_FLAG_DEACTIVATE = (1 << 1),
108         CSPRING_FLAG_NEEDED = (1 << 2), // springs has values to be applied
109 } CSPRINGS_FLAGS;
110
111 // needed for buttons_object.c
112 void cloth_cache_free(ClothModifierData *clmd, float time);
113 void cloth_free_modifier (ClothModifierData *clmd);
114
115 // needed for cloth.c
116 void implicit_set_positions (ClothModifierData *clmd);
117
118 // from cloth.c, needed for modifier.c
119 void clothModifier_do(ClothModifierData *clmd, Object *ob, DerivedMesh *dm, float (*vertexCos)[3], int numverts);
120
121 // used in collision.c
122 typedef struct Tree {
123         struct Tree *nodes[4]; // 4 children --> quad-tree
124         struct Tree *parent;
125         struct Tree *nextLeaf; 
126         struct Tree *prevLeaf;
127         float   bv[26]; // Bounding volume of all nodes / we have 7 axes on a 14-DOP
128         unsigned int tri_index; // this saves the index of the face
129         int     count_nodes; // how many nodes are used
130         int     traversed;  // how many nodes already traversed until this level?
131         int     isleaf;
132 } Tree;
133
134 typedef struct Tree TreeNode;
135
136 typedef struct BVH{ 
137         unsigned int    numfaces;
138         unsigned int    numverts;
139         ClothVertex     *verts; // just a pointer to the original datastructure
140         MFace           *mfaces; // just a pointer to the original datastructure
141         struct LinkNode *tree;
142         TreeNode        *root; // TODO: saving the root --> is this really needed? YES!
143         TreeNode        *leaf_tree; /* Tail of the leaf linked list.    */
144         TreeNode        *leaf_root;     /* Head of the leaf linked list.        */
145         float           epsilon; /* epslion is used for inflation of the k-dop     */
146         int             flags; /* bvhFlags */              
147 } BVH;
148
149 typedef void (*CM_COLLISION_RESPONSE) (ClothModifierData *clmd, ClothModifierData *coll_clmd, Tree * tree1, Tree * tree2);
150
151
152 /////////////////////////////////////////////////
153 // collision.c
154 ////////////////////////////////////////////////
155
156 // needed for implicit.c
157 void bvh_collision_response(ClothModifierData *clmd, ClothModifierData *coll_clmd, Tree * tree1, Tree * tree2);
158 int cloth_bvh_objcollision(ClothModifierData * clmd, float step, float dt);
159
160 ////////////////////////////////////////////////
161
162
163 /////////////////////////////////////////////////
164 // kdop.c
165 ////////////////////////////////////////////////
166
167 // needed for cloth.c
168 void bvh_free(BVH * bvh);
169 BVH *bvh_build (ClothModifierData *clmd, float epsilon);
170
171 // needed for collision.c
172 int bvh_traverse(ClothModifierData * clmd, ClothModifierData * coll_clmd, Tree * tree1, Tree * tree2, float step, CM_COLLISION_RESPONSE collision_response);
173 void bvh_update(ClothModifierData * clmd, BVH * bvh, int moving);
174
175 ////////////////////////////////////////////////
176
177
178
179 /////////////////////////////////////////////////
180 // cloth.c
181 ////////////////////////////////////////////////
182 void cloth_free_modifier (ClothModifierData *clmd);
183 void cloth_init (ClothModifierData *clmd);
184 void cloth_deform_verts(struct Object *ob, float framenr, float (*vertexCos)[3], int numVerts, void *derivedData, ClothModifierData *clmd);
185 void cloth_update_normals (ClothVertex *verts, int nVerts, MFace *face, int totface);
186
187 ////////////////////////////////////////////////
188
189
190 /* Typedefs for function pointers we need for solvers and collision detection. */
191 typedef void (*CM_COLLISION_SELF) (ClothModifierData *clmd, int step);
192 typedef void (*CM_COLLISION_OBJ) (ClothModifierData *clmd, int step, CM_COLLISION_RESPONSE collision_response);
193
194
195 /* This enum provides the IDs for our solvers. */
196 // only one available in the moment
197 typedef enum {
198         CM_IMPLICIT = 0,
199 } CM_SOLVER_ID;
200
201
202 /* This structure defines how to call the solver.
203 */
204 typedef struct {
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 } 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 /* used for caching in implicit.c */
219 typedef struct Frame
220 {
221         ClothVertex *verts;
222         ClothSpring *springs;
223         unsigned int numverts, numsprings;
224         float time; /* we need float since we want to support sub-frames */
225 } Frame;
226
227 /* used for collisions in collision.c */
228 typedef struct CollPair
229 {
230         unsigned int face1; // cloth face
231         unsigned int face2; // object face
232         double distance; // magnitude of vector
233         float normal[3]; 
234         float vector[3]; // unnormalized collision vector: p2-p1
235         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
236         int lastsign; // indicates if the distance sign has changed, unused itm
237         float time; // collision time, from 0 up to 1
238         unsigned int ap1, ap2, ap3, bp1, bp2, bp3, bp4;
239         unsigned int pointsb[4];
240 } CollPair;
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 } EdgeCollPair;
252
253 /* used for collisions in collision.c */
254 typedef struct FaceCollPair
255 {
256         unsigned int p11, p12, p13, p21;
257         float normal[3];
258         float vector[3];
259         float time;
260         int lastsign;
261         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
262 } FaceCollPair;
263
264 #endif
265