Patch/Bugfix so wind noise got controlable seed and therefore redoable cloth sims...
[blender.git] / source / blender / makesdna / DNA_object_force.h
1 /**
2  *
3  * $Id$
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
20  *
21  * The Original Code is Copyright (C) 2004-2005 by Blender Foundation
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30 #ifndef DNA_OBJECT_FORCE_H
31 #define DNA_OBJECT_FORCE_H
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36         
37 typedef struct PartDeflect {
38         short deflect;          /* Deflection flag - does mesh deflect particles*/
39         short forcefield;       /* Force field type, do the vertices attract / repel particles ? */
40         short flag;                     /* general settings flag */
41         short falloff;          /* fall-off type*/
42         
43         float pdef_damp;        /* Damping factor for particle deflection       */
44         float pdef_rdamp;       /* Random element of damping for deflection     */
45         float pdef_perm;        /* Chance of particle passing through mesh      */
46         float pdef_frict;       /* Friction factor for particle deflection              */
47         float pdef_rfrict;      /* Random element of friction for deflection    */
48
49         float f_strength;       /* The strength of the force (+ or - )       */
50         float f_power;          /* The power law - real gravitation is 2 (square)  */
51         float f_dist;
52         float f_damp;           /* The dampening factor, currently only for harmonic force      */
53         float maxdist;          /* if indicated, use this maximum */
54         float mindist;          /* if indicated, use this minimum */
55         float maxrad;           /* radial versions of above */
56         float minrad;
57         float f_power_r;        /* radial fall-off power*/
58         
59         float pdef_sbdamp;      /* Damping factor for softbody deflection       */
60         float pdef_sbift;       /* inner face thickness for softbody deflection */
61         float pdef_sboft;       /* outer face thickness for softbody deflection */
62
63         /* variables for guide curve */
64         float clump_fac, clump_pow;
65         float kink_freq, kink_shape, kink_amp, free_end;
66
67         float tex_nabla;
68         short tex_mode, kink, kink_axis, rt2;
69         struct Tex *tex;        /* Texture of the texture effector */
70         struct RNG *rng; /* random noise generator for e.g. wind */
71         float f_noise; /* noise of force (currently used for wind) */
72         int seed; /* wind noise random seed */
73 } PartDeflect;
74
75 typedef struct PointCache {
76         int flag;               /* generic flag */
77         int simframe;   /* current frame of simulation (only if SIMULATION_VALID) */
78         int startframe; /* simulation start frame */
79         int endframe;   /* simulation end frame */
80         int editframe;  /* frame being edited (runtime only) */
81 } PointCache;
82
83 typedef struct SBVertex {
84         float vec[4];
85 } SBVertex;
86
87 typedef struct BulletSoftBody {
88         int flag;                               /* various boolean options */
89         float linStiff;                 /* linear stiffness 0..1 */
90         float   angStiff;               /* angular stiffness 0..1 */
91         float   volume;                 /* volume preservation 0..1 */
92
93         int     viterations;            /* Velocities solver iterations */
94         int     piterations;            /* Positions solver iterations */
95         int     diterations;            /* Drift solver iterations */
96         int     citerations;            /* Cluster solver iterations */
97
98         float   kSRHR_CL;               /* Soft vs rigid hardness [0,1] (cluster only) */
99         float   kSKHR_CL;               /* Soft vs kinetic hardness [0,1] (cluster only) */
100         float   kSSHR_CL;               /* Soft vs soft hardness [0,1] (cluster only) */
101         float   kSR_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
102
103         float   kSK_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
104         float   kSS_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
105         float   kVCF;                   /* Velocities correction factor (Baumgarte) */
106         float   kDP;                    /* Damping coefficient [0,1] */
107
108         float   kDG;                    /* Drag coefficient [0,+inf] */
109         float   kLF;                    /* Lift coefficient [0,+inf] */
110         float   kPR;                    /* Pressure coefficient [-inf,+inf] */
111         float   kVC;                    /* Volume conversation coefficient [0,+inf] */
112
113         float   kDF;                    /* Dynamic friction coefficient [0,1] */
114         float   kMT;                    /* Pose matching coefficient [0,1] */
115         float   kCHR;                   /* Rigid contacts hardness [0,1] */
116         float   kKHR;                   /* Kinetic contacts hardness [0,1] */
117
118         float   kSHR;                   /* Soft contacts hardness [0,1] */
119         float   kAHR;                   /* Anchors hardness [0,1] */
120         int             collisionflags; /* Vertex/Face or Signed Distance Field(SDF) or Clusters, Soft versus Soft or Rigid */
121         int             numclusteriterations;   /* number of iterations to refine collision clusters*/
122         float   welding;                /* welding limit to remove duplicate/nearby vertices, 0.0..0.01 */
123         float   margin;                 /* margin specific to softbody */
124 } BulletSoftBody;
125
126 /* BulletSoftBody.flag */
127 #define OB_BSB_SHAPE_MATCHING   2
128 #define OB_BSB_UNUSED 4
129 #define OB_BSB_BENDING_CONSTRAINTS 8
130 #define OB_BSB_AERO_VPOINT 16 /* aero model, Vertex normals are oriented toward velocity*/
131 #define OB_BSB_AERO_VTWOSIDE 32 /* aero model, Vertex normals are flipped to match velocity */
132
133 /* BulletSoftBody.collisionflags */
134 #define OB_BSB_COL_SDF_RS       2 /* SDF based rigid vs soft */
135 #define OB_BSB_COL_CL_RS        4 /* Cluster based rigid vs soft */
136 #define OB_BSB_COL_CL_SS        8 /* Cluster based soft vs soft */
137 #define OB_BSB_COL_VF_SS        16 /* Vertex/Face based soft vs soft */
138
139
140 typedef struct SoftBody {
141         struct ParticleSystem *particles;       /* particlesystem softbody */
142
143         /* dynamic data */
144         int totpoint, totspring;
145         struct BodyPoint *bpoint;               /* not saved in file */
146         struct BodySpring *bspring;             /* not saved in file */
147         float pad;
148         
149         /* part of UI: */
150         
151         /* general options */
152         float nodemass;         /* softbody mass of *vertex* */
153         float grav;                     /* softbody amount of gravitaion to apply */
154         float mediafrict;       /* friction to env */
155         float rklimit;          /* error limit for ODE solver */
156         float physics_speed;/* user control over simulation speed */
157         
158         /* goal */
159         float goalspring;       /* softbody goal springs */
160         float goalfrict;        /* softbody goal springs friction */
161         float mingoal;          /* quick limits for goal */
162         float maxgoal;
163         float defgoal;          /* default goal for vertices without vgroup */
164         short vertgroup;        /* index starting at 1 */
165   
166         short fuzzyness;      /* */
167         
168         /* springs */
169         float inspring;         /* softbody inner springs */
170         float infrict;          /* softbody inner springs friction */
171         
172         /* baking */
173         int sfra, efra;
174         int interval;
175         short local, solverflags;               /* local==1: use local coords for baking */
176         
177         /* -- these must be kept for backwards compatibility -- */
178         SBVertex **keys;                        /* array of size totpointkey */
179         int totpointkey, totkey;        /* if totpointkey != totpoint or totkey!- (efra-sfra)/interval -> free keys */
180         /* ---------------------------------------------------- */
181         float secondspring;
182
183         /* self collision*/
184         float colball;          /* fixed collision ball size if > 0 */
185         float balldamp;         /* cooling down collision response  */
186         float ballstiff;        /* pressure the ball is loaded with  */
187         short sbc_mode;
188     short aeroedge,
189                 minloops,
190                 maxloops,
191                 choke,
192                 solver_ID,
193                 plastic,springpreload
194                 ;   
195
196         struct SBScratch *scratch;      /* scratch pad/cache on live time not saved in file */
197         float shearstiff;
198         float inpush;
199
200         struct PointCache *pointcache;
201
202 } SoftBody;
203
204 /* pd->forcefield:  Effector Fields types */
205 #define PFIELD_FORCE    1
206 #define PFIELD_VORTEX   2
207 #define PFIELD_MAGNET   3
208 #define PFIELD_WIND             4
209 #define PFIELD_GUIDE    5
210 #define PFIELD_TEXTURE  6
211 #define PFIELD_HARMONIC 7
212 #define PFIELD_CHARGE   8
213 #define PFIELD_LENNARDJ 9
214
215
216 /* pd->flag: various settings */
217 #define PFIELD_USEMAX                   1
218 #define PDEFLE_DEFORM                   2
219 #define PFIELD_GUIDE_PATH_ADD   4
220 #define PFIELD_PLANAR                   8
221 #define PDEFLE_KILL_PART                16
222 #define PFIELD_POSZ                             32
223 #define PFIELD_TEX_OBJECT               64
224 #define PFIELD_TEX_2D                   128
225 #define PFIELD_USEMIN                   256
226 #define PFIELD_USEMAXR                  512
227 #define PFIELD_USEMINR                  1024
228 #define PFIELD_TEX_ROOTCO               2048
229 #define PFIELD_SURFACE                  4096
230
231 /* pd->falloff */
232 #define PFIELD_FALL_SPHERE              0
233 #define PFIELD_FALL_TUBE                1
234 #define PFIELD_FALL_CONE                2
235 //reserved for near future
236 //#define PFIELD_FALL_INSIDE            3
237
238 /* pd->tex_mode */
239 #define PFIELD_TEX_RGB  0
240 #define PFIELD_TEX_GRAD 1
241 #define PFIELD_TEX_CURL 2
242
243 /* pointcache->flag */
244 #define PTCACHE_BAKED                           1
245 #define PTCACHE_OUTDATED                        2
246 #define PTCACHE_SIMULATION_VALID        4
247 #define PTCACHE_BAKING                          8
248 #define PTCACHE_BAKE_EDIT                       16
249 #define PTCACHE_BAKE_EDIT_ACTIVE        32
250
251 /* ob->softflag */
252 #define OB_SB_ENABLE    1
253 #define OB_SB_GOAL              2
254 #define OB_SB_EDGES             4
255 #define OB_SB_QUADS             8
256 #define OB_SB_POSTDEF   16
257 // #define OB_SB_REDO           32
258 // #define OB_SB_BAKESET        64
259 // #define OB_SB_BAKEDO 128
260 // #define OB_SB_RESET          256
261 #define OB_SB_SELF              512
262 #define OB_SB_FACECOLL  1024
263 #define OB_SB_EDGECOLL  2048
264 #define OB_SB_COLLFINAL 4096
265 //#define OB_SB_PROTECT_CACHE   8192
266 #define OB_SB_AERO_ANGLE        16384
267
268 /* sb->solverflags */
269 #define SBSO_MONITOR    1 
270 #define SBSO_OLDERR     2 
271
272 /* sb->sbc_mode */
273 #define SBC_MODE_MANUAL         0
274 #define SBC_MODE_AVG            1
275 #define SBC_MODE_MIN            2
276 #define SBC_MODE_MAX            3
277 #define SBC_MODE_AVGMINMAX      4
278
279 #ifdef __cplusplus
280 }
281 #endif
282
283 #endif
284