Merge with trunk r41625
[blender.git] / source / blender / makesdna / DNA_object_force.h
1 /*
2  *
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2004-2005 by Blender Foundation
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef DNA_OBJECT_FORCE_H
30 #define DNA_OBJECT_FORCE_H
31
32 /** \file DNA_object_force.h
33  *  \ingroup DNA
34  */
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include "DNA_listBase.h"
41
42 /* pd->forcefield:  Effector Fields types */
43 typedef enum PFieldType {
44         PFIELD_NULL = 0,        /* (this is used for general effector weight)                                                   */
45         PFIELD_FORCE,           /* Force away/towards a point depending on force strength                               */
46         PFIELD_VORTEX,          /* Force around the effector normal                                                                             */
47         PFIELD_MAGNET,          /* Force from the cross product of effector normal and point velocity   */
48         PFIELD_WIND,            /* Force away and towards a point depending which side of the effector  */
49                                                 /*       normal the point is                                                                                            */
50         PFIELD_GUIDE,           /* Force along curve for dynamics, a shaping curve for hair paths               */
51         PFIELD_TEXTURE,         /* Force based on texture values calculated at point coordinates                */
52         PFIELD_HARMONIC,        /* Force of a harmonic (damped) oscillator                                                              */
53         PFIELD_CHARGE,          /* Force away/towards a point depending on point charge                                 */
54         PFIELD_LENNARDJ,        /* Force due to a Lennard-Jones potential                                                               */
55         PFIELD_BOID,            /* Defines predator / goal for boids                                                                    */
56         PFIELD_TURBULENCE,      /* Force defined by BLI_gTurbulence                                                                             */
57         PFIELD_DRAG,            /* Linear & quadratic drag                                                                                              */
58         NUM_PFIELD_TYPES
59 } PFieldType;
60         
61 typedef struct PartDeflect {
62         int       flag;                 /* general settings flag                                                                                */
63         short deflect;          /* Deflection flag - does mesh deflect particles                                */
64         short forcefield;       /* Force field type, do the vertices attract / repel particles? */
65         short falloff;          /* fall-off type                                                                                                */
66         short shape;            /* point, plane or surface                                                                              */
67         short tex_mode;         /* texture effector                                                                                             */
68         short kink, kink_axis; /* for curve guide                                                                                       */
69         short zdir;
70         
71         /* Main effector values */
72         float f_strength;       /* The strength of the force (+ or - )                                  */
73         float f_damp;           /* Damping ratio of the harmonic effector.                              */
74         float f_flow;           /* How much force is converted into "air flow", i.e.    */
75                                                 /* force used as the velocity of surrounding medium.    */
76
77         float f_size;           /* Noise size for noise effector, restlength for harmonic effector */
78
79         /* fall-off */
80         float f_power;          /* The power law - real gravitation is 2 (square)       */
81         float maxdist;          /* if indicated, use this maximum                                       */
82         float mindist;          /* if indicated, use this minimum                                       */
83         float f_power_r;        /* radial fall-off power                                                        */
84         float maxrad;           /* radial versions of above                                                     */
85         float minrad;
86
87         /* particle collisions */
88         float pdef_damp;        /* Damping factor for particle deflection       */
89         float pdef_rdamp;       /* Random element of damping for deflection     */
90         float pdef_perm;        /* Chance of particle passing through mesh      */
91         float pdef_frict;       /* Friction factor for particle deflection              */
92         float pdef_rfrict;      /* Random element of friction for deflection    */
93         float pdef_stickness;/* surface particle stickness                                      */
94
95         float absorption;       /* used for forces */
96         
97         /* softbody collisions */
98         float pdef_sbdamp;      /* Damping factor for softbody deflection       */
99         float pdef_sbift;       /* inner face thickness for softbody deflection */
100         float pdef_sboft;       /* outer face thickness for softbody deflection */
101
102         /* guide curve, same as for particle child effects */
103         float clump_fac, clump_pow;
104         float kink_freq, kink_shape, kink_amp, free_end;
105
106         /* texture effector */
107         float tex_nabla;        /* Used for calculating partial derivatives */
108         struct Tex *tex;        /* Texture of the texture effector                      */
109
110         /* effector noise */
111         struct RNG *rng;        /* random noise generator for e.g. wind */
112         float f_noise;          /* noise of force                                               */
113         int seed;                       /* noise random seed                                    */
114 } PartDeflect;
115
116 typedef struct EffectorWeights {
117         struct Group *group;            /* only use effectors from this group of objects */
118         
119         float weight[13];                       /* effector type specific weights */
120         float global_gravity;
121         short flag, rt[3];
122 } EffectorWeights;
123
124 /* EffectorWeights->flag */
125 #define EFF_WEIGHT_DO_HAIR              1
126
127 /* Point cache file data types:
128  * - used as (1<<flag) so poke jahka if you reach the limit of 15
129  * - to add new data types update:
130  *              * BKE_ptcache_data_size()
131  *              * ptcache_file_init_pointers()
132 */
133 #define BPHYS_DATA_INDEX                0
134 #define BPHYS_DATA_LOCATION             1
135 #define BPHYS_DATA_SMOKE_LOW    1
136 #define BPHYS_DATA_VELOCITY             2
137 #define BPHYS_DATA_SMOKE_HIGH   2
138 #define BPHYS_DATA_ROTATION             3
139 #define BPHYS_DATA_DYNAMICPAINT 3
140 #define BPHYS_DATA_AVELOCITY    4       /* used for particles */
141 #define BPHYS_DATA_XCONST               4       /* used for cloth */
142 #define BPHYS_DATA_SIZE                 5
143 #define BPHYS_DATA_TIMES                6
144 #define BPHYS_DATA_BOIDS                7
145
146 #define BPHYS_TOT_DATA                  8
147
148 #define BPHYS_EXTRA_FLUID_SPRINGS       1
149
150 typedef struct PTCacheExtra {
151         struct PTCacheExtra *next, *prev;
152         unsigned int type, totdata;
153         void *data;
154 } PTCacheExtra;
155
156 typedef struct PTCacheMem {
157         struct PTCacheMem *next, *prev;
158         unsigned int frame, totpoint;
159         unsigned int data_types, flag;
160
161         void *data[8]; /* BPHYS_TOT_DATA */
162         void *cur[8]; /* BPHYS_TOT_DATA */
163
164         struct ListBase extradata;
165 } PTCacheMem;
166
167 typedef struct PointCache {
168         struct PointCache *next, *prev;
169         int flag;               /* generic flag */
170         
171         int step;               /* The number of frames between cached frames.
172                                          * This should probably be an upper bound for a per point adaptive step in the future,
173                                          * buf for now it's the same for all points. Without adaptivity this can effect the perceived
174                                          * simulation quite a bit though. If for example particles are colliding with a horizontal
175                                          * plane (with high damping) they quickly come to a stop on the plane, however there are still
176                                          * forces acting on the particle (gravity and collisions), so the particle velocity isn't necessarily
177                                          * zero for the whole duration of the frame even if the particle seems stationary. If all simulation
178                                          * frames aren't cached (step > 1) these velocities are interpolated into movement for the non-cached
179                                          * frames. The result will look like the point is oscillating around the collision location. So for
180                                          * now cache step should be set to 1 for accurate reproduction of collisions.
181                                          */
182
183         int simframe;   /* current frame of simulation (only if SIMULATION_VALID) */
184         int startframe; /* simulation start frame */
185         int endframe;   /* simulation end frame */
186         int editframe;  /* frame being edited (runtime only) */
187         int last_exact; /* last exact frame that's cached */
188
189         /* for external cache files */
190         int totpoint;   /* number of cached points */
191         int index;      /* modifier stack index */
192         short compression, rt;
193         
194         char name[64];
195         char prev_name[64];
196         char info[64];
197         char path[240]; /* file path */
198         char *cached_frames;    /* array of length endframe-startframe+1 with flags to indicate cached frames */
199                                                         /* can be later used for other per frame flags too if needed */
200         struct ListBase mem_cache;
201
202         struct PTCacheEdit *edit;
203         void (*free_edit)(struct PTCacheEdit *edit);    /* free callback */
204 } PointCache;
205
206 typedef struct SBVertex {
207         float vec[4];
208 } SBVertex;
209
210 typedef struct BulletSoftBody {
211         int flag;                               /* various boolean options */
212         float linStiff;                 /* linear stiffness 0..1 */
213         float   angStiff;               /* angular stiffness 0..1 */
214         float   volume;                 /* volume preservation 0..1 */
215
216         int     viterations;            /* Velocities solver iterations */
217         int     piterations;            /* Positions solver iterations */
218         int     diterations;            /* Drift solver iterations */
219         int     citerations;            /* Cluster solver iterations */
220
221         float   kSRHR_CL;               /* Soft vs rigid hardness [0,1] (cluster only) */
222         float   kSKHR_CL;               /* Soft vs kinetic hardness [0,1] (cluster only) */
223         float   kSSHR_CL;               /* Soft vs soft hardness [0,1] (cluster only) */
224         float   kSR_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
225
226         float   kSK_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
227         float   kSS_SPLT_CL;    /* Soft vs rigid impulse split [0,1] (cluster only) */
228         float   kVCF;                   /* Velocities correction factor (Baumgarte) */
229         float   kDP;                    /* Damping coefficient [0,1] */
230
231         float   kDG;                    /* Drag coefficient [0,+inf] */
232         float   kLF;                    /* Lift coefficient [0,+inf] */
233         float   kPR;                    /* Pressure coefficient [-inf,+inf] */
234         float   kVC;                    /* Volume conversation coefficient [0,+inf] */
235
236         float   kDF;                    /* Dynamic friction coefficient [0,1] */
237         float   kMT;                    /* Pose matching coefficient [0,1] */
238         float   kCHR;                   /* Rigid contacts hardness [0,1] */
239         float   kKHR;                   /* Kinetic contacts hardness [0,1] */
240
241         float   kSHR;                   /* Soft contacts hardness [0,1] */
242         float   kAHR;                   /* Anchors hardness [0,1] */
243         int             collisionflags; /* Vertex/Face or Signed Distance Field(SDF) or Clusters, Soft versus Soft or Rigid */
244         int             numclusteriterations;   /* number of iterations to refine collision clusters*/
245         float   welding;                /* welding limit to remove duplicate/nearby vertices, 0.0..0.01 */
246         float   margin;                 /* margin specific to softbody */
247 } BulletSoftBody;
248
249 /* BulletSoftBody.flag */
250 #define OB_BSB_SHAPE_MATCHING   2
251 #define OB_BSB_UNUSED 4
252 #define OB_BSB_BENDING_CONSTRAINTS 8
253 #define OB_BSB_AERO_VPOINT 16 /* aero model, Vertex normals are oriented toward velocity*/
254 #define OB_BSB_AERO_VTWOSIDE 32 /* aero model, Vertex normals are flipped to match velocity */
255
256 /* BulletSoftBody.collisionflags */
257 #define OB_BSB_COL_SDF_RS       2 /* SDF based rigid vs soft */
258 #define OB_BSB_COL_CL_RS        4 /* Cluster based rigid vs soft */
259 #define OB_BSB_COL_CL_SS        8 /* Cluster based soft vs soft */
260 #define OB_BSB_COL_VF_SS        16 /* Vertex/Face based soft vs soft */
261
262
263 typedef struct SoftBody {
264         /* dynamic data */
265         int totpoint, totspring;
266         struct BodyPoint *bpoint;               /* not saved in file */
267         struct BodySpring *bspring;             /* not saved in file */
268         char   pad;
269         char   msg_lock;
270         short  msg_value;
271         
272         /* part of UI: */
273         
274         /* general options */
275         float nodemass;         /* softbody mass of *vertex* */
276         char  namedVG_Mass[32]; /* along with it introduce mass painting
277                                                         starting to fix old bug .. nastyness that VG are indexes 
278                                                                 rather find them by name tag to find it -> jow20090613 */
279         float grav;                     /* softbody amount of gravitaion to apply */
280         float mediafrict;       /* friction to env */
281         float rklimit;          /* error limit for ODE solver */
282         float physics_speed;/* user control over simulation speed */
283         
284         /* goal */
285         float goalspring;       /* softbody goal springs */
286         float goalfrict;        /* softbody goal springs friction */
287         float mingoal;          /* quick limits for goal */
288         float maxgoal;
289         float defgoal;          /* default goal for vertices without vgroup */
290         short vertgroup;        /* index starting at 1 */
291         char  namedVG_Softgoal[32]; /* starting to fix old bug .. nastyness that VG are indexes 
292                                                                 rather find them by name tag to find it -> jow20090613 */
293   
294         short fuzzyness;      /* */
295         
296         /* springs */
297         float inspring;         /* softbody inner springs */
298         float infrict;          /* softbody inner springs friction */
299          char  namedVG_Spring_K[32]; /* along with it introduce Spring_K painting
300                                                         starting to fix old bug .. nastyness that VG are indexes 
301                                                                 rather find them by name tag to find it -> jow20090613 */
302         
303         /* baking */
304         int sfra, efra;
305         int interval;
306         short local, solverflags;               /* local==1: use local coords for baking */
307         
308         /* -- these must be kept for backwards compatibility -- */
309         SBVertex **keys;                        /* array of size totpointkey */
310         int totpointkey, totkey;        /* if totpointkey != totpoint or totkey!- (efra-sfra)/interval -> free keys */
311         /* ---------------------------------------------------- */
312         float secondspring;
313
314         /* self collision*/
315         float colball;          /* fixed collision ball size if > 0 */
316         float balldamp;         /* cooling down collision response  */
317         float ballstiff;        /* pressure the ball is loaded with  */
318         short sbc_mode;
319         short aeroedge,
320                 minloops,
321                 maxloops,
322                 choke,
323                 solver_ID,
324                 plastic,springpreload
325                 ;   
326
327         struct SBScratch *scratch;      /* scratch pad/cache on live time not saved in file */
328         float shearstiff;
329         float inpush;
330
331         struct PointCache *pointcache;
332         struct ListBase ptcaches;
333
334         struct EffectorWeights *effector_weights;
335         /* reverse esimated obmatrix .. no need to store in blend file .. how ever who cares */ 
336         float lcom[3];
337         float lrot[3][3];
338         float lscale[3][3];
339         char  pad4[4];
340
341 } SoftBody;
342
343
344 /* pd->flag: various settings */
345 #define PFIELD_USEMAX                   1
346 /*#define PDEFLE_DEFORM                 2*/                     /*UNUSED*/
347 #define PFIELD_GUIDE_PATH_ADD   4                       /* TODO: do_versions for below */
348 #define PFIELD_PLANAR                   8                       /* used for do_versions */
349 #define PDEFLE_KILL_PART                16
350 #define PFIELD_POSZ                             32                      /* used for do_versions */
351 #define PFIELD_TEX_OBJECT               64
352 #define PFIELD_GLOBAL_CO                64                      /* used for turbulence */
353 #define PFIELD_TEX_2D                   128
354 #define PFIELD_MULTIPLE_SPRINGS 128                     /* used for harmonic force */
355 #define PFIELD_USEMIN                   256
356 #define PFIELD_USEMAXR                  512
357 #define PFIELD_USEMINR                  1024
358 #define PFIELD_TEX_ROOTCO               2048
359 #define PFIELD_SURFACE                  (1<<12)         /* used for do_versions */
360 #define PFIELD_VISIBILITY               (1<<13)
361 #define PFIELD_DO_LOCATION              (1<<14)
362 #define PFIELD_DO_ROTATION              (1<<15)
363 #define PFIELD_GUIDE_PATH_WEIGHT (1<<16)        /* apply curve weights */
364
365 /* pd->falloff */
366 #define PFIELD_FALL_SPHERE              0
367 #define PFIELD_FALL_TUBE                1
368 #define PFIELD_FALL_CONE                2
369
370 /* pd->shape */
371 #define PFIELD_SHAPE_POINT              0
372 #define PFIELD_SHAPE_PLANE              1
373 #define PFIELD_SHAPE_SURFACE    2
374 #define PFIELD_SHAPE_POINTS             3
375
376 /* pd->tex_mode */
377 #define PFIELD_TEX_RGB  0
378 #define PFIELD_TEX_GRAD 1
379 #define PFIELD_TEX_CURL 2
380
381 /* pd->zdir */
382 #define PFIELD_Z_BOTH   0
383 #define PFIELD_Z_POS    1
384 #define PFIELD_Z_NEG    2
385
386 /* pointcache->flag */
387 #define PTCACHE_BAKED                           1
388 #define PTCACHE_OUTDATED                        2
389 #define PTCACHE_SIMULATION_VALID        4
390 #define PTCACHE_BAKING                          8
391 //#define PTCACHE_BAKE_EDIT                     16
392 //#define PTCACHE_BAKE_EDIT_ACTIVE      32
393 #define PTCACHE_DISK_CACHE                      64
394 #define PTCACHE_QUICK_CACHE                     128
395 #define PTCACHE_FRAMES_SKIPPED          256
396 #define PTCACHE_EXTERNAL                        512
397 #define PTCACHE_READ_INFO                       1024
398 /* dont use the filename of the blendfile the data is linked from (write a local cache) */
399 #define PTCACHE_IGNORE_LIBPATH          2048
400 /* high resolution cache is saved for smoke for backwards compatibility, so set this flag to know it's a "fake" cache */
401 #define PTCACHE_FAKE_SMOKE                      (1<<12)
402 #define PTCACHE_IGNORE_CLEAR            (1<<13)
403
404 /* PTCACHE_OUTDATED + PTCACHE_FRAMES_SKIPPED */
405 #define PTCACHE_REDO_NEEDED                     258
406
407 #define PTCACHE_COMPRESS_NO                     0
408 #define PTCACHE_COMPRESS_LZO            1
409 #define PTCACHE_COMPRESS_LZMA           2
410
411 /* ob->softflag */
412 #define OB_SB_ENABLE    1               /* deprecated, use modifier */
413 #define OB_SB_GOAL              2
414 #define OB_SB_EDGES             4
415 #define OB_SB_QUADS             8
416 #define OB_SB_POSTDEF   16
417 // #define OB_SB_REDO           32
418 // #define OB_SB_BAKESET        64
419 // #define OB_SB_BAKEDO 128
420 // #define OB_SB_RESET          256
421 #define OB_SB_SELF              512
422 #define OB_SB_FACECOLL  1024
423 #define OB_SB_EDGECOLL  2048
424 #define OB_SB_COLLFINAL 4096    /* deprecated */
425 #define OB_SB_BIG_UI    8192
426 #define OB_SB_AERO_ANGLE        16384
427
428 /* sb->solverflags */
429 #define SBSO_MONITOR            1 
430 #define SBSO_OLDERR                     2 
431 #define SBSO_ESTIMATEIPO    4 
432
433 /* sb->sbc_mode */
434 #define SBC_MODE_MANUAL         0
435 #define SBC_MODE_AVG            1
436 #define SBC_MODE_MIN            2
437 #define SBC_MODE_MAX            3
438 #define SBC_MODE_AVGMINMAX      4
439
440 #ifdef __cplusplus
441 }
442 #endif
443
444 #endif
445