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