style cleanup
[blender.git] / source / blender / blenkernel / BKE_cloth.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Daniel Genrich
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_CLOTH_H__
28 #define __BKE_CLOTH_H__
29
30 /** \file BKE_cloth.h
31  *  \ingroup bke
32  *  \author Daniel Genrich
33  */
34
35 #include <float.h>
36 #include "BLI_math_inline.h"
37
38 struct Object;
39 struct ListBase;
40 struct Scene;
41 struct MFace;
42 struct DerivedMesh;
43 struct ClothModifierData;
44 struct CollisionTree;
45
46 #define DO_INLINE MALWAYS_INLINE
47
48 #define CLOTH_MAX_THREAD 2
49
50 /* goal defines */
51 #define SOFTGOALSNAP  0.999f
52
53 /* This is approximately the smallest number that can be
54  * represented by a float, given its precision. */
55 #define ALMOST_ZERO             FLT_EPSILON
56
57 /* Bits to or into the ClothVertex.flags. */
58 #define CLOTH_VERT_FLAG_PINNED 1
59 #define CLOTH_VERT_FLAG_NOSELFCOLL 2 /* vertex NOT used for self collisions */
60 #define CLOTH_VERT_FLAG_PINNED_EM 3
61
62 /**
63  * This structure describes a cloth object against which the
64  * simulation can run.
65  *
66  * The m and n members of this structure represent the assumed
67  * rectangular ordered grid for which the original paper is written.
68  * At some point they need to disappear and we need to determine out
69  * own connectivity of the mesh based on the actual edges in the mesh.
70  *
71  */
72 typedef struct Cloth {
73         struct ClothVertex      *verts;                 /* The vertices that represent this cloth. */
74         struct  LinkNode        *springs;               /* The springs connecting the mesh. */
75         unsigned int            numverts;               /* The number of verts == m * n. */
76         unsigned int            numsprings;             /* The count of springs. */
77         unsigned int            numfaces;
78         unsigned char           old_solver_type;        /* unused, only 1 solver here */
79         unsigned char           pad2;
80         short                   pad3;
81         struct BVHTree          *bvhtree;                       /* collision tree for this cloth object */
82         struct BVHTree          *bvhselftree;                   /* collision tree for this cloth object */
83         struct MFace            *mfaces;
84         struct Implicit_Data    *implicit;              /* our implicit solver connects to this pointer */
85         struct Implicit_Data    *implicitEM;            /* our implicit solver connects to this pointer */
86         struct EdgeHash         *edgehash;              /* used for selfcollisions */
87         int last_frame, pad4;
88 } Cloth;
89
90 /**
91  * The definition of a cloth vertex.
92  */
93 typedef struct ClothVertex {
94         int     flags;          /* General flags per vertex.            */
95         float   v[3];           /* The velocity of the point.           */
96         float   xconst[3];      /* constrained position                 */
97         float   x[3];           /* The current position of this vertex. */
98         float   xold[3];        /* The previous position of this vertex.*/
99         float   tx[3];          /* temporary position */
100         float   txold[3];       /* temporary old position */
101         float   tv[3];          /* temporary "velocity", mostly used as tv = tx-txold */
102         float   mass;           /* mass / weight of the vertex          */
103         float   goal;           /* goal, from SB                        */
104         float   impulse[3];     /* used in collision.c */
105         float   *xrest;         /* temporary valid for building springs */
106         unsigned int impulse_count; /* same as above */
107         float   avg_spring_len; /* average length of connected springs */
108         float   struct_stiff;
109         float   bend_stiff;
110         float   shear_stiff;
111         int     spring_count; /* how many springs attached? */
112 }
113 ClothVertex;
114
115 /**
116  * The definition of a spring.
117  */
118 typedef struct ClothSpring {
119         int     ij;             /* Pij from the paper, one end of the spring.   */
120         int     kl;             /* Pkl from the paper, one end of the spring.   */
121         float   restlen;        /* The original length of the spring.   */
122         int     matrix_index;   /* needed for implicit solver (fast lookup) */
123         int     type;           /* types defined in BKE_cloth.h ("springType") */
124         int     flags;          /* defined in BKE_cloth.h, e.g. deactivated due to tearing */
125         float dfdx[3][3];
126         float dfdv[3][3];
127         float f[3];
128         float   stiffness;      /* stiffness factor from the vertex groups */
129         float editrestlen;
130 }
131 ClothSpring;
132
133 // some macro enhancements for vector treatment
134 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
135 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
136 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
137 #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;}
138 #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;}
139 #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;}
140 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
141 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
142 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
143 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
144 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
145 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
146
147 /* SIMULATION FLAGS: goal flags,.. */
148 /* These are the bits used in SimSettings.flags. */
149 typedef enum {
150         CLOTH_SIMSETTINGS_FLAG_COLLOBJ = ( 1 << 2 ),// object is only collision object, no cloth simulation is done
151         CLOTH_SIMSETTINGS_FLAG_GOAL = ( 1 << 3 ),       // we have goals enabled
152         CLOTH_SIMSETTINGS_FLAG_TEARING = ( 1 << 4 ),// true if tearing is enabled
153         CLOTH_SIMSETTINGS_FLAG_SCALING = ( 1 << 8 ), /* is advanced scaling active? */
154         CLOTH_SIMSETTINGS_FLAG_CCACHE_EDIT = (1 << 12), /* edit cache in editmode */
155         CLOTH_SIMSETTINGS_FLAG_NO_SPRING_COMPRESS = (1 << 13) /* don't allow spring compression */
156 } CLOTH_SIMSETTINGS_FLAGS;
157
158 /* COLLISION FLAGS */
159 typedef enum {
160         CLOTH_COLLSETTINGS_FLAG_ENABLED = ( 1 << 1 ), /* enables cloth - object collisions */
161         CLOTH_COLLSETTINGS_FLAG_SELF = ( 1 << 2 ), /* enables selfcollisions */
162 } CLOTH_COLLISIONSETTINGS_FLAGS;
163
164 /* Spring types as defined in the paper.*/
165 typedef enum {
166         CLOTH_SPRING_TYPE_STRUCTURAL  = (1 << 1),
167         CLOTH_SPRING_TYPE_SHEAR       = (1 << 2),
168         CLOTH_SPRING_TYPE_BENDING     = (1 << 3),
169         CLOTH_SPRING_TYPE_GOAL        = (1 << 4)
170 } CLOTH_SPRING_TYPES;
171
172 /* SPRING FLAGS */
173 typedef enum {
174         CLOTH_SPRING_FLAG_DEACTIVATE = ( 1 << 1 ),
175         CLOTH_SPRING_FLAG_NEEDED = ( 1 << 2 ), // springs has values to be applied
176 } CLOTH_SPRINGS_FLAGS;
177
178
179 /////////////////////////////////////////////////
180 // collision.c
181 ////////////////////////////////////////////////
182
183 // needed for implicit.c
184 int cloth_bvh_objcollision (struct Object *ob, struct ClothModifierData *clmd, float step, float dt );
185
186 ////////////////////////////////////////////////
187
188
189 ////////////////////////////////////////////////
190 // implicit.c
191 ////////////////////////////////////////////////
192
193 // needed for cloth.c
194 int implicit_init (struct Object *ob, struct ClothModifierData *clmd );
195 int implicit_free (struct ClothModifierData *clmd );
196 int implicit_solver (struct Object *ob, float frame, struct ClothModifierData *clmd, struct ListBase *effectors );
197 void implicit_set_positions (struct ClothModifierData *clmd );
198
199 /////////////////////////////////////////////////
200 // cloth.c
201 ////////////////////////////////////////////////
202
203 // needed for modifier.c
204 void cloth_free_modifier_extern (struct ClothModifierData *clmd );
205 void cloth_free_modifier (struct ClothModifierData *clmd );
206 void cloth_init (struct ClothModifierData *clmd );
207 void clothModifier_do (struct ClothModifierData *clmd, struct Scene *scene, struct Object *ob, struct DerivedMesh *dm, float (*vertexCos)[3]);
208
209 int cloth_uses_vgroup(struct ClothModifierData *clmd);
210
211 // needed for collision.c
212 void bvhtree_update_from_cloth (struct ClothModifierData *clmd, int moving );
213 void bvhselftree_update_from_cloth (struct ClothModifierData *clmd, int moving );
214
215 // needed for button_object.c
216 void cloth_clear_cache (struct Object *ob, struct ClothModifierData *clmd, float framenr );
217
218 // needed for cloth.c
219 int cloth_add_spring (struct ClothModifierData *clmd, unsigned int indexA, unsigned int indexB, float restlength, int spring_type);
220
221 ////////////////////////////////////////////////
222
223
224 /* This enum provides the IDs for our solvers. */
225 // only one available in the moment
226 typedef enum {
227         CM_IMPLICIT = 0,
228 } CM_SOLVER_ID;
229
230
231 /* This structure defines how to call the solver.
232  */
233 typedef struct {
234         const char              *name;
235         CM_SOLVER_ID    id;
236         int     ( *init ) (struct Object *ob, struct ClothModifierData *clmd );
237         int     ( *solver ) (struct Object *ob, float framenr, struct ClothModifierData *clmd, struct ListBase *effectors );
238         int     ( *free ) (struct ClothModifierData *clmd );
239 }
240 CM_SOLVER_DEF;
241
242
243 #endif
244