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