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