Fix T51965: Custom Bone Shape Wireframe setting affects wireframe thickness.
[blender.git] / source / blender / makesdna / DNA_particle_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 by Janne Karhu.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_particle_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_PARTICLE_TYPES_H__
33 #define __DNA_PARTICLE_TYPES_H__
34
35 #include "DNA_defs.h"
36 #include "DNA_ID.h"
37 #include "DNA_boid_types.h"
38
39 struct AnimData;
40
41 typedef struct HairKey {
42         float co[3];    /* location of hair vertex */
43         float time;             /* time along hair, default 0-100 */
44         float weight;   /* softbody weight */
45         short editflag; /* saved particled edit mode flags */
46         short pad;
47         float world_co[3];
48 } HairKey;
49
50 typedef struct ParticleKey {    /* when changed update size of struct to copy_particleKey()!! */
51         float co[3];    /* location */
52         float vel[3];   /* velocity */
53         float rot[4];   /* rotation quaternion */
54         float ave[3];   /* angular velocity */
55         float time;             /* when this key happens */
56 } ParticleKey;
57
58 typedef struct BoidParticle {
59         struct Object *ground;
60         struct BoidData data;
61         float gravity[3];
62         float wander[3];
63         float rt;
64 } BoidParticle;
65
66 typedef struct ParticleSpring {
67         float rest_length;
68         unsigned int particle_index[2], delete_flag;
69 } ParticleSpring;
70
71 /* Child particles are created around or between parent particles */
72 typedef struct ChildParticle {
73         int num, parent;        /* num is face index on the final derived mesh */
74         int pa[4];                      /* nearest particles to the child, used for the interpolation */
75         float w[4];                     /* interpolation weights for the above particles */
76         float fuv[4], foffset; /* face vertex weights and offset */
77         float rt;
78 } ChildParticle;
79
80 typedef struct ParticleTarget {
81         struct ParticleTarget *next, *prev;
82         struct Object *ob;
83         int psys;
84         short flag, mode;
85         float time, duration;
86 } ParticleTarget;
87
88 typedef struct ParticleDupliWeight {
89         struct ParticleDupliWeight *next, *prev;
90         struct Object *ob;
91         short count;
92         short flag;
93         short index, rt; /* only updated on file save and used on file load */
94 } ParticleDupliWeight;
95
96 typedef struct ParticleData {
97         ParticleKey state;              /* current global coordinates */
98
99         ParticleKey prev_state; /* previous state */
100         
101         HairKey *hair;                  /* hair vertices */
102
103         ParticleKey *keys;              /* keyed keys */
104
105         BoidParticle *boid;             /* boids data */
106
107         int totkey;                             /* amount of hair or keyed keys*/
108
109         float time, lifetime;   /* dietime is not nescessarily time+lifetime as */
110         float dietime;                  /* particles can die unnaturally (collision)    */
111
112         /* WARNING! Those two indices, when not affected to vertices, are for !!! TESSELLATED FACES !!!, not POLYGONS! */
113         int num;                                /* index to vert/edge/face */
114         int num_dmcache;                /* index to derived mesh data (face) to avoid slow lookups */
115
116         float fuv[4], foffset;  /* coordinates on face/edge number "num" and depth along*/
117                                                         /* face normal for volume emission                                              */
118
119         float size;                             /* size and multiplier so that we can update size when ever */
120
121         float sphdensity;               /* density of sph particle */
122         int pad;
123
124         int hair_index;
125         short flag;
126         short alive;                    /* the life state of a particle */
127 } ParticleData;
128
129 typedef struct SPHFluidSettings {
130         /*Particle Fluid*/
131         float radius, spring_k, rest_length;
132         float plasticity_constant, yield_ratio;
133         float plasticity_balance, yield_balance;
134         float viscosity_omega, viscosity_beta;
135         float stiffness_k, stiffness_knear, rest_density;
136         float buoyancy;
137         int flag, spring_frames;
138         short solver;
139         short pad[3];
140 } SPHFluidSettings;
141
142 /* fluid->flag */
143 #define SPH_VISCOELASTIC_SPRINGS        1
144 #define SPH_CURRENT_REST_LENGTH         2
145 #define SPH_FAC_REPULSION                       4
146 #define SPH_FAC_DENSITY                         8
147 #define SPH_FAC_RADIUS                          16
148 #define SPH_FAC_VISCOSITY                       32
149 #define SPH_FAC_REST_LENGTH                     64
150
151 /* fluid->solver (numerical ID field, not bitfield) */
152 #define SPH_SOLVER_DDR                                  0
153 #define SPH_SOLVER_CLASSICAL                    1
154
155 typedef struct ParticleSettings {
156         ID id;
157         struct AnimData *adt;
158
159         struct BoidSettings *boids;
160         struct SPHFluidSettings *fluid;
161
162         struct EffectorWeights *effector_weights;
163         struct Group *collision_group;
164
165         int flag, rt;
166         short type, from, distr, texact;
167         /* physics modes */
168         short phystype, rotmode, avemode, reactevent;
169         int draw, pad1;
170         short draw_as, draw_size, childtype, pad2;
171         short ren_as, subframes, draw_col;
172         /* number of path segments, power of 2 except */
173         short draw_step, ren_step;
174         short hair_step, keys_step;
175
176         /* adaptive path rendering */
177         short adapt_angle, adapt_pix;
178
179         short disp, omat, interpolation, integrator;
180         short rotfrom DNA_DEPRECATED;
181         short kink, kink_axis;
182
183         /* billboards */
184         short bb_align, bb_uv_split, bb_anim, bb_split_offset;
185         float bb_tilt, bb_rand_tilt, bb_offset[2], bb_size[2], bb_vel_head, bb_vel_tail;
186
187         /* draw color */
188         float color_vec_max;
189
190         /* simplification */
191         short simplify_flag, simplify_refsize;
192         float simplify_rate, simplify_transition;
193         float simplify_viewport;
194
195         /* time and emission */
196         float sta, end, lifetime, randlife;
197         float timetweak, courant_target;
198         float jitfac, eff_hair, grid_rand, ps_offset[1];
199         int totpart, userjit, grid_res, effector_amount;
200         short time_flag, time_pad[3];
201
202         /* initial velocity factors */
203         float normfac, obfac, randfac, partfac, tanfac, tanphase, reactfac;
204         float ob_vel[3];
205         float avefac, phasefac, randrotfac, randphasefac;
206         /* physical properties */
207         float mass, size, randsize;
208         /* global physical properties */
209         float acc[3], dragfac, brownfac, dampfac;
210         /* length */
211         float randlength;
212         /* children */
213         int child_flag;
214         int pad3;
215         int child_nbr, ren_child_nbr;
216         float parents, childsize, childrandsize;
217         float childrad, childflat;
218         /* clumping */
219         float clumpfac, clumppow;
220         /* kink */
221         float kink_amp, kink_freq, kink_shape, kink_flat;
222         float kink_amp_clump;
223         int kink_extra_steps, pad4;
224         float kink_axis_random, kink_amp_random;
225         /* rough */
226         float rough1, rough1_size;
227         float rough2, rough2_size, rough2_thres;
228         float rough_end, rough_end_shape;
229         /* length */
230         float clength, clength_thres;
231         /* parting */
232         float parting_fac;
233         float parting_min, parting_max;
234         /* branching */
235         float branch_thres;
236         /* drawing stuff */
237         float draw_line[2];
238         float path_start, path_end;
239         int trail_count;
240         /* keyed particles */
241         int keyed_loops;
242         struct CurveMapping *clumpcurve;
243         struct CurveMapping *roughcurve;
244         float clump_noise_size;
245
246         /* hair dynamics */
247         float bending_random;
248
249         struct MTex *mtex[18];          /* MAX_MTEX */
250
251         struct Group *dup_group;
252         struct ListBase dupliweights;
253         struct Group *eff_group  DNA_DEPRECATED;                // deprecated
254         struct Object *dup_ob;
255         struct Object *bb_ob;
256         struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
257         struct PartDeflect *pd;
258         struct PartDeflect *pd2;
259
260         /* modified dm support */
261         short use_modifier_stack;
262         short pad5[3];
263
264 } ParticleSettings;
265
266 typedef struct ParticleSystem {
267         /* note1: make sure all (runtime) are NULL's in 'copy_particlesystem' XXX, this function is no more! - need to invstigate */
268         /* note2: make sure any uses of this struct in DNA are accounted for in 'BKE_object_copy_particlesystems' */
269
270         struct ParticleSystem *next, *prev;
271
272         ParticleSettings *part;                                 /* particle settings */
273
274         ParticleData *particles;                                /* (parent) particles */
275         ChildParticle *child;                                   /* child particles */
276
277         struct PTCacheEdit *edit;                                               /* particle editmode (runtime) */
278         void (*free_edit)(struct PTCacheEdit *edit);    /* free callback */
279
280         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
281         struct ParticleCacheKey **childcache;   /* child cache (runtime) */
282         ListBase pathcachebufs, childcachebufs; /* buffers for the above */
283
284         struct ClothModifierData *clmd;                                 /* cloth simulation for hair */
285         struct DerivedMesh *hair_in_dm, *hair_out_dm;   /* input/output for cloth simulation */
286
287         struct Object *target_ob;
288
289         struct LatticeDeformData *lattice_deform_data;          /* run-time only lattice deformation data */
290
291         struct Object *parent;                                  /* particles from global space -> parent space */
292
293         struct ListBase targets;                                /* used for keyed and boid physics */
294
295         char name[64];                                                  /* particle system name, MAX_NAME */
296         
297         float imat[4][4];       /* used for duplicators */
298         float cfra, tree_frame, bvhtree_frame;
299         int seed, child_seed;
300         int flag, totpart, totunexist, totchild, totcached, totchildcache;
301         short recalc, target_psys, totkeyed, bakespace;
302
303         char bb_uvname[3][64];                                  /* billboard uv name, MAX_CUSTOMDATA_LAYER_NAME */
304
305         /* if you change these remember to update array lengths to PSYS_TOT_VG! */
306         short vgroup[12], vg_neg, rt3;                  /* vertex groups, 0==disable, 1==starting index */
307
308         /* temporary storage during render */
309         struct ParticleRenderData *renderdata;
310
311         /* point cache */
312         struct PointCache *pointcache;
313         struct ListBase ptcaches;
314
315         struct ListBase *effectors;
316
317         ParticleSpring *fluid_springs;
318         int tot_fluidsprings, alloc_fluidsprings;
319
320         struct KDTree *tree;                                    /* used for interactions with self and other systems */
321         struct BVHTree *bvhtree;                                /* used for interactions with self and other systems */
322
323         struct ParticleDrawData *pdd;
324
325         float dt_frac;                                                  /* current time step, as a fraction of a frame */
326         float lattice_strength;                                 /* influence of the lattice modifier */
327 } ParticleSystem;
328
329 typedef enum eParticleDrawFlag {
330         PART_DRAW_VEL           = (1 << 0),
331         PART_DRAW_GLOBAL_OB         = (1 << 1),
332         PART_DRAW_SIZE          = (1 << 2),
333         PART_DRAW_EMITTER       = (1 << 3), /* render emitter also */
334         PART_DRAW_HEALTH        = (1 << 4),
335         PART_ABS_PATH_TIME      = (1 << 5),
336         PART_DRAW_COUNT_GR      = (1 << 6),
337         PART_DRAW_BB_LOCK       = (1 << 7), /* used with billboards */
338         PART_DRAW_ROTATE_OB     = (1 << 7), /* used with dupliobjects/groups */
339         PART_DRAW_PARENT        = (1 << 8),
340         PART_DRAW_NUM           = (1 << 9),
341         PART_DRAW_RAND_GR       = (1 << 10),
342         PART_DRAW_REN_ADAPT     = (1 << 11),
343         PART_DRAW_VEL_LENGTH    = (1 << 12),
344         PART_DRAW_MAT_COL       = (1 << 13), /* deprecated, but used in do_versions */
345         PART_DRAW_WHOLE_GR      = (1 << 14),
346         PART_DRAW_REN_STRAND    = (1 << 15),
347         PART_DRAW_NO_SCALE_OB   = (1 << 16), /* used with dupliobjects/groups */
348         PART_DRAW_GUIDE_HAIRS   = (1 << 17),
349         PART_DRAW_HAIR_GRID     = (1 << 18),
350 } eParticleDrawFlag;
351
352 /* part->type */
353 /* hair is allways baked static in object/geometry space */
354 /* other types (normal particles) are in global space and not static baked */
355 #define PART_EMITTER            0
356 //#define PART_REACTOR          1
357 #define PART_HAIR                       2
358 #define PART_FLUID                      3
359
360 /* part->flag */
361 #define PART_REACT_STA_END      1
362 #define PART_REACT_MULTIPLE     2
363
364 //#define PART_LOOP                     4       /* not used anymore */
365                 /* for dopesheet */
366 #define PART_DS_EXPAND          8
367
368 #define PART_HAIR_REGROW        16      /* regrow hair for each frame */
369
370 #define PART_UNBORN                     32      /*show unborn particles*/
371 #define PART_DIED                       64      /*show died particles*/
372
373 #define PART_TRAND                      128     
374 #define PART_EDISTR                     256     /* particle/face from face areas */
375
376 #define PART_ROTATIONS          512     /* calculate particle rotations (and store them in pointcache) */
377 #define PART_DIE_ON_COL         (1<<12)
378 #define PART_SIZE_DEFL          (1<<13) /* swept sphere deflections */
379 #define PART_ROT_DYN            (1<<14) /* dynamic rotation */
380 #define PART_SIZEMASS           (1<<16)
381
382 #define PART_HIDE_ADVANCED_HAIR (1<<15)
383
384 //#define PART_ABS_TIME         (1<<17)
385 //#define PART_GLOB_TIME                (1<<18)
386
387 #define PART_BOIDS_2D           (1<<19)
388
389 //#define PART_BRANCHING                (1<<20)
390 //#define PART_ANIM_BRANCHING   (1<<21)
391
392 #define PART_HAIR_BSPLINE       1024
393
394 #define PART_GRID_HEXAGONAL     (1<<24)
395 #define PART_GRID_INVERT        (1<<26)
396
397 #define PART_CHILD_EFFECT               (1<<27)
398 #define PART_CHILD_LONG_HAIR    (1<<28)
399 /* #define PART_CHILD_RENDER            (1<<29) */ /*UNUSED*/
400 #define PART_CHILD_GUIDE                (1<<30)
401
402 #define PART_SELF_EFFECT        (1<<22)
403
404 /* part->from */
405 #define PART_FROM_VERT          0
406 #define PART_FROM_FACE          1
407 #define PART_FROM_VOLUME        2
408 /* #define PART_FROM_PARTICLE   3  deprecated! */ 
409 #define PART_FROM_CHILD         4
410
411 /* part->distr */
412 #define PART_DISTR_JIT          0
413 #define PART_DISTR_RAND         1
414 #define PART_DISTR_GRID         2
415
416 /* part->phystype */
417 #define PART_PHYS_NO            0
418 #define PART_PHYS_NEWTON        1
419 #define PART_PHYS_KEYED         2
420 #define PART_PHYS_BOIDS         3
421 #define PART_PHYS_FLUID         4
422
423 /* part->kink */
424 typedef enum eParticleKink {
425         PART_KINK_NO            = 0,
426         PART_KINK_CURL          = 1,
427         PART_KINK_RADIAL        = 2,
428         PART_KINK_WAVE          = 3,
429         PART_KINK_BRAID         = 4,
430         PART_KINK_SPIRAL        = 5,
431 } eParticleKink;
432
433 /* part->child_flag */
434 typedef enum eParticleChildFlag {
435         PART_CHILD_USE_CLUMP_NOISE  = (1<<0),
436         PART_CHILD_USE_CLUMP_CURVE  = (1<<1),
437         PART_CHILD_USE_ROUGH_CURVE  = (1<<2),
438 } eParticleChildFlag;
439
440 /* part->draw_col */
441 #define PART_DRAW_COL_NONE              0
442 #define PART_DRAW_COL_MAT               1
443 #define PART_DRAW_COL_VEL               2
444 #define PART_DRAW_COL_ACC               3
445
446
447 /* part->simplify_flag */
448 #define PART_SIMPLIFY_ENABLE    1
449 #define PART_SIMPLIFY_VIEWPORT  2
450
451 /* part->time_flag */
452 #define PART_TIME_AUTOSF        1 /* Automatic subframes */
453
454 /* part->bb_align */
455 #define PART_BB_X               0
456 #define PART_BB_Y               1
457 #define PART_BB_Z               2
458 #define PART_BB_VIEW    3
459 #define PART_BB_VEL             4
460
461 /* part->bb_anim */
462 #define PART_BB_ANIM_NONE       0
463 #define PART_BB_ANIM_AGE        1
464 #define PART_BB_ANIM_ANGLE      2
465 #define PART_BB_ANIM_FRAME      3
466
467 /* part->bb_split_offset */
468 #define PART_BB_OFF_NONE        0
469 #define PART_BB_OFF_LINEAR      1
470 #define PART_BB_OFF_RANDOM      2
471
472 /* part->draw_as */
473 /* part->ren_as*/
474 #define PART_DRAW_NOT           0
475 #define PART_DRAW_DOT           1
476 #define PART_DRAW_HALO          1
477 #define PART_DRAW_CIRC          2
478 #define PART_DRAW_CROSS         3
479 #define PART_DRAW_AXIS          4
480 #define PART_DRAW_LINE          5
481 #define PART_DRAW_PATH          6
482 #define PART_DRAW_OB            7
483 #define PART_DRAW_GR            8
484 #define PART_DRAW_BB            9
485 #define PART_DRAW_REND          10
486
487 /* part->integrator */
488 #define PART_INT_EULER          0
489 #define PART_INT_MIDPOINT       1
490 #define PART_INT_RK4            2
491 #define PART_INT_VERLET         3
492
493 /* part->rotmode */
494 #define PART_ROT_NOR            1
495 #define PART_ROT_VEL            2
496 #define PART_ROT_GLOB_X         3
497 #define PART_ROT_GLOB_Y         4
498 #define PART_ROT_GLOB_Z         5
499 #define PART_ROT_OB_X           6
500 #define PART_ROT_OB_Y           7
501 #define PART_ROT_OB_Z           8
502 #define PART_ROT_NOR_TAN        9
503
504 /* part->avemode */
505 #define PART_AVE_VELOCITY       1
506 #define PART_AVE_RAND           2
507 #define PART_AVE_HORIZONTAL     3
508 #define PART_AVE_VERTICAL       4
509 #define PART_AVE_GLOBAL_X       5
510 #define PART_AVE_GLOBAL_Y       6
511 #define PART_AVE_GLOBAL_Z       7
512
513 /* part->reactevent */
514 #define PART_EVENT_DEATH        0
515 #define PART_EVENT_COLLIDE      1
516 #define PART_EVENT_NEAR         2
517
518 /* part->childtype */
519 #define PART_CHILD_PARTICLES    1
520 #define PART_CHILD_FACES                2
521
522 /* psys->recalc */
523 /* starts from (1 << 3) so that the first bits can be ob->recalc */
524 #define PSYS_RECALC_REDO   (1 << 3) /* only do pathcache etc */
525 #define PSYS_RECALC_RESET  (1 << 4) /* reset everything including pointcache */
526 #define PSYS_RECALC_TYPE   (1 << 5) /* handle system type change */
527 #define PSYS_RECALC_CHILD  (1 << 6) /* only child settings changed */
528 #define PSYS_RECALC_PHYS   (1 << 7) /* physics type changed */
529 #define PSYS_RECALC        (PSYS_RECALC_REDO | PSYS_RECALC_RESET | PSYS_RECALC_TYPE | PSYS_RECALC_CHILD | PSYS_RECALC_PHYS)
530
531 /* psys->flag */
532 #define PSYS_CURRENT            1
533 #define PSYS_GLOBAL_HAIR        2
534 #define PSYS_HAIR_DYNAMICS      4
535 #define PSYS_KEYED_TIMING       8
536 //#define PSYS_ENABLED          16      /* deprecated */
537 #define PSYS_HAIR_UPDATED       32  /* signal for updating hair particle mode */
538 #define PSYS_DRAWING            64
539 #define PSYS_USE_IMAT           128
540 #define PSYS_DELETE                     256     /* remove particlesystem as soon as possible */
541 #define PSYS_HAIR_DONE          512
542 #define PSYS_KEYED                      1024
543 #define PSYS_EDITED                     2048
544 //#define PSYS_PROTECT_CACHE    4096 /* deprecated */
545 #define PSYS_DISABLED                   8192
546 #define PSYS_OB_ANIM_RESTORE    16384 /* runtime flag */
547
548 /* pars->flag */
549 #define PARS_UNEXIST            1
550 #define PARS_NO_DISP            2
551 //#define PARS_STICKY                   4 /* deprecated */
552 #define PARS_REKEY                      8
553
554 /* pars->alive */
555 //#define PARS_KILLED                   0 /* deprecated */
556 #define PARS_DEAD                       1
557 #define PARS_UNBORN                     2
558 #define PARS_ALIVE                      3
559 #define PARS_DYING                      4
560
561 /* ParticleDupliWeight->flag */
562 #define PART_DUPLIW_CURRENT     1
563
564 /* psys->vg */
565 #define PSYS_TOT_VG                     12
566
567 #define PSYS_VG_DENSITY         0
568 #define PSYS_VG_VEL                     1
569 #define PSYS_VG_LENGTH          2
570 #define PSYS_VG_CLUMP           3
571 #define PSYS_VG_KINK            4
572 #define PSYS_VG_ROUGH1          5
573 #define PSYS_VG_ROUGH2          6
574 #define PSYS_VG_ROUGHE          7
575 #define PSYS_VG_SIZE            8
576 #define PSYS_VG_TAN                     9
577 #define PSYS_VG_ROT                     10
578 #define PSYS_VG_EFFECTOR        11
579
580 /* ParticleTarget->flag */
581 #define PTARGET_CURRENT         1
582 #define PTARGET_VALID           2
583
584 /* ParticleTarget->mode */
585 #define PTARGET_MODE_NEUTRAL    0
586 #define PTARGET_MODE_FRIEND             1
587 #define PTARGET_MODE_ENEMY              2
588
589 /* mapto */
590 typedef enum eParticleTextureInfluence {
591         /* init */
592         PAMAP_TIME              = (1<<0),       /* emission time */
593         PAMAP_LIFE              = (1<<1),       /* life time */
594         PAMAP_DENS              = (1<<2),       /* density */
595         PAMAP_SIZE              = (1<<3),       /* physical size */
596         PAMAP_INIT              = (PAMAP_TIME | PAMAP_LIFE | PAMAP_DENS | PAMAP_SIZE),
597         /* reset */
598         PAMAP_IVEL              = (1<<5),       /* initial velocity */
599         /* physics */
600         PAMAP_FIELD             = (1<<6),       /* force fields */
601         PAMAP_GRAVITY   = (1<<10),
602         PAMAP_DAMP              = (1<<11),
603         PAMAP_PHYSICS   = (PAMAP_FIELD | PAMAP_GRAVITY | PAMAP_DAMP),
604         /* children */
605         PAMAP_CLUMP             = (1<<7),
606         PAMAP_KINK_FREQ = (1<<8),
607         PAMAP_KINK_AMP  = (1<<12),
608         PAMAP_ROUGH             = (1<<9),
609         PAMAP_LENGTH    = (1<<4),
610         PAMAP_CHILD             = (PAMAP_CLUMP | PAMAP_KINK_FREQ | PAMAP_KINK_AMP | PAMAP_ROUGH | PAMAP_LENGTH),
611 } eParticleTextureInfluence;
612
613 #endif