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