Spiral kink mode for particles.
[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         /* rough */
222         float rough1, rough1_size;
223         float rough2, rough2_size, rough2_thres;
224         float rough_end, rough_end_shape;
225         /* length */
226         float clength, clength_thres;
227         /* parting */
228         float parting_fac;
229         float parting_min, parting_max;
230         /* branching */
231         float branch_thres;
232         /* drawing stuff */
233         float draw_line[2];
234         float path_start, path_end;
235         int trail_count;
236         /* keyed particles */
237         int keyed_loops;
238         struct CurveMapping *clumpcurve;
239         struct CurveMapping *roughcurve;
240         float clump_noise_size;
241
242         /* hair dynamics */
243         float bending_random;
244
245         struct MTex *mtex[18];          /* MAX_MTEX */
246
247         struct Group *dup_group;
248         struct ListBase dupliweights;
249         struct Group *eff_group  DNA_DEPRECATED;                // deprecated
250         struct Object *dup_ob;
251         struct Object *bb_ob;
252         struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
253         struct PartDeflect *pd;
254         struct PartDeflect *pd2;
255
256         /* modified dm support */
257         short use_modifier_stack;
258         short pad[3];
259
260 } ParticleSettings;
261
262 typedef struct ParticleSystem {
263         /* note1: make sure all (runtime) are NULL's in 'copy_particlesystem' XXX, this function is no more! - need to invstigate */
264         /* note2: make sure any uses of this struct in DNA are accounted for in 'BKE_object_copy_particlesystems' */
265
266         struct ParticleSystem *next, *prev;
267
268         ParticleSettings *part;                                 /* particle settings */
269
270         ParticleData *particles;                                /* (parent) particles */
271         ChildParticle *child;                                   /* child particles */
272
273         struct PTCacheEdit *edit;                                               /* particle editmode (runtime) */
274         void (*free_edit)(struct PTCacheEdit *edit);    /* free callback */
275
276         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
277         struct ParticleCacheKey **childcache;   /* child cache (runtime) */
278         ListBase pathcachebufs, childcachebufs; /* buffers for the above */
279
280         struct ClothModifierData *clmd;                                 /* cloth simulation for hair */
281         struct DerivedMesh *hair_in_dm, *hair_out_dm;   /* input/output for cloth simulation */
282
283         struct Object *target_ob;
284
285         struct LatticeDeformData *lattice_deform_data;          /* run-time only lattice deformation data */
286
287         struct Object *parent;                                  /* particles from global space -> parent space */
288
289         struct ListBase targets;                                /* used for keyed and boid physics */
290
291         char name[64];                                                  /* particle system name, MAX_NAME */
292         
293         float imat[4][4];       /* used for duplicators */
294         float cfra, tree_frame, bvhtree_frame;
295         int seed, child_seed;
296         int flag, totpart, totunexist, totchild, totcached, totchildcache;
297         short recalc, target_psys, totkeyed, bakespace;
298
299         char bb_uvname[3][64];                                  /* billboard uv name, MAX_CUSTOMDATA_LAYER_NAME */
300
301         /* if you change these remember to update array lengths to PSYS_TOT_VG! */
302         short vgroup[12], vg_neg, rt3;                  /* vertex groups, 0==disable, 1==starting index */
303
304         /* temporary storage during render */
305         struct ParticleRenderData *renderdata;
306
307         /* point cache */
308         struct PointCache *pointcache;
309         struct ListBase ptcaches;
310
311         struct ListBase *effectors;
312
313         ParticleSpring *fluid_springs;
314         int tot_fluidsprings, alloc_fluidsprings;
315
316         struct KDTree *tree;                                    /* used for interactions with self and other systems */
317         struct BVHTree *bvhtree;                                /* used for interactions with self and other systems */
318
319         struct ParticleDrawData *pdd;
320
321         float dt_frac;                                                  /* current time step, as a fraction of a frame */
322         float _pad;                                                             /* spare capacity */
323 } ParticleSystem;
324
325 typedef enum eParticleDrawFlag {
326         PART_DRAW_VEL           = (1 << 0),
327         PART_DRAW_GLOBAL_OB         = (1 << 1),
328         PART_DRAW_SIZE          = (1 << 2),
329         PART_DRAW_EMITTER       = (1 << 3), /* render emitter also */
330         PART_DRAW_HEALTH        = (1 << 4),
331         PART_ABS_PATH_TIME      = (1 << 5),
332         PART_DRAW_COUNT_GR      = (1 << 6),
333         PART_DRAW_BB_LOCK       = (1 << 7), /* used with billboards */
334         PART_DRAW_ROTATE_OB     = (1 << 7), /* used with dupliobjects/groups */
335         PART_DRAW_PARENT        = (1 << 8),
336         PART_DRAW_NUM           = (1 << 9),
337         PART_DRAW_RAND_GR       = (1 << 10),
338         PART_DRAW_REN_ADAPT     = (1 << 11),
339         PART_DRAW_VEL_LENGTH    = (1 << 12),
340         PART_DRAW_MAT_COL       = (1 << 13), /* deprecated, but used in do_versions */
341         PART_DRAW_WHOLE_GR      = (1 << 14),
342         PART_DRAW_REN_STRAND    = (1 << 15),
343         PART_DRAW_NO_SCALE_OB   = (1 << 16), /* used with dupliobjects/groups */
344         PART_DRAW_GUIDE_HAIRS   = (1 << 17),
345         PART_DRAW_HAIR_GRID     = (1 << 18),
346 } eParticleDrawFlag;
347
348 /* part->type */
349 /* hair is allways baked static in object/geometry space */
350 /* other types (normal particles) are in global space and not static baked */
351 #define PART_EMITTER            0
352 //#define PART_REACTOR          1
353 #define PART_HAIR                       2
354 #define PART_FLUID                      3
355
356 /* part->flag */
357 #define PART_REACT_STA_END      1
358 #define PART_REACT_MULTIPLE     2
359
360 //#define PART_LOOP                     4       /* not used anymore */
361                 /* for dopesheet */
362 #define PART_DS_EXPAND          8
363
364 #define PART_HAIR_REGROW        16      /* regrow hair for each frame */
365
366 #define PART_UNBORN                     32      /*show unborn particles*/
367 #define PART_DIED                       64      /*show died particles*/
368
369 #define PART_TRAND                      128     
370 #define PART_EDISTR                     256     /* particle/face from face areas */
371
372 #define PART_ROTATIONS          512     /* calculate particle rotations (and store them in pointcache) */
373 #define PART_DIE_ON_COL         (1<<12)
374 #define PART_SIZE_DEFL          (1<<13) /* swept sphere deflections */
375 #define PART_ROT_DYN            (1<<14) /* dynamic rotation */
376 #define PART_SIZEMASS           (1<<16)
377
378 #define PART_HIDE_ADVANCED_HAIR (1<<15)
379
380 //#define PART_ABS_TIME         (1<<17)
381 //#define PART_GLOB_TIME                (1<<18)
382
383 #define PART_BOIDS_2D           (1<<19)
384
385 //#define PART_BRANCHING                (1<<20)
386 //#define PART_ANIM_BRANCHING   (1<<21)
387
388 #define PART_HAIR_BSPLINE       1024
389
390 #define PART_GRID_HEXAGONAL     (1<<24)
391 #define PART_GRID_INVERT        (1<<26)
392
393 #define PART_CHILD_EFFECT               (1<<27)
394 #define PART_CHILD_LONG_HAIR    (1<<28)
395 /* #define PART_CHILD_RENDER            (1<<29) */ /*UNUSED*/
396 #define PART_CHILD_GUIDE                (1<<30)
397
398 #define PART_SELF_EFFECT        (1<<22)
399
400 /* part->from */
401 #define PART_FROM_VERT          0
402 #define PART_FROM_FACE          1
403 #define PART_FROM_VOLUME        2
404 /* #define PART_FROM_PARTICLE   3  deprecated! */ 
405 #define PART_FROM_CHILD         4
406
407 /* part->distr */
408 #define PART_DISTR_JIT          0
409 #define PART_DISTR_RAND         1
410 #define PART_DISTR_GRID         2
411
412 /* part->phystype */
413 #define PART_PHYS_NO            0
414 #define PART_PHYS_NEWTON        1
415 #define PART_PHYS_KEYED         2
416 #define PART_PHYS_BOIDS         3
417 #define PART_PHYS_FLUID         4
418
419 /* part->kink */
420 typedef enum eParticleKink {
421         PART_KINK_NO            = 0,
422         PART_KINK_CURL          = 1,
423         PART_KINK_RADIAL        = 2,
424         PART_KINK_WAVE          = 3,
425         PART_KINK_BRAID         = 4,
426         PART_KINK_SPIRAL        = 5,
427 } eParticleKink;
428
429 /* part->kink_flag */
430 typedef enum eParticleChildFlag {
431         PART_CHILD_USE_CLUMP_NOISE  = 1,
432 } eParticleChildFlag;
433
434 /* part->draw_col */
435 #define PART_DRAW_COL_NONE              0
436 #define PART_DRAW_COL_MAT               1
437 #define PART_DRAW_COL_VEL               2
438 #define PART_DRAW_COL_ACC               3
439
440
441 /* part->simplify_flag */
442 #define PART_SIMPLIFY_ENABLE    1
443 #define PART_SIMPLIFY_VIEWPORT  2
444
445 /* part->time_flag */
446 #define PART_TIME_AUTOSF        1 /* Automatic subframes */
447
448 /* part->bb_align */
449 #define PART_BB_X               0
450 #define PART_BB_Y               1
451 #define PART_BB_Z               2
452 #define PART_BB_VIEW    3
453 #define PART_BB_VEL             4
454
455 /* part->bb_anim */
456 #define PART_BB_ANIM_NONE       0
457 #define PART_BB_ANIM_AGE        1
458 #define PART_BB_ANIM_ANGLE      2
459 #define PART_BB_ANIM_FRAME      3
460
461 /* part->bb_split_offset */
462 #define PART_BB_OFF_NONE        0
463 #define PART_BB_OFF_LINEAR      1
464 #define PART_BB_OFF_RANDOM      2
465
466 /* part->draw_as */
467 /* part->ren_as*/
468 #define PART_DRAW_NOT           0
469 #define PART_DRAW_DOT           1
470 #define PART_DRAW_HALO          1
471 #define PART_DRAW_CIRC          2
472 #define PART_DRAW_CROSS         3
473 #define PART_DRAW_AXIS          4
474 #define PART_DRAW_LINE          5
475 #define PART_DRAW_PATH          6
476 #define PART_DRAW_OB            7
477 #define PART_DRAW_GR            8
478 #define PART_DRAW_BB            9
479 #define PART_DRAW_REND          10
480
481 /* part->integrator */
482 #define PART_INT_EULER          0
483 #define PART_INT_MIDPOINT       1
484 #define PART_INT_RK4            2
485 #define PART_INT_VERLET         3
486
487 /* part->rotmode */
488 #define PART_ROT_NOR            1
489 #define PART_ROT_VEL            2
490 #define PART_ROT_GLOB_X         3
491 #define PART_ROT_GLOB_Y         4
492 #define PART_ROT_GLOB_Z         5
493 #define PART_ROT_OB_X           6
494 #define PART_ROT_OB_Y           7
495 #define PART_ROT_OB_Z           8
496 #define PART_ROT_NOR_TAN        9
497
498 /* part->avemode */
499 #define PART_AVE_VELOCITY       1
500 #define PART_AVE_RAND           2
501 #define PART_AVE_HORIZONTAL     3
502 #define PART_AVE_VERTICAL       4
503 #define PART_AVE_GLOBAL_X       5
504 #define PART_AVE_GLOBAL_Y       6
505 #define PART_AVE_GLOBAL_Z       7
506
507 /* part->reactevent */
508 #define PART_EVENT_DEATH        0
509 #define PART_EVENT_COLLIDE      1
510 #define PART_EVENT_NEAR         2
511
512 /* part->childtype */
513 #define PART_CHILD_PARTICLES    1
514 #define PART_CHILD_FACES                2
515
516 /* psys->recalc */
517 /* starts from (1 << 3) so that the first bits can be ob->recalc */
518 #define PSYS_RECALC_REDO   (1 << 3) /* only do pathcache etc */
519 #define PSYS_RECALC_RESET  (1 << 4) /* reset everything including pointcache */
520 #define PSYS_RECALC_TYPE   (1 << 5) /* handle system type change */
521 #define PSYS_RECALC_CHILD  (1 << 6) /* only child settings changed */
522 #define PSYS_RECALC_PHYS   (1 << 7) /* physics type changed */
523 #define PSYS_RECALC        (PSYS_RECALC_REDO | PSYS_RECALC_RESET | PSYS_RECALC_TYPE | PSYS_RECALC_CHILD | PSYS_RECALC_PHYS)
524
525 /* psys->flag */
526 #define PSYS_CURRENT            1
527 #define PSYS_GLOBAL_HAIR        2
528 #define PSYS_HAIR_DYNAMICS      4
529 #define PSYS_KEYED_TIMING       8
530 //#define PSYS_ENABLED          16      /* deprecated */
531 #define PSYS_HAIR_UPDATED       32  /* signal for updating hair particle mode */
532 #define PSYS_DRAWING            64
533 #define PSYS_USE_IMAT           128
534 #define PSYS_DELETE                     256     /* remove particlesystem as soon as possible */
535 #define PSYS_HAIR_DONE          512
536 #define PSYS_KEYED                      1024
537 #define PSYS_EDITED                     2048
538 //#define PSYS_PROTECT_CACHE    4096 /* deprecated */
539 #define PSYS_DISABLED                   8192
540 #define PSYS_OB_ANIM_RESTORE    16384 /* runtime flag */
541
542 /* pars->flag */
543 #define PARS_UNEXIST            1
544 #define PARS_NO_DISP            2
545 //#define PARS_STICKY                   4 /* deprecated */
546 #define PARS_REKEY                      8
547
548 /* pars->alive */
549 //#define PARS_KILLED                   0 /* deprecated */
550 #define PARS_DEAD                       1
551 #define PARS_UNBORN                     2
552 #define PARS_ALIVE                      3
553 #define PARS_DYING                      4
554
555 /* ParticleDupliWeight->flag */
556 #define PART_DUPLIW_CURRENT     1
557
558 /* psys->vg */
559 #define PSYS_TOT_VG                     12
560
561 #define PSYS_VG_DENSITY         0
562 #define PSYS_VG_VEL                     1
563 #define PSYS_VG_LENGTH          2
564 #define PSYS_VG_CLUMP           3
565 #define PSYS_VG_KINK            4
566 #define PSYS_VG_ROUGH1          5
567 #define PSYS_VG_ROUGH2          6
568 #define PSYS_VG_ROUGHE          7
569 #define PSYS_VG_SIZE            8
570 #define PSYS_VG_TAN                     9
571 #define PSYS_VG_ROT                     10
572 #define PSYS_VG_EFFECTOR        11
573
574 /* ParticleTarget->flag */
575 #define PTARGET_CURRENT         1
576 #define PTARGET_VALID           2
577
578 /* ParticleTarget->mode */
579 #define PTARGET_MODE_NEUTRAL    0
580 #define PTARGET_MODE_FRIEND             1
581 #define PTARGET_MODE_ENEMY              2
582
583 /* mapto */
584 /* init */
585 #define PAMAP_INIT              (PAMAP_TIME | PAMAP_LIFE | PAMAP_DENS | PAMAP_SIZE)
586 #define PAMAP_TIME              (1<<0)  /* emission time */
587 #define PAMAP_LIFE              (1<<1)  /* life time */
588 #define PAMAP_DENS              (1<<2)  /* density */
589 #define PAMAP_SIZE              (1<<3)  /* physical size */
590 /* reset */
591 #define PAMAP_IVEL              (1<<5)  /* initial velocity */
592 /* physics */
593 #define PAMAP_PHYSICS   (PAMAP_FIELD | PAMAP_GRAVITY | PAMAP_DAMP)
594 #define PAMAP_FIELD             (1<<6)  /* force fields */
595 #define PAMAP_GRAVITY   (1<<10)
596 #define PAMAP_DAMP              (1<<11)
597 /* children */
598 #define PAMAP_CHILD             (PAMAP_CLUMP | PAMAP_KINK | PAMAP_ROUGH | PAMAP_LENGTH)
599 #define PAMAP_CLUMP             (1<<7)
600 #define PAMAP_KINK              (1<<8)
601 #define PAMAP_ROUGH             (1<<9)
602 #define PAMAP_LENGTH    (1<<4)
603
604 #endif