A bunch of fun stuff now possible because of new pointcache code:
[blender.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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
37 struct AnimData;
38
39 typedef struct HairKey {
40         float co[3];    /* location of hair vertex */
41         float time;             /* time along hair, default 0-100 */
42         float weight;   /* softbody weight */
43         short editflag; /* saved particled edit mode flags */
44         short pad;
45 } HairKey;
46
47 typedef struct ParticleKey {    /* when changed update size of struct to copy_particleKey()!! */
48         float co[3];    /* location */
49         float vel[3];   /* velocity */
50         float rot[4];   /* rotation quaternion */
51         float ave[3];   /* angular velocity */
52         float time;             /* when this key happens */
53 } ParticleKey;
54
55 /* Child particles are created around or between parent particles */
56 typedef struct ChildParticle {
57         int num, parent;        /* num is face index on the final derived mesh */
58         int pa[4];                      /* nearest particles to the child, used for the interpolation */
59         float w[4];                     /* interpolation weights for the above particles */
60         float fuv[4], foffset; /* face vertex weights and offset */
61         float rand[3];
62 } ChildParticle;
63
64 /* Everything that's non dynamic for a particle:                        */
65 typedef struct ParticleData {
66         struct Object *stick_ob;/* object that particle sticks to when dead */
67
68         ParticleKey state;              /* normally current global coordinates or       */
69                                                         /* in sticky object space if dead & sticky      */
70
71         ParticleKey prev_state; /* previous state */
72
73         HairKey *hair;                  /* hair vertices */
74
75         ParticleKey *keys;              /* keyed states */
76
77         float i_rot[4],r_rot[4];/* initial & random values (i_rot should be removed as it's not used anymore)*/
78         float r_ave[3],r_ve[3];
79
80         float fuv[4], foffset;  /* coordinates on face/edge number "num" and depth along*/
81                                                         /* face normal for volume emission                                              */
82
83         float time, lifetime;   /* dietime is not nescessarily time+lifetime as */
84         float dietime;                  /* particles can die unnaturally (collision)    */
85
86         float bank;                             /* banking angle for boids */
87
88         float size, sizemul;    /* size and multiplier so that we can update size when ever */
89
90         int num;                                /* index to vert/edge/face */
91         int num_dmcache;                /* index to derived mesh data (face) to avoid slow lookups */
92         int pad;
93
94         int totkey;
95         int bpi;                                /* softbody body point start index */
96
97         short flag;
98         short alive;                            /* the life state of a particle */
99         short loop;                             /* how many times particle life has looped */
100         short rt2;
101 } ParticleData;
102
103 typedef struct ParticleSettings {
104         ID id;
105         struct AnimData *adt;
106
107         int flag;
108         short type, from, distr;
109         /* physics modes */
110         short phystype, rotmode, avemode, reactevent;
111         short draw, draw_as, draw_size, childtype;
112         short ren_as, rt2[3];
113         /* number of path segments, power of 2 except */
114         short draw_step, ren_step;
115         short hair_step, keys_step;
116
117         /* adaptive path rendering */
118         short adapt_angle, adapt_pix;
119
120         short disp, omat, interpolation, rotfrom, integrator;
121         short kink, kink_axis, nbetween, boidneighbours;
122
123         /* billboards */
124         short bb_align, bb_uv_split, bb_anim, bb_split_offset;
125         float bb_tilt, bb_rand_tilt, bb_offset[2];
126
127         /* simplification */
128         short simplify_flag, simplify_refsize;
129         float simplify_rate, simplify_transition;
130         float simplify_viewport;
131
132         /* general values */
133         float sta, end, lifetime, randlife;
134         float timetweak, jitfac, keyed_time, eff_hair;
135         int totpart, userjit, grid_res;
136
137         /* initial velocity factors */
138         float normfac, obfac, randfac, partfac, tanfac, tanphase, reactfac;
139         float avefac, phasefac, randrotfac, randphasefac;
140         /* physical properties */
141         float mass, size, randsize, reactshape;
142         /* global physical properties */
143         float acc[3], dragfac, brownfac, dampfac;
144         /* length */
145         float length, abslength, randlength;
146         /* children */
147         int child_nbr, ren_child_nbr;
148         float parents, childsize, childrandsize;
149         float childrad, childflat, childspread;
150         /* clumping */
151         float clumpfac, clumppow;
152         /* kink */
153         float kink_amp, kink_freq, kink_shape;
154         /* rough */
155         float rough1, rough1_size;
156         float rough2, rough2_size, rough2_thres;
157         float rough_end, rough_end_shape;
158         /* branching */
159         float branch_thres;
160         /* drawing stuff */
161         float draw_line[2];
162         float path_start, path_end;
163         int trail_count;
164
165         /* boids */
166         float max_vel, max_lat_acc, max_tan_acc;
167         float average_vel, banking, max_bank, groundz;
168         float boidfac[8];
169         char boidrule[8];
170
171         struct Group *dup_group;
172         struct Group *eff_group;
173         struct Object *dup_ob;
174         struct Object *bb_ob;
175         struct Ipo *ipo;                                // xxx depreceated... old animation system
176         struct PartDeflect *pd;
177         struct PartDeflect *pd2;
178 } ParticleSettings;
179
180 typedef struct ParticleSystem{                          /* note, make sure all (runtime) are NULL's in copy_particlesystem */
181         struct ParticleSystem *next, *prev;
182
183         ParticleSettings *part;                                 /* particle settings */
184
185         ParticleData *particles;                                /* (parent) particles */
186         ChildParticle *child;                                   /* child particles */
187
188         struct ParticleEdit *edit;                                              /* particle editmode (runtime) */
189         void (*free_edit)(struct ParticleSystem *sys);  /* free callback */
190
191         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
192         struct ParticleCacheKey **childcache;   /* child cache (runtime) */
193         ListBase pathcachebufs, childcachebufs; /* buffers for the above */
194
195         struct SoftBody *soft;                                  /* hair softbody */
196
197         struct Object *target_ob;
198         struct Object *keyed_ob;
199         struct Object *lattice;
200         struct Object *parent;                                  /* particles from global space -> parent space */
201
202         struct ListBase effectors, reactevents; /* runtime */
203         
204         float imat[4][4];       /* used for duplicators */
205         float cfra;
206         int seed;
207         int flag, totpart, totchild, totcached, totchildcache, rt;
208         short recalc, target_psys, keyed_psys, totkeyed, softflag, bakespace;
209
210         char bb_uvname[3][32];                                  /* billboard uv name */
211
212         /* if you change these remember to update array lengths to PSYS_TOT_VG! */
213         short vgroup[12], vg_neg, rt3;                  /* vertex groups */
214
215         /* temporary storage during render */
216         void *renderdata;
217
218         /* point cache */
219         struct PointCache *pointcache;
220 }ParticleSystem;
221
222 /* general particle maximums */
223 /* no special why's, just seem reasonable */
224 /* changing these (atleast upwards) should not cause any major problems */
225 #define MAX_PARTS                       100000  /* real particles/system */
226 #define MAX_PART_CHILDREN       10000   /* child particles/real particles */
227 #define MAX_BOIDNEIGHBOURS      10              /* neigbours considered/boid */
228
229 /* part->type */
230 /* hair is allways baked static in object/geometry space */
231 /* other types (normal particles) are in global space and not static baked */
232 #define PART_EMITTER            0
233 #define PART_REACTOR            1
234 #define PART_HAIR                       2
235 #define PART_FLUID                      3
236
237 /* part->flag */
238 #define PART_REACT_STA_END      1
239 #define PART_REACT_MULTIPLE     2
240
241 #define PART_LOOP                       4
242 //#define PART_LOOP_INSTANT     8
243
244 #define PART_HAIR_GEOMETRY      16
245
246 #define PART_UNBORN                     32      /*show unborn particles*/
247 #define PART_DIED                       64      /*show died particles*/
248
249 #define PART_TRAND                      128     
250 #define PART_EDISTR                     256     /* particle/face from face areas */
251
252 #define PART_STICKY                     512     /*collided particles can stick to collider*/
253 #define PART_DIE_ON_COL         (1<<12)
254 #define PART_SIZE_DEFL          (1<<13) /* swept sphere deflections */
255 #define PART_ROT_DYN            (1<<14) /* dynamic rotation */
256 #define PART_SIZEMASS           (1<<16)
257
258 #define PART_ABS_LENGTH         (1<<15)
259
260 #define PART_ABS_TIME           (1<<17)
261 #define PART_GLOB_TIME          (1<<18)
262
263 #define PART_BOIDS_2D           (1<<19)
264
265 #define PART_BRANCHING          (1<<20)
266 #define PART_ANIM_BRANCHING     (1<<21)
267 #define PART_SYMM_BRANCHING     (1<<24)
268
269 #define PART_HAIR_BSPLINE       1024
270
271 #define PART_GRID_INVERT        (1<<26)
272
273 #define PART_CHILD_EFFECT       (1<<27)
274 #define PART_CHILD_SEAMS        (1<<28)
275 #define PART_CHILD_RENDER       (1<<29)
276 #define PART_CHILD_GUIDE        (1<<30)
277
278 #define PART_SELF_EFFECT        (1<<22)
279
280 /* part->rotfrom */
281 #define PART_ROT_KEYS           0       /* interpolate directly from keys */
282 #define PART_ROT_ZINCR          1       /* same as zdir but done incrementally from previous position */
283 #define PART_ROT_IINCR          2       /* same as idir but done incrementally from previous position */
284
285 /* part->from */
286 #define PART_FROM_VERT          0
287 #define PART_FROM_FACE          1
288 #define PART_FROM_VOLUME        2
289 #define PART_FROM_PARTICLE      3
290 #define PART_FROM_CHILD         4
291
292 /* part->distr */
293 #define PART_DISTR_JIT          0
294 #define PART_DISTR_RAND         1
295 #define PART_DISTR_GRID         2
296
297 /* part->phystype */
298 #define PART_PHYS_NO            0
299 #define PART_PHYS_NEWTON        1
300 #define PART_PHYS_KEYED         2
301 #define PART_PHYS_BOIDS         3
302
303 /* part->kink */
304 #define PART_KINK_NO            0
305 #define PART_KINK_CURL          1
306 #define PART_KINK_RADIAL        2
307 #define PART_KINK_WAVE          3
308 #define PART_KINK_BRAID         4
309
310 /* part->draw */
311 #define PART_DRAW_VEL           1
312 //#define PART_DRAW_PATH_LEN    2
313 #define PART_DRAW_SIZE          4
314 #define PART_DRAW_EMITTER       8       /* render emitter also */
315 //#define PART_DRAW_HEALTH      16
316 #define PART_ABS_PATH_TIME  32
317 //#define PART_DRAW_TRAIL               64
318 #define PART_DRAW_BB_LOCK       128
319 #define PART_DRAW_PARENT        256
320 #define PART_DRAW_NUM           512
321 #define PART_DRAW_RAND_GR       1024
322 #define PART_DRAW_REN_ADAPT     2048
323 #define PART_DRAW_VEL_LENGTH    (1<<12)
324 #define PART_DRAW_MAT_COL               (1<<13)
325 #define PART_DRAW_WHOLE_GR              (1<<14)
326 #define PART_DRAW_REN_STRAND    (1<<15)
327
328 /* part->simplify_flag */
329 #define PART_SIMPLIFY_ENABLE    1
330 #define PART_SIMPLIFY_VIEWPORT  2
331
332 /* part->bb_align */
333 #define PART_BB_X               0
334 #define PART_BB_Y               1
335 #define PART_BB_Z               2
336 #define PART_BB_VIEW    3
337 #define PART_BB_VEL             4
338
339 /* part->bb_anim */
340 #define PART_BB_ANIM_NONE       0
341 #define PART_BB_ANIM_TIME       1
342 #define PART_BB_ANIM_ANGLE      2
343 #define PART_BB_ANIM_OFF_TIME   3
344 #define PART_BB_ANIM_OFF_ANGLE  4
345
346 /* part->bb_split_offset */
347 #define PART_BB_OFF_NONE        0
348 #define PART_BB_OFF_LINEAR      1
349 #define PART_BB_OFF_RANDOM      2
350
351 /* part->draw_as */
352 /* part->ren_as*/
353 #define PART_DRAW_NOT           0
354 #define PART_DRAW_DOT           1
355 #define PART_DRAW_HALO          1
356 #define PART_DRAW_CIRC          2
357 #define PART_DRAW_CROSS         3
358 #define PART_DRAW_AXIS          4
359 #define PART_DRAW_LINE          5
360 #define PART_DRAW_PATH          6
361 #define PART_DRAW_OB            7
362 #define PART_DRAW_GR            8
363 #define PART_DRAW_BB            9
364 #define PART_DRAW_REND          10
365
366 /* part->integrator */
367 #define PART_INT_EULER          0
368 #define PART_INT_MIDPOINT       1
369 #define PART_INT_RK4            2
370
371 /* part->rotmode */
372 #define PART_ROT_NOR            1
373 #define PART_ROT_VEL            2
374 #define PART_ROT_GLOB_X         3
375 #define PART_ROT_GLOB_Y         4
376 #define PART_ROT_GLOB_Z         5
377 #define PART_ROT_OB_X           6
378 #define PART_ROT_OB_Y           7
379 #define PART_ROT_OB_Z           8
380
381 /* part->avemode */
382 #define PART_AVE_SPIN           1
383 #define PART_AVE_RAND           2
384
385 /* part->reactevent */
386 #define PART_EVENT_DEATH        0
387 #define PART_EVENT_COLLIDE      1
388 #define PART_EVENT_NEAR         2
389
390 /* part->childtype */
391 #define PART_CHILD_PARTICLES    1
392 #define PART_CHILD_FACES                2
393
394 /* psys->recalc */
395 #define PSYS_RECALC_REDO        1       /* only do pathcache etc */
396 #define PSYS_RECALC_RESET       2       /* reset everything including pointcache */
397 #define PSYS_RECALC_TYPE        4       /* handle system type change */
398 #define PSYS_RECALC_CHILD       16      /* only child settings changed */
399
400 /* psys->flag */
401 #define PSYS_CURRENT            1
402 //#define PSYS_BAKING                   2
403 //#define PSYS_BAKE_UI          4
404 #define PSYS_KEYED_TIME         8
405 #define PSYS_ENABLED            16      /* deprecated */
406 #define PSYS_FIRST_KEYED        32
407 #define PSYS_DRAWING            64
408 //#define PSYS_SOFT_BAKE                128
409 #define PSYS_DELETE                     256     /* remove particlesystem as soon as possible */
410 #define PSYS_HAIR_DONE          512
411 #define PSYS_KEYED                      1024
412 #define PSYS_EDITED                     2048
413 //#define PSYS_PROTECT_CACHE    4096
414 #define PSYS_DISABLED           8192
415
416 /* pars->flag */
417 #define PARS_UNEXIST            1
418 #define PARS_NO_DISP            2
419 #define PARS_STICKY                     4
420 #define PARS_TRANSFORM          8
421 #define PARS_HIDE                       16
422 #define PARS_TAG                        32
423 #define PARS_REKEY                      64
424 #define PARS_EDIT_RECALC        128
425
426 /* pars->alive */
427 #define PARS_KILLED                     0
428 #define PARS_DEAD                       1
429 #define PARS_UNBORN                     2
430 #define PARS_ALIVE                      3
431 #define PARS_DYING                      4
432
433 /* psys->vg */
434 #define PSYS_TOT_VG                     12
435
436 #define PSYS_VG_DENSITY         0
437 #define PSYS_VG_VEL                     1
438 #define PSYS_VG_LENGTH          2
439 #define PSYS_VG_CLUMP           3
440 #define PSYS_VG_KINK            4
441 #define PSYS_VG_ROUGH1          5
442 #define PSYS_VG_ROUGH2          6
443 #define PSYS_VG_ROUGHE          7
444 #define PSYS_VG_SIZE            8
445 #define PSYS_VG_TAN                     9
446 #define PSYS_VG_ROT                     10
447 #define PSYS_VG_EFFECTOR        11
448
449 /* part->boidrules */
450 #define BOID_TOT_RULES          8
451
452 #define BOID_COLLIDE            0
453 #define BOID_AVOID                      1
454 #define BOID_CROWD                      2
455 #define BOID_CENTER                     3
456 #define BOID_AV_VEL                     4
457 #define BOID_VEL_MATCH          5
458 #define BOID_GOAL                       6
459 #define BOID_LEVEL                      7
460
461
462 //#define PSYS_INTER_CUBIC      0
463 //#define PSYS_INTER_LINEAR     1
464 //#define PSYS_INTER_CARDINAL   2
465 //#define PSYS_INTER_BSPLINE    3
466
467 #endif