b5b33610bfe3e2b77826a1fb744f724af5da3533
[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 #include "DNA_listBase.h"
38         
39 typedef struct PartDeflect {
40         short deflect;          /* Deflection flag - does mesh deflect particles*/
41         short forcefield;       /* Force field type, do the vertices attract / repel particles ? */
42         short flag;                     /* general settings flag */
43         short falloff;          /* fall-off type*/
44         
45         float pdef_damp;        /* Damping factor for particle deflection       */
46         float pdef_rdamp;       /* Random element of damping for deflection     */
47         float pdef_perm;        /* Chance of particle passing through mesh      */
48         float pdef_frict;       /* Friction factor for particle deflection              */
49         float pdef_rfrict;      /* Random element of friction for deflection    */
50
51         float f_strength;       /* The strength of the force (+ or - )       */
52         float f_power;          /* The power law - real gravitation is 2 (square)  */
53         float f_dist;
54         float f_damp;           /* The dampening factor, currently only for harmonic force      */
55         float maxdist;          /* if indicated, use this maximum */
56         float mindist;          /* if indicated, use this minimum */
57         float maxrad;           /* radial versions of above */
58         float minrad;
59         float f_power_r;        /* radial fall-off power*/
60         
61         float pdef_sbdamp;      /* Damping factor for softbody deflection       */
62         float pdef_sbift;       /* inner face thickness for softbody deflection */
63         float pdef_sboft;       /* outer face thickness for softbody deflection */
64
65         /* variables for guide curve */
66         float clump_fac, clump_pow;
67         float kink_freq, kink_shape, kink_amp, free_end;
68
69         float tex_nabla;
70         short tex_mode, kink, kink_axis, rt2;
71         struct Tex *tex;        /* Texture of the texture effector */
72         struct RNG *rng; /* random noise generator for e.g. wind */
73         float f_noise; /* noise of force (currently used for wind) */
74         int seed; /* wind noise random seed */
75 } PartDeflect;
76
77 typedef struct PTCacheMem {
78         struct PTCacheMem *next, *prev;
79         int frame, totpoint;
80         float *data;    /* data points */
81         void *xdata;    /* extra data */
82 } PTCacheMem;
83
84 typedef struct PointCache {
85         int flag;               /* generic flag */
86         int step;               /* frames between cached frames */
87         int simframe;   /* current frame of simulation (only if SIMULATION_VALID) */
88         int startframe; /* simulation start frame */
89         int endframe;   /* simulation end frame */
90         int editframe;  /* frame being edited (runtime only) */
91         int last_exact; /* last exact frame that's cached */
92
93         /* for external cache files */
94         int totpoint;   /* number of cached points */
95         int index, rt;  /* modifier stack index */
96         
97         char name[64];
98         char prev_name[64];
99         char info[64];
100         char path[240]; /* file path */
101         struct ListBase mem_cache;
102 } PointCache;
103
104 typedef struct SBVertex {
105         float vec[4];
106 } SBVertex;
107
108 typedef struct BulletSoftBody {
109         int flag;                               /* various boolean options */
110         float linStiff;                 /* linear stiffness 0..1 */
111         float   angStiff;               /* angular stiffness 0..1 */
112         float   volume;                 /* volume preservation 0..1 */
113
114         int     viterations;            /* Velocities solver iterations */
115         int     piterations;            /* Positions solver iterations */
116         int     diterations;            /* Drift solver iterations */
117         int     citerations;            /* Cluster solver iterations */
118
119         float   kSRHR_CL;               /* Soft vs rigid hardness [0,1] (cluster only) */
120         float   kSKHR_CL;               /* Soft vs kinetic hardness [0,1] (cluster only) */
121         float   kSSHR_CL;               /* Soft vs soft hardness [0,1] (cluster only) */
122         float   kSR_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
123
124         float   kSK_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
125         float   kSS_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
126         float   kVCF;                   /* Velocities correction factor (Baumgarte) */
127         float   kDP;                    /* Damping coefficient [0,1] */
128
129         float   kDG;                    /* Drag coefficient [0,+inf] */
130         float   kLF;                    /* Lift coefficient [0,+inf] */
131         float   kPR;                    /* Pressure coefficient [-inf,+inf] */
132         float   kVC;                    /* Volume conversation coefficient [0,+inf] */
133
134         float   kDF;                    /* Dynamic friction coefficient [0,1] */
135         float   kMT;                    /* Pose matching coefficient [0,1] */
136         float   kCHR;                   /* Rigid contacts hardness [0,1] */
137         float   kKHR;                   /* Kinetic contacts hardness [0,1] */
138
139         float   kSHR;                   /* Soft contacts hardness [0,1] */
140         float   kAHR;                   /* Anchors hardness [0,1] */
141         int             collisionflags; /* Vertex/Face or Signed Distance Field(SDF) or Clusters, Soft versus Soft or Rigid */
142         int             numclusteriterations;   /* number of iterations to refine collision clusters*/
143         float   welding;                /* welding limit to remove duplicate/nearby vertices, 0.0..0.01 */
144         float   margin;                 /* margin specific to softbody */
145 } BulletSoftBody;
146
147 /* BulletSoftBody.flag */
148 #define OB_BSB_SHAPE_MATCHING   2
149 #define OB_BSB_UNUSED 4
150 #define OB_BSB_BENDING_CONSTRAINTS 8
151 #define OB_BSB_AERO_VPOINT 16 /* aero model, Vertex normals are oriented toward velocity*/
152 #define OB_BSB_AERO_VTWOSIDE 32 /* aero model, Vertex normals are flipped to match velocity */
153
154 /* BulletSoftBody.collisionflags */
155 #define OB_BSB_COL_SDF_RS       2 /* SDF based rigid vs soft */
156 #define OB_BSB_COL_CL_RS        4 /* Cluster based rigid vs soft */
157 #define OB_BSB_COL_CL_SS        8 /* Cluster based soft vs soft */
158 #define OB_BSB_COL_VF_SS        16 /* Vertex/Face based soft vs soft */
159
160
161 typedef struct SoftBody {
162         struct ParticleSystem *particles;       /* particlesystem softbody */
163
164         /* dynamic data */
165         int totpoint, totspring;
166         struct BodyPoint *bpoint;               /* not saved in file */
167         struct BodySpring *bspring;             /* not saved in file */
168         char   pad;
169         char   msg_lock;
170         short  msg_value;
171         
172         /* part of UI: */
173         
174         /* general options */
175         float nodemass;         /* softbody mass of *vertex* */
176         char  namedVG_Mass[32]; /* along with it introduce mass painting
177                                                         starting to fix old bug .. nastyness that VG are indexes 
178                                                                 rather find them by name tag to find it -> jow20090613 */
179         float grav;                     /* softbody amount of gravitaion to apply */
180         float mediafrict;       /* friction to env */
181         float rklimit;          /* error limit for ODE solver */
182         float physics_speed;/* user control over simulation speed */
183         
184         /* goal */
185         float goalspring;       /* softbody goal springs */
186         float goalfrict;        /* softbody goal springs friction */
187         float mingoal;          /* quick limits for goal */
188         float maxgoal;
189         float defgoal;          /* default goal for vertices without vgroup */
190         short vertgroup;        /* index starting at 1 */
191         char  namedVG_Softgoal[32]; /* starting to fix old bug .. nastyness that VG are indexes 
192                                                                 rather find them by name tag to find it -> jow20090613 */
193   
194         short fuzzyness;      /* */
195         
196         /* springs */
197         float inspring;         /* softbody inner springs */
198         float infrict;          /* softbody inner springs friction */
199         char  namedVG_Spring_K[32]; /* along with it introduce Spring_K painting
200                                                         starting to fix old bug .. nastyness that VG are indexes 
201                                                                 rather find them by name tag to find it -> jow20090613 */
202         
203         /* baking */
204         int sfra, efra;
205         int interval;
206         short local, solverflags;               /* local==1: use local coords for baking */
207         
208         /* -- these must be kept for backwards compatibility -- */
209         SBVertex **keys;                        /* array of size totpointkey */
210         int totpointkey, totkey;        /* if totpointkey != totpoint or totkey!- (efra-sfra)/interval -> free keys */
211         /* ---------------------------------------------------- */
212         float secondspring;
213
214         /* self collision*/
215         float colball;          /* fixed collision ball size if > 0 */
216         float balldamp;         /* cooling down collision response  */
217         float ballstiff;        /* pressure the ball is loaded with  */
218         short sbc_mode;
219     short aeroedge,
220                 minloops,
221                 maxloops,
222                 choke,
223                 solver_ID,
224                 plastic,springpreload
225                 ;   
226
227         struct SBScratch *scratch;      /* scratch pad/cache on live time not saved in file */
228         float shearstiff;
229         float inpush;
230
231         struct PointCache *pointcache;
232
233 } SoftBody;
234
235 /* pd->forcefield:  Effector Fields types */
236 #define PFIELD_FORCE    1
237 #define PFIELD_VORTEX   2
238 #define PFIELD_MAGNET   3
239 #define PFIELD_WIND             4
240 #define PFIELD_GUIDE    5
241 #define PFIELD_TEXTURE  6
242 #define PFIELD_HARMONIC 7
243 #define PFIELD_CHARGE   8
244 #define PFIELD_LENNARDJ 9
245 #define PFIELD_BOID             10
246
247
248 /* pd->flag: various settings */
249 #define PFIELD_USEMAX                   1
250 #define PDEFLE_DEFORM                   2
251 #define PFIELD_GUIDE_PATH_ADD   4
252 #define PFIELD_PLANAR                   8
253 #define PDEFLE_KILL_PART                16
254 #define PFIELD_POSZ                             32
255 #define PFIELD_TEX_OBJECT               64
256 #define PFIELD_TEX_2D                   128
257 #define PFIELD_USEMIN                   256
258 #define PFIELD_USEMAXR                  512
259 #define PFIELD_USEMINR                  1024
260 #define PFIELD_TEX_ROOTCO               2048
261 #define PFIELD_SURFACE                  4096
262
263 /* pd->falloff */
264 #define PFIELD_FALL_SPHERE              0
265 #define PFIELD_FALL_TUBE                1
266 #define PFIELD_FALL_CONE                2
267 //reserved for near future
268 //#define PFIELD_FALL_INSIDE            3
269
270 /* pd->tex_mode */
271 #define PFIELD_TEX_RGB  0
272 #define PFIELD_TEX_GRAD 1
273 #define PFIELD_TEX_CURL 2
274
275 /* pointcache->flag */
276 #define PTCACHE_BAKED                           1
277 #define PTCACHE_OUTDATED                        2
278 #define PTCACHE_SIMULATION_VALID        4
279 #define PTCACHE_BAKING                          8
280 #define PTCACHE_BAKE_EDIT                       16
281 #define PTCACHE_BAKE_EDIT_ACTIVE        32
282 #define PTCACHE_DISK_CACHE                      64
283 #define PTCACHE_QUICK_CACHE                     128
284 #define PTCACHE_FRAMES_SKIPPED          256
285 #define PTCACHE_EXTERNAL                        512
286
287 /* PTCACHE_OUTDATED + PTCACHE_FRAMES_SKIPPED */
288 #define PTCACHE_REDO_NEEDED                     258
289
290 /* ob->softflag */
291 #define OB_SB_ENABLE    1               /* deprecated, use modifier */
292 #define OB_SB_GOAL              2
293 #define OB_SB_EDGES             4
294 #define OB_SB_QUADS             8
295 #define OB_SB_POSTDEF   16
296 // #define OB_SB_REDO           32
297 // #define OB_SB_BAKESET        64
298 // #define OB_SB_BAKEDO 128
299 // #define OB_SB_RESET          256
300 #define OB_SB_SELF              512
301 #define OB_SB_FACECOLL  1024
302 #define OB_SB_EDGECOLL  2048
303 #define OB_SB_COLLFINAL 4096
304 #define OB_SB_BIG_UI    8192
305 #define OB_SB_AERO_ANGLE        16384
306
307 /* sb->solverflags */
308 #define SBSO_MONITOR    1 
309 #define SBSO_OLDERR     2 
310
311 /* sb->sbc_mode */
312 #define SBC_MODE_MANUAL         0
313 #define SBC_MODE_AVG            1
314 #define SBC_MODE_MIN            2
315 #define SBC_MODE_MAX            3
316 #define SBC_MODE_AVGMINMAX      4
317
318 #ifdef __cplusplus
319 }
320 #endif
321
322 #endif
323