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