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