Completely refactored sph fluid particles. Only the very core of the algorithm remains
[blender.git] / source / blender / makesdna / DNA_particle_types.h
1 /*
2  * $Id$
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) 2007 by Janne Karhu.
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
30 #ifndef DNA_PARTICLE_TYPES_H
31 #define DNA_PARTICLE_TYPES_H
32
33 /** \file DNA_particle_types.h
34  *  \ingroup DNA
35  */
36
37 #include "DNA_ID.h"
38 #include "DNA_boid_types.h"
39
40 struct AnimData;
41
42 typedef struct HairKey {
43         float co[3];    /* location of hair vertex */
44         float time;             /* time along hair, default 0-100 */
45         float weight;   /* softbody weight */
46         short editflag; /* saved particled edit mode flags */
47         short pad;
48 } HairKey;
49
50 typedef struct ParticleKey {    /* when changed update size of struct to copy_particleKey()!! */
51         float co[3];    /* location */
52         float vel[3];   /* velocity */
53         float rot[4];   /* rotation quaternion */
54         float ave[3];   /* angular velocity */
55         float time;             /* when this key happens */
56 } ParticleKey;
57
58 typedef struct BoidParticle {
59         struct Object *ground;
60         struct BoidData data;
61         float gravity[3];
62         float wander[3];
63         float rt;
64 } BoidParticle;
65
66 typedef struct ParticleSpring {
67         float rest_length;
68         unsigned int particle_index[2], delete_flag;
69 }ParticleSpring;
70
71 /* Child particles are created around or between parent particles */
72 typedef struct ChildParticle {
73         int num, parent;        /* num is face index on the final derived mesh */
74         int pa[4];                      /* nearest particles to the child, used for the interpolation */
75         float w[4];                     /* interpolation weights for the above particles */
76         float fuv[4], foffset; /* face vertex weights and offset */
77         float rt;
78 } ChildParticle;
79
80 typedef struct ParticleTarget {
81         struct ParticleTarget *next, *prev;
82         struct Object *ob;
83         int psys;
84         short flag, mode;
85         float time, duration;
86 } ParticleTarget;
87
88 typedef struct ParticleDupliWeight {
89         struct ParticleDupliWeight *next, *prev;
90         struct Object *ob;
91         short count;
92         short flag, rt[2];
93 } ParticleDupliWeight;
94
95 typedef struct ParticleData {
96         ParticleKey state;              /* current global coordinates */
97
98         ParticleKey prev_state; /* previous state */
99         
100         HairKey *hair;                  /* hair vertices */
101
102         ParticleKey *keys;              /* keyed keys */
103
104         BoidParticle *boid;             /* boids data */
105
106         int totkey;                             /* amount of hair or keyed keys*/
107
108         float time, lifetime;   /* dietime is not nescessarily time+lifetime as */
109         float dietime;                  /* particles can die unnaturally (collision)    */
110
111         int num;                                /* index to vert/edge/face */
112         int num_dmcache;                /* index to derived mesh data (face) to avoid slow lookups */
113
114         float fuv[4], foffset;  /* coordinates on face/edge number "num" and depth along*/
115                                                         /* face normal for volume emission                                              */
116
117         float size;                             /* size and multiplier so that we can update size when ever */
118
119         int hair_index;
120         short flag;
121         short alive;                    /* the life state of a particle */
122 } ParticleData;
123
124 typedef struct SPHFluidSettings {
125         /*Particle Fluid*/
126         float radius, spring_k, rest_length;
127         float plasticity_constant, yield_ratio;
128         float plasticity_balance, yield_balance;
129         float viscosity_omega, viscosity_beta;
130         float stiffness_k, stiffness_knear, rest_density;
131         float buoyancy;
132         int flag, spring_frames;
133 } SPHFluidSettings;
134
135 /* fluid->flag */
136 #define SPH_VISCOELASTIC_SPRINGS        1
137 #define SPH_CURRENT_REST_LENGTH         2
138 #define SPH_FAC_REPULSION                       4
139 #define SPH_FAC_DENSITY                         8
140 #define SPH_FAC_RADIUS                          16
141 #define SPH_FAC_VISCOSITY                       32
142 #define SPH_FAC_REST_LENGTH                     64
143
144 typedef struct ParticleSettings {
145         ID id;
146         struct AnimData *adt;
147
148         struct BoidSettings *boids;
149         struct SPHFluidSettings *fluid;
150
151         struct EffectorWeights *effector_weights;
152
153         int flag, rt;
154         short type, from, distr, texact;
155         /* physics modes */
156         short phystype, rotmode, avemode, reactevent;
157         short draw, draw_as, draw_size, childtype;
158         short ren_as, subframes, draw_col;
159         /* number of path segments, power of 2 except */
160         short draw_step, ren_step;
161         short hair_step, keys_step;
162
163         /* adaptive path rendering */
164         short adapt_angle, adapt_pix;
165
166         short disp, omat, interpolation, rotfrom, integrator;
167         short kink, kink_axis;
168
169         /* billboards */
170         short bb_align, bb_uv_split, bb_anim, bb_split_offset;
171         float bb_tilt, bb_rand_tilt, bb_offset[2];
172
173         /* draw color */
174         float color_vec_max;
175
176         /* simplification */
177         short simplify_flag, simplify_refsize;
178         float simplify_rate, simplify_transition;
179         float simplify_viewport;
180
181         /* general values */
182         float sta, end, lifetime, randlife;
183         float timetweak, jitfac, eff_hair, grid_rand;
184         int totpart, userjit, grid_res, effector_amount;
185
186         /* initial velocity factors */
187         float normfac, obfac, randfac, partfac, tanfac, tanphase, reactfac;
188         float ob_vel[3];
189         float avefac, phasefac, randrotfac, randphasefac;
190         /* physical properties */
191         float mass, size, randsize;
192         /* global physical properties */
193         float acc[3], dragfac, brownfac, dampfac;
194         /* length */
195         float randlength;
196         /* children */
197         int child_nbr, ren_child_nbr;
198         float parents, childsize, childrandsize;
199         float childrad, childflat;
200         /* clumping */
201         float clumpfac, clumppow;
202         /* kink */
203         float kink_amp, kink_freq, kink_shape, kink_flat;
204         float kink_amp_clump;
205         /* rough */
206         float rough1, rough1_size;
207         float rough2, rough2_size, rough2_thres;
208         float rough_end, rough_end_shape;
209         /* length */
210         float clength, clength_thres;
211         /* parting */
212         float parting_fac;
213         float parting_min, parting_max;
214         /* branching */
215         float branch_thres;
216         /* drawing stuff */
217         float draw_line[2];
218         float path_start, path_end;
219         int trail_count;
220         /* keyed particles */
221         int keyed_loops;
222
223         struct MTex *mtex[18];          /* MAX_MTEX */
224
225         struct Group *dup_group;
226         struct ListBase dupliweights;
227         struct Group *eff_group;                // deprecated
228         struct Object *dup_ob;
229         struct Object *bb_ob;
230         struct Ipo *ipo;                                // xxx depreceated... old animation system
231         struct PartDeflect *pd;
232         struct PartDeflect *pd2;
233 } ParticleSettings;
234
235 typedef struct ParticleSystem{                          /* note, make sure all (runtime) are NULL's in copy_particlesystem */
236         struct ParticleSystem *next, *prev;
237
238         ParticleSettings *part;                                 /* particle settings */
239
240         ParticleData *particles;                                /* (parent) particles */
241         ChildParticle *child;                                   /* child particles */
242
243         struct PTCacheEdit *edit;                                               /* particle editmode (runtime) */
244         void (*free_edit)(struct PTCacheEdit *edit);    /* free callback */
245
246         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
247         struct ParticleCacheKey **childcache;   /* child cache (runtime) */
248         ListBase pathcachebufs, childcachebufs; /* buffers for the above */
249
250         struct ClothModifierData *clmd;                                 /* cloth simulation for hair */
251         struct DerivedMesh *hair_in_dm, *hair_out_dm;   /* input/output for cloth simulation */
252
253         struct Object *target_ob;
254         struct Object *lattice;
255         struct Object *parent;                                  /* particles from global space -> parent space */
256
257         struct ListBase targets;                                /* used for keyed and boid physics */
258
259         char name[32];                                                  /* particle system name */
260         
261         float imat[4][4];       /* used for duplicators */
262         float cfra, tree_frame, bvhtree_frame;
263         int seed, child_seed;
264         int flag, totpart, totunexist, totchild, totcached, totchildcache;
265         short recalc, target_psys, totkeyed, bakespace;
266
267         char bb_uvname[3][32];                                  /* billboard uv name */
268
269         /* if you change these remember to update array lengths to PSYS_TOT_VG! */
270         short vgroup[12], vg_neg, rt3;                  /* vertex groups, 0==disable, 1==starting index */
271
272         /* temporary storage during render */
273         void *renderdata;
274
275         /* point cache */
276         struct PointCache *pointcache;
277         struct ListBase ptcaches;
278
279         struct ListBase *effectors;
280
281         ParticleSpring *fluid_springs;
282         int tot_fluidsprings, alloc_fluidsprings;
283
284         struct KDTree *tree;                                                            /* used for interactions with self and other systems */
285         struct BVHTree *bvhtree;                                                                /* used for interactions with self and other systems */
286
287         struct ParticleDrawData *pdd;
288
289         float *frand;                                                   /* array of 1024 random floats for fast lookups */
290 }ParticleSystem;
291
292 /* part->type */
293 /* hair is allways baked static in object/geometry space */
294 /* other types (normal particles) are in global space and not static baked */
295 #define PART_EMITTER            0
296 //#define PART_REACTOR          1
297 #define PART_HAIR                       2
298 #define PART_FLUID                      3
299
300 /* part->flag */
301 #define PART_REACT_STA_END      1
302 #define PART_REACT_MULTIPLE     2
303
304 //#define PART_LOOP                     4       /* not used anymore */
305                 /* for dopesheet */
306 #define PART_DS_EXPAND          8
307
308 #define PART_HAIR_REGROW        16      /* regrow hair for each frame */
309
310 #define PART_UNBORN                     32      /*show unborn particles*/
311 #define PART_DIED                       64      /*show died particles*/
312
313 #define PART_TRAND                      128     
314 #define PART_EDISTR                     256     /* particle/face from face areas */
315
316 //#define PART_STICKY                   512     /*collided particles can stick to collider*/
317 #define PART_DIE_ON_COL         (1<<12)
318 #define PART_SIZE_DEFL          (1<<13) /* swept sphere deflections */
319 #define PART_ROT_DYN            (1<<14) /* dynamic rotation */
320 #define PART_SIZEMASS           (1<<16)
321
322 #define PART_HIDE_ADVANCED_HAIR (1<<15)
323
324 //#define PART_ABS_TIME         (1<<17)
325 //#define PART_GLOB_TIME                (1<<18)
326
327 #define PART_BOIDS_2D           (1<<19)
328
329 //#define PART_BRANCHING                (1<<20)
330 //#define PART_ANIM_BRANCHING   (1<<21)
331
332 #define PART_HAIR_BSPLINE       1024
333
334 #define PART_GRID_HEXAGONAL     (1<<24)
335 #define PART_GRID_INVERT        (1<<26)
336
337 #define PART_CHILD_EFFECT               (1<<27)
338 #define PART_CHILD_LONG_HAIR    (1<<28)
339 /* #define PART_CHILD_RENDER            (1<<29) */ /*UNUSED*/
340 #define PART_CHILD_GUIDE                (1<<30)
341
342 #define PART_SELF_EFFECT        (1<<22)
343
344 /* part->rotfrom */
345 #define PART_ROT_KEYS           0       /* interpolate directly from keys */
346 #define PART_ROT_ZINCR          1       /* same as zdir but done incrementally from previous position */
347 #define PART_ROT_IINCR          2       /* same as idir but done incrementally from previous position */
348
349 /* part->from */
350 #define PART_FROM_VERT          0
351 #define PART_FROM_FACE          1
352 #define PART_FROM_VOLUME        2
353 /* #define PART_FROM_PARTICLE   3  deprecated! */ 
354 #define PART_FROM_CHILD         4
355
356 /* part->distr */
357 #define PART_DISTR_JIT          0
358 #define PART_DISTR_RAND         1
359 #define PART_DISTR_GRID         2
360
361 /* part->phystype */
362 #define PART_PHYS_NO            0
363 #define PART_PHYS_NEWTON        1
364 #define PART_PHYS_KEYED         2
365 #define PART_PHYS_BOIDS         3
366 #define PART_PHYS_FLUID         4
367
368 /* part->kink */
369 #define PART_KINK_NO            0
370 #define PART_KINK_CURL          1
371 #define PART_KINK_RADIAL        2
372 #define PART_KINK_WAVE          3
373 #define PART_KINK_BRAID         4
374
375 /* part->draw */
376 #define PART_DRAW_VEL           1
377 #define PART_DRAW_GLOBAL_OB     2
378 #define PART_DRAW_SIZE          4
379 #define PART_DRAW_EMITTER       8       /* render emitter also */
380 #define PART_DRAW_HEALTH        16
381 #define PART_ABS_PATH_TIME  32
382 #define PART_DRAW_COUNT_GR      64
383 #define PART_DRAW_BB_LOCK       128
384 #define PART_DRAW_PARENT        256
385 #define PART_DRAW_NUM           512
386 #define PART_DRAW_RAND_GR       1024
387 #define PART_DRAW_REN_ADAPT     2048
388 #define PART_DRAW_VEL_LENGTH    (1<<12)
389 #define PART_DRAW_MAT_COL               (1<<13) /* deprecated, but used in do_versions */
390 #define PART_DRAW_WHOLE_GR              (1<<14)
391 #define PART_DRAW_REN_STRAND    (1<<15)
392
393 /* part->draw_col */
394 #define PART_DRAW_COL_NONE              0
395 #define PART_DRAW_COL_MAT               1
396 #define PART_DRAW_COL_VEL               2
397 #define PART_DRAW_COL_ACC               3
398
399
400 /* part->simplify_flag */
401 #define PART_SIMPLIFY_ENABLE    1
402 #define PART_SIMPLIFY_VIEWPORT  2
403
404 /* part->bb_align */
405 #define PART_BB_X               0
406 #define PART_BB_Y               1
407 #define PART_BB_Z               2
408 #define PART_BB_VIEW    3
409 #define PART_BB_VEL             4
410
411 /* part->bb_anim */
412 #define PART_BB_ANIM_NONE       0
413 #define PART_BB_ANIM_AGE        1
414 #define PART_BB_ANIM_ANGLE      2
415 #define PART_BB_ANIM_FRAME      3
416
417 /* part->bb_split_offset */
418 #define PART_BB_OFF_NONE        0
419 #define PART_BB_OFF_LINEAR      1
420 #define PART_BB_OFF_RANDOM      2
421
422 /* part->draw_as */
423 /* part->ren_as*/
424 #define PART_DRAW_NOT           0
425 #define PART_DRAW_DOT           1
426 #define PART_DRAW_HALO          1
427 #define PART_DRAW_CIRC          2
428 #define PART_DRAW_CROSS         3
429 #define PART_DRAW_AXIS          4
430 #define PART_DRAW_LINE          5
431 #define PART_DRAW_PATH          6
432 #define PART_DRAW_OB            7
433 #define PART_DRAW_GR            8
434 #define PART_DRAW_BB            9
435 #define PART_DRAW_REND          10
436
437 /* part->integrator */
438 #define PART_INT_EULER          0
439 #define PART_INT_MIDPOINT       1
440 #define PART_INT_RK4            2
441 #define PART_INT_VERLET         3
442
443 /* part->rotmode */
444 #define PART_ROT_NOR            1
445 #define PART_ROT_VEL            2
446 #define PART_ROT_GLOB_X         3
447 #define PART_ROT_GLOB_Y         4
448 #define PART_ROT_GLOB_Z         5
449 #define PART_ROT_OB_X           6
450 #define PART_ROT_OB_Y           7
451 #define PART_ROT_OB_Z           8
452
453 /* part->avemode */
454 #define PART_AVE_SPIN           1
455 #define PART_AVE_RAND           2
456
457 /* part->reactevent */
458 #define PART_EVENT_DEATH        0
459 #define PART_EVENT_COLLIDE      1
460 #define PART_EVENT_NEAR         2
461
462 /* part->childtype */
463 #define PART_CHILD_PARTICLES    1
464 #define PART_CHILD_FACES                2
465
466 /* psys->recalc */
467 /* starts from 8 so that the first bits can be ob->recalc */
468 #define PSYS_RECALC_REDO        8       /* only do pathcache etc */
469 #define PSYS_RECALC_RESET       16      /* reset everything including pointcache */
470 #define PSYS_RECALC_TYPE        32      /* handle system type change */
471 #define PSYS_RECALC_CHILD       64      /* only child settings changed */
472 #define PSYS_RECALC_PHYS        128     /* physics type changed */
473 #define PSYS_RECALC                     248
474
475 /* psys->flag */
476 #define PSYS_CURRENT            1
477 #define PSYS_GLOBAL_HAIR        2
478 #define PSYS_HAIR_DYNAMICS      4
479 #define PSYS_KEYED_TIMING       8
480 #define PSYS_ENABLED            16      /* deprecated */
481 #define PSYS_HAIR_UPDATED       32  /* signal for updating hair particle mode */
482 #define PSYS_DRAWING            64
483 #define PSYS_USE_IMAT           128
484 #define PSYS_DELETE                     256     /* remove particlesystem as soon as possible */
485 #define PSYS_HAIR_DONE          512
486 #define PSYS_KEYED                      1024
487 #define PSYS_EDITED                     2048
488 //#define PSYS_PROTECT_CACHE    4096 /* deprecated */
489 #define PSYS_DISABLED           8192
490
491 /* pars->flag */
492 #define PARS_UNEXIST            1
493 #define PARS_NO_DISP            2
494 //#define PARS_STICKY                   4 /* deprecated */
495 #define PARS_REKEY                      8
496
497 /* pars->alive */
498 //#define PARS_KILLED                   0 /* deprecated */
499 #define PARS_DEAD                       1
500 #define PARS_UNBORN                     2
501 #define PARS_ALIVE                      3
502 #define PARS_DYING                      4
503
504 /* ParticleDupliWeight->flag */
505 #define PART_DUPLIW_CURRENT     1
506
507 /* psys->vg */
508 #define PSYS_TOT_VG                     12
509
510 #define PSYS_VG_DENSITY         0
511 #define PSYS_VG_VEL                     1
512 #define PSYS_VG_LENGTH          2
513 #define PSYS_VG_CLUMP           3
514 #define PSYS_VG_KINK            4
515 #define PSYS_VG_ROUGH1          5
516 #define PSYS_VG_ROUGH2          6
517 #define PSYS_VG_ROUGHE          7
518 #define PSYS_VG_SIZE            8
519 #define PSYS_VG_TAN                     9
520 #define PSYS_VG_ROT                     10
521 #define PSYS_VG_EFFECTOR        11
522
523 /* ParticleTarget->flag */
524 #define PTARGET_CURRENT         1
525 #define PTARGET_VALID           2
526
527 /* ParticleTarget->mode */
528 #define PTARGET_MODE_NEUTRAL    0
529 #define PTARGET_MODE_FRIEND             1
530 #define PTARGET_MODE_ENEMY              2
531
532 /* mapto */
533 /* init */
534 #define PAMAP_INIT              15
535 #define PAMAP_TIME              (1<<0)  /* emission time */
536 #define PAMAP_LIFE              (1<<1)  /* life time */
537 #define PAMAP_DENS              (1<<2)  /* density */
538 #define PAMAP_SIZE              (1<<3)  /* physical size */
539 /* reset */
540 #define PAMAP_IVEL              (1<<5)  /* initial velocity */
541 /* physics */
542 #define PAMAP_PHYSICS   3136
543 #define PAMAP_FIELD             (1<<6)  /* force fields */
544 #define PAMAP_GRAVITY   (1<<10)
545 #define PAMAP_DAMP              (1<<11)
546 /* children */
547 #define PAMAP_CHILD             912
548 #define PAMAP_CLUMP             (1<<7)
549 #define PAMAP_KINK              (1<<8)
550 #define PAMAP_ROUGH             (1<<9)
551 #define PAMAP_LENGTH    (1<<4)
552
553 #endif