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