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