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