Disabled Cloth collision detection because of almost complete rewrite/seperation...
[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 ////////////////////////////////////////////////
128
129
130 /////////////////////////////////////////////////
131 // cloth.c
132 ////////////////////////////////////////////////
133 void cloth_free_modifier ( ClothModifierData *clmd );
134 void cloth_init ( ClothModifierData *clmd );
135 void cloth_deform_verts ( struct Object *ob, float framenr, float ( *vertexCos ) [3], int numVerts, void *derivedData, ClothModifierData *clmd );
136 void cloth_update_normals ( ClothVertex *verts, int nVerts, MFace *face, int totface );
137
138 ////////////////////////////////////////////////
139
140
141 /* Typedefs for function pointers we need for solvers and collision detection. */
142 typedef void ( *CM_COLLISION_SELF ) ( ClothModifierData *clmd, int step );
143 // typedef void ( *CM_COLLISION_OBJ ) ( ClothModifierData *clmd, int step, CM_COLLISION_RESPONSE collision_response );
144
145
146 /* This enum provides the IDs for our solvers. */
147 // only one available in the moment
148 typedef enum {
149     CM_IMPLICIT = 0,
150 } CM_SOLVER_ID;
151
152
153 /* This structure defines how to call the solver.
154 */
155 typedef struct
156 {
157         char            *name;
158         CM_SOLVER_ID    id;
159         int     ( *init ) ( Object *ob, ClothModifierData *clmd );
160         int     ( *solver ) ( Object *ob, float framenr, ClothModifierData *clmd, ListBase *effectors );
161         int     ( *free ) ( ClothModifierData *clmd );
162 }
163 CM_SOLVER_DEF;
164
165
166 /* new C implicit simulator */
167 int implicit_init ( Object *ob, ClothModifierData *clmd );
168 int implicit_free ( ClothModifierData *clmd );
169 int implicit_solver ( Object *ob, float frame, ClothModifierData *clmd, ListBase *effectors );
170
171 /* used for caching in implicit.c */
172 typedef struct Frame
173 {
174         ClothVertex *verts;
175         ClothSpring *springs;
176         unsigned int numverts, numsprings;
177         float time; /* we need float since we want to support sub-frames */
178 }
179 Frame;
180
181 /* used for collisions in collision.c */
182 /*
183 typedef struct CollPair
184 {
185         unsigned int face1; // cloth face
186         unsigned int face2; // object face
187         double distance; // magnitude of vector
188         float normal[3];
189         float vector[3]; // unnormalized collision vector: p2-p1
190         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
191         int lastsign; // indicates if the distance sign has changed, unused itm
192         float time; // collision time, from 0 up to 1
193         unsigned int ap1, ap2, ap3, bp1, bp2, bp3, bp4;
194         unsigned int pointsb[4];
195 }
196 CollPair;
197 */
198
199 /* used for collisions in collision.c */
200 typedef struct EdgeCollPair
201 {
202         unsigned int p11, p12, p21, p22;
203         float normal[3];
204         float vector[3];
205         float time;
206         int lastsign;
207         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
208 }
209 EdgeCollPair;
210
211 /* used for collisions in collision.c */
212 typedef struct FaceCollPair
213 {
214         unsigned int p11, p12, p13, p21;
215         float normal[3];
216         float vector[3];
217         float time;
218         int lastsign;
219         float pa[3], pb[3]; // collision point p1 on face1, p2 on face2
220 }
221 FaceCollPair;
222
223 #endif
224