[#34013] [video sequence editor] Offset and crop of strips are wrong
[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
61 /**
62  * This structure describes a cloth object against which the
63  * simulation can run.
64  *
65  * The m and n members of this structure represent the assumed
66  * rectangular ordered grid for which the original paper is written.
67  * At some point they need to disappear and we need to determine out
68  * own connectivity of the mesh based on the actual edges in the mesh.
69  *
70  */
71 typedef struct Cloth {
72         struct ClothVertex      *verts;                 /* The vertices that represent this cloth. */
73         struct  LinkNode        *springs;               /* The springs connecting the mesh. */
74         unsigned int            numverts;               /* The number of verts == m * n. */
75         unsigned int            numsprings;             /* The count of springs. */
76         unsigned int            numfaces;
77         unsigned char           old_solver_type;        /* unused, only 1 solver here */
78         unsigned char           pad2;
79         short                   pad3;
80         struct BVHTree          *bvhtree;                       /* collision tree for this cloth object */
81         struct BVHTree          *bvhselftree;                   /* collision tree for this cloth object */
82         struct MFace            *mfaces;
83         struct Implicit_Data    *implicit;              /* our implicit solver connects to this pointer */
84         struct Implicit_Data    *implicitEM;            /* our implicit solver connects to this pointer */
85         struct EdgeHash         *edgehash;              /* used for selfcollisions */
86         int last_frame, pad4;
87 } Cloth;
88
89 /**
90  * The definition of a cloth vertex.
91  */
92 typedef struct ClothVertex {
93         int     flags;          /* General flags per vertex.            */
94         float   v[3];           /* The velocity of the point.           */
95         float   xconst[3];      /* constrained position                 */
96         float   x[3];           /* The current position of this vertex. */
97         float   xold[3];        /* The previous position of this vertex.*/
98         float   tx[3];          /* temporary position */
99         float   txold[3];       /* temporary old position */
100         float   tv[3];          /* temporary "velocity", mostly used as tv = tx-txold */
101         float   mass;           /* mass / weight of the vertex          */
102         float   goal;           /* goal, from SB                        */
103         float   impulse[3];     /* used in collision.c */
104         float   *xrest;         /* temporary valid for building springs */
105         unsigned int impulse_count; /* same as above */
106         float   avg_spring_len; /* average length of connected springs */
107         float   struct_stiff;
108         float   bend_stiff;
109         float   shear_stiff;
110         int     spring_count; /* how many springs attached? */
111 }
112 ClothVertex;
113
114 /**
115  * The definition of a spring.
116  */
117 typedef struct ClothSpring {
118         int     ij;             /* Pij from the paper, one end of the spring.   */
119         int     kl;             /* Pkl from the paper, one end of the spring.   */
120         float   restlen;        /* The original length of the spring.   */
121         int     matrix_index;   /* needed for implicit solver (fast lookup) */
122         int     type;           /* types defined in BKE_cloth.h ("springType") */
123         int     flags;          /* defined in BKE_cloth.h, e.g. deactivated due to tearing */
124         float dfdx[3][3];
125         float dfdv[3][3];
126         float f[3];
127         float   stiffness;      /* stiffness factor from the vertex groups */
128         float editrestlen;
129 }
130 ClothSpring;
131
132 // some macro enhancements for vector treatment
133 #define VECADDADD(v1,v2,v3)     {*(v1)+= *(v2) + *(v3); *(v1+1)+= *(v2+1) + *(v3+1); *(v1+2)+= *(v2+2) + *(v3+2);}
134 #define VECSUBADD(v1,v2,v3)     {*(v1)-= *(v2) + *(v3); *(v1+1)-= *(v2+1) + *(v3+1); *(v1+2)-= *(v2+2) + *(v3+2);}
135 #define VECADDSUB(v1,v2,v3)     {*(v1)+= *(v2) - *(v3); *(v1+1)+= *(v2+1) - *(v3+1); *(v1+2)+= *(v2+2) - *(v3+2);}
136 #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;}
137 #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;}
138 #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;}
139 #define VECADDS(v1,v2,v3,bS)    {*(v1)= *(v2) + *(v3)*bS; *(v1+1)= *(v2+1) + *(v3+1)*bS; *(v1+2)= *(v2+2) + *(v3+2)*bS;}
140 #define VECSUBMUL(v1,v2,aS)     {*(v1)-= *(v2) * aS; *(v1+1)-= *(v2+1) * aS; *(v1+2)-= *(v2+2) * aS;}
141 #define VECSUBS(v1,v2,v3,bS)    {*(v1)= *(v2) - *(v3)*bS; *(v1+1)= *(v2+1) - *(v3+1)*bS; *(v1+2)= *(v2+2) - *(v3+2)*bS;}
142 #define VECSUBSB(v1,v2, v3,bS)  {*(v1)= (*(v2)- *(v3))*bS; *(v1+1)= (*(v2+1) - *(v3+1))*bS; *(v1+2)= (*(v2+2) - *(v3+2))*bS;}
143 #define VECMULS(v1,aS)  {*(v1)*= aS; *(v1+1)*= aS; *(v1+2)*= *aS;}
144 #define VECADDMUL(v1,v2,aS)     {*(v1)+= *(v2) * aS; *(v1+1)+= *(v2+1) * aS; *(v1+2)+= *(v2+2) * aS;}
145
146 /* SIMULATION FLAGS: goal flags,.. */
147 /* These are the bits used in SimSettings.flags. */
148 typedef enum {
149         CLOTH_SIMSETTINGS_FLAG_COLLOBJ = ( 1 << 2 ),// object is only collision object, no cloth simulation is done
150         CLOTH_SIMSETTINGS_FLAG_GOAL = ( 1 << 3 ),       // we have goals enabled
151         CLOTH_SIMSETTINGS_FLAG_TEARING = ( 1 << 4 ),// true if tearing is enabled
152         CLOTH_SIMSETTINGS_FLAG_SCALING = ( 1 << 8 ), /* is advanced scaling active? */
153         CLOTH_SIMSETTINGS_FLAG_CCACHE_EDIT = (1 << 12), /* edit cache in editmode */
154         CLOTH_SIMSETTINGS_FLAG_NO_SPRING_COMPRESS = (1 << 13) /* don't allow spring compression */
155 } CLOTH_SIMSETTINGS_FLAGS;
156
157 /* COLLISION FLAGS */
158 typedef enum {
159         CLOTH_COLLSETTINGS_FLAG_ENABLED = ( 1 << 1 ), /* enables cloth - object collisions */
160         CLOTH_COLLSETTINGS_FLAG_SELF = ( 1 << 2 ), /* enables selfcollisions */
161 } CLOTH_COLLISIONSETTINGS_FLAGS;
162
163 /* Spring types as defined in the paper.*/
164 typedef enum {
165         CLOTH_SPRING_TYPE_STRUCTURAL  = (1 << 1),
166         CLOTH_SPRING_TYPE_SHEAR       = (1 << 2),
167         CLOTH_SPRING_TYPE_BENDING     = (1 << 3),
168         CLOTH_SPRING_TYPE_GOAL        = (1 << 4)
169 } CLOTH_SPRING_TYPES;
170
171 /* SPRING FLAGS */
172 typedef enum {
173         CLOTH_SPRING_FLAG_DEACTIVATE = ( 1 << 1 ),
174         CLOTH_SPRING_FLAG_NEEDED = ( 1 << 2 ), // springs has values to be applied
175 } CLOTH_SPRINGS_FLAGS;
176
177
178 /////////////////////////////////////////////////
179 // collision.c
180 ////////////////////////////////////////////////
181
182 // needed for implicit.c
183 int cloth_bvh_objcollision (struct Object *ob, struct ClothModifierData *clmd, float step, float dt );
184
185 ////////////////////////////////////////////////
186
187
188 ////////////////////////////////////////////////
189 // implicit.c
190 ////////////////////////////////////////////////
191
192 // needed for cloth.c
193 int implicit_init (struct Object *ob, struct ClothModifierData *clmd );
194 int implicit_free (struct ClothModifierData *clmd );
195 int implicit_solver (struct Object *ob, float frame, struct ClothModifierData *clmd, struct ListBase *effectors );
196 void implicit_set_positions (struct ClothModifierData *clmd );
197
198 /////////////////////////////////////////////////
199 // cloth.c
200 ////////////////////////////////////////////////
201
202 // needed for modifier.c
203 void cloth_free_modifier_extern (struct ClothModifierData *clmd );
204 void cloth_free_modifier (struct ClothModifierData *clmd );
205 void cloth_init (struct ClothModifierData *clmd );
206 void clothModifier_do (struct ClothModifierData *clmd, struct Scene *scene, struct Object *ob, struct DerivedMesh *dm, float (*vertexCos)[3]);
207
208 int cloth_uses_vgroup(struct ClothModifierData *clmd);
209
210 // needed for collision.c
211 void bvhtree_update_from_cloth (struct ClothModifierData *clmd, int moving );
212 void bvhselftree_update_from_cloth (struct ClothModifierData *clmd, int moving );
213
214 // needed for button_object.c
215 void cloth_clear_cache (struct Object *ob, struct ClothModifierData *clmd, float framenr );
216
217 // needed for cloth.c
218 int cloth_add_spring (struct ClothModifierData *clmd, unsigned int indexA, unsigned int indexB, float restlength, int spring_type);
219
220 ////////////////////////////////////////////////
221
222
223 /* This enum provides the IDs for our solvers. */
224 // only one available in the moment
225 typedef enum {
226         CM_IMPLICIT = 0,
227 } CM_SOLVER_ID;
228
229
230 /* This structure defines how to call the solver.
231  */
232 typedef struct {
233         const char              *name;
234         CM_SOLVER_ID    id;
235         int     ( *init ) (struct Object *ob, struct ClothModifierData *clmd );
236         int     ( *solver ) (struct Object *ob, float framenr, struct ClothModifierData *clmd, struct ListBase *effectors );
237         int     ( *free ) (struct ClothModifierData *clmd );
238 }
239 CM_SOLVER_DEF;
240
241
242 #endif
243