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