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