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