arround 50% speedup in calculating spring force using OpenMP
[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 "BKE_DerivedMesh.h"
38 #include "DNA_customdata_types.h"
39 #include "BKE_customdata.h"
40 #include "DNA_meshdata_types.h"
41
42 struct Object;
43 struct Cloth;
44 struct MFace;
45 struct DerivedMesh;
46
47 // this is needed for inlining behaviour
48 #ifndef _WIN32
49         #define LINUX 
50         #define DO_INLINE inline
51 #else
52         #define DO_INLINE
53 #endif
54
55 #define CLOTH_MAX_THREAD 2
56
57
58 /* goal defines */
59 #define SOFTGOALSNAP  0.999f 
60
61 /* This is approximately the smallest number that can be
62 * represented by a float, given its precision. */
63 #define ALMOST_ZERO             0.0000001
64
65 /* Bits to or into the ClothVertex.flags. */
66 #define CVERT_FLAG_PINNED       1
67 #define CVERT_FLAG_COLLISION    2
68
69
70 // some macro enhancements for vector treatment
71 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
72 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
73 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
74 #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;}
75 #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;}
76 #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;}
77 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
78 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
79 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
80 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
81 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
82 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
83
84 /* SIMULATION FLAGS: goal flags,.. */
85 /* These are the bits used in SimSettings.flags. */
86 typedef enum 
87 {
88         CSIMSETT_FLAG_RESET = (1 << 1),         // The CM object requires a reinitializaiton.
89         CSIMSETT_FLAG_COLLOBJ = (1 << 2),       // object is only collision object, no cloth simulation is done
90         CSIMSETT_FLAG_GOAL = (1 << 3),          // we have goals enabled
91         CSIMSETT_FLAG_CCACHE_FREE_ALL = (1 << 4),  // delete all from cache
92         CSIMSETT_FLAG_CCACHE_FREE_PART = (1 << 5), // delete some part of cache
93         CSIMSETT_FLAG_TEARING_ENABLED = (1 << 6), // 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, CM_COLLISION_RESPONSE collision_response, float dt);
159
160 ////////////////////////////////////////////////
161
162
163 /////////////////////////////////////////////////
164 // kdop.c
165 ////////////////////////////////////////////////
166
167 // needed for implicit.c
168 void bvh_update_static(ClothModifierData * clmd, BVH * bvh);
169 void bvh_update_moving(ClothModifierData * clmd, BVH * bvh);
170
171 // needed for cloth.c
172 void bvh_free(BVH * bvh);
173 BVH *bvh_build (ClothModifierData *clmd, float epsilon);
174
175 // needed for collision.c
176 int bvh_traverse(ClothModifierData * clmd, ClothModifierData * coll_clmd, Tree * tree1, Tree * tree2, float step, CM_COLLISION_RESPONSE collision_response);
177
178 ////////////////////////////////////////////////
179
180
181
182 /////////////////////////////////////////////////
183 // cloth.c
184 ////////////////////////////////////////////////
185 void cloth_free_modifier (ClothModifierData *clmd);
186 void cloth_init (ClothModifierData *clmd);
187 void cloth_deform_verts(struct Object *ob, float framenr, float (*vertexCos)[3], int numVerts, void *derivedData, ClothModifierData *clmd);
188 void cloth_update_normals (ClothVertex *verts, int nVerts, MFace *face, int totface);
189
190 ////////////////////////////////////////////////
191
192
193 /* Typedefs for function pointers we need for solvers and collision detection. */
194 typedef void (*CM_COLLISION_SELF) (ClothModifierData *clmd, int step);
195 typedef void (*CM_COLLISION_OBJ) (ClothModifierData *clmd, int step, CM_COLLISION_RESPONSE collision_response);
196
197
198 /* This enum provides the IDs for our solvers. */
199 // only one available in the moment
200 typedef enum {
201         CM_IMPLICIT = 0,
202 } CM_SOLVER_ID;
203
204
205 /* This structure defines how to call the solver.
206 */
207 typedef struct {
208         char            *name;
209         CM_SOLVER_ID    id;
210         int             (*init) (Object *ob, ClothModifierData *clmd);
211         int             (*solver) (Object *ob, float framenr, ClothModifierData *clmd, ListBase *effectors,
212         CM_COLLISION_SELF self_collision, CM_COLLISION_OBJ obj_collision);
213         int             (*free) (ClothModifierData *clmd);
214 } CM_SOLVER_DEF;
215
216
217 /* new C implicit simulator */
218 int implicit_init (Object *ob, ClothModifierData *clmd);
219 int implicit_free (ClothModifierData *clmd);
220 int implicit_solver (Object *ob, float frame, ClothModifierData *clmd, ListBase *effectors,
221                                                 CM_COLLISION_SELF self_collision, CM_COLLISION_OBJ obj_collision);
222
223 /* used for caching in implicit.c */
224 typedef struct Frame
225 {
226         ClothVertex *verts;
227         ClothSpring *springs;
228         float time; /* we need float since we want to support sub-frames */
229 } Frame;
230
231 /* used for collisions in collision.c */
232 typedef struct CollPair
233 {
234         unsigned int face1; // cloth face
235         unsigned int face2; // object face
236         double distance; // magnitude of vector
237         float normal[3]; 
238         float vector[3]; // unnormalized collision vector: p2-p1
239         float p1[3], p2[3]; // collision point p1 on face1, p2 on face2
240         int lastsign; // indicates if the distance sign has changed, unused itm
241         float time; // collision time, from 0 up to 1
242         int quadA, quadB; // indicates the used triangle of the quad: 0 means verts 1,2,3; 1 means verts 4,1,3
243 } CollPair;
244
245
246 #endif
247