22a0290f364a6ffe414767e1149207b21f20d9ff
[blender.git] / source / blender / blenkernel / BKE_particle.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  * Adaptive time step
24  * Classical SPH
25  * Copyright 2011-2012 AutoCRC
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef __BKE_PARTICLE_H__
31 #define __BKE_PARTICLE_H__
32
33 /** \file BKE_particle.h
34  *  \ingroup bke
35  */
36
37 #include "BLI_utildefines.h"
38
39 #include "DNA_particle_types.h"
40 #include "DNA_object_types.h"
41
42 #include "BKE_customdata.h"
43
44 struct ParticleSystemModifierData;
45 struct ParticleSystem;
46 struct ParticleKey;
47 struct ParticleSettings;
48
49 struct Main;
50 struct Object;
51 struct Scene;
52 struct DerivedMesh;
53 struct ModifierData;
54 struct MTFace;
55 struct MCol;
56 struct MFace;
57 struct MVert;
58 struct LatticeDeformData;
59 struct LinkNode;
60 struct KDTree;
61 struct RNG;
62 struct BVHTreeRay;
63 struct BVHTreeRayHit; 
64 struct EdgeHash;
65
66 #define PARTICLE_COLLISION_MAX_COLLISIONS 10
67
68 #define PARTICLE_P              ParticleData * pa; int p
69 #define LOOP_PARTICLES  for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++)
70 #define LOOP_EXISTING_PARTICLES for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++) if (!(pa->flag & PARS_UNEXIST))
71 #define LOOP_SHOWN_PARTICLES for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++) if (!(pa->flag & (PARS_UNEXIST | PARS_NO_DISP)))
72 /* OpenMP: Can only advance one variable within loop definition. */
73 #define LOOP_DYNAMIC_PARTICLES for (p = 0; p < psys->totpart; p++) if ((pa = psys->particles + p)->state.time > 0.0f)
74
75 /* fast but sure way to get the modifier*/
76 #define PARTICLE_PSMD ParticleSystemModifierData * psmd = sim->psmd ? sim->psmd : psys_get_modifier(sim->ob, sim->psys)
77
78 /* common stuff that many particle functions need */
79 typedef struct ParticleSimulationData {
80         struct Scene *scene;
81         struct Object *ob;
82         struct ParticleSystem *psys;
83         struct ParticleSystemModifierData *psmd;
84         struct ListBase *colliders;
85         /* Courant number. This is used to implement an adaptive time step. Only the
86          * maximum value per time step is important. Only sph_integrate makes use of
87          * this at the moment. Other solvers could, too. */
88         float courant_num;
89 } ParticleSimulationData;
90
91 typedef struct SPHData {
92         ParticleSystem *psys[10];
93         ParticleData *pa;
94         float mass;
95         struct EdgeHash *eh;
96         float *gravity;
97         float hfac;
98         /* Average distance to neighbours (other particles in the support domain),
99          * for calculating the Courant number (adaptive time step). */
100         int pass;
101         float element_size;
102         float flow[3];
103
104         /* Integrator callbacks. This allows different SPH implementations. */
105         void (*force_cb) (void *sphdata_v, ParticleKey *state, float *force, float *impulse);
106         void (*density_cb) (void *rangedata_v, int index, const float co[3], float squared_dist);
107 } SPHData;
108
109 typedef struct ParticleTexture {
110         float ivel;                           /* used in reset */
111         float time, life, exist, size;        /* used in init */
112         float damp, gravity, field;           /* used in physics */
113         float length, clump, kink_freq, kink_amp, effector;  /* used in path caching */
114         float rough1, rough2, roughe;         /* used in path caching */
115 } ParticleTexture;
116
117 typedef struct ParticleSeam {
118         float v0[3], v1[3];
119         float nor[3], dir[3], tan[3];
120         float length2;
121 } ParticleSeam;
122
123 typedef struct ParticleCacheKey {
124         float co[3];
125         float vel[3];
126         float rot[4];
127         float col[3];
128         float time;
129         int segments;
130 } ParticleCacheKey;
131
132 typedef struct ParticleThreadContext {
133         /* shared */
134         struct ParticleSimulationData sim;
135         struct DerivedMesh *dm;
136         struct Material *ma;
137
138         /* distribution */
139         struct KDTree *tree;
140
141         struct ParticleSeam *seams;
142         int totseam;
143
144         float *jit, *jitoff, *weight;
145         float maxweight;
146         int *index, *skip, jitlevel;
147
148         int cfrom, distr;
149
150         struct ParticleData *tpars;
151
152         /* path caching */
153         bool editupdate;
154         int between, segments, extra_segments;
155         int totchild, totparent, parent_pass;
156
157         float cfra;
158
159         float *vg_length, *vg_clump, *vg_kink;
160         float *vg_rough1, *vg_rough2, *vg_roughe;
161         float *vg_effector;
162
163         struct CurveMapping *clumpcurve;
164         struct CurveMapping *roughcurve;
165 } ParticleThreadContext;
166
167 typedef struct ParticleTask {
168         ParticleThreadContext *ctx;
169         struct RNG *rng, *rng_path;
170         int begin, end;
171 } ParticleTask;
172
173 typedef struct ParticleBillboardData {
174         struct Object *ob;
175         float vec[3], vel[3];
176         float offset[2];
177         float size[2];
178         float tilt, random, time;
179         int uv[3];
180         int lock, num;
181         int totnum;
182         int lifetime;
183         short align, uv_split, anim, split_offset;
184 } ParticleBillboardData;
185
186 typedef struct ParticleCollisionElement {
187         /* pointers to original data */
188         float *x[3], *v[3];
189
190         /* values interpolated from original data*/
191         float x0[3], x1[3], x2[3], p[3];
192         
193         /* results for found intersection point */
194         float nor[3], vel[3], uv[2];
195
196         /* count of original data (1-4) */
197         int tot;
198
199         /* index of the collision face */
200         int index;
201
202         /* flags for inversed normal / particle already inside element at start */
203         short inv_nor, inside;
204 } ParticleCollisionElement;
205
206 /* container for moving data between deflet_particle and particle_intersect_face */
207 typedef struct ParticleCollision {
208         struct Object *current;
209         struct Object *hit;
210         struct Object *skip[PARTICLE_COLLISION_MAX_COLLISIONS + 1];
211         struct Object *emitter;
212
213         struct CollisionModifierData *md; // collision modifier for current object;
214
215         float f;    // time factor of previous collision, needed for substracting face velocity
216         float fac1, fac2;
217
218         float cfra, old_cfra;
219
220         float original_ray_length; //original length of co2-co1, needed for collision time evaluation
221
222         int skip_count;
223
224         ParticleCollisionElement pce;
225
226         /* total_time is the amount of time in this subframe
227          * inv_total_time is the opposite
228          * inv_timestep is the inverse of the amount of time in this frame */
229         float total_time, inv_total_time, inv_timestep;
230
231         float radius;
232         float co1[3], co2[3];
233         float ve1[3], ve2[3];
234
235         float acc[3], boid_z;
236
237         int boid;
238 } ParticleCollision;
239
240 typedef struct ParticleDrawData {
241         float *vdata, *vd;      /* vertice data */
242         float *ndata, *nd;      /* normal data */
243         float *cdata, *cd;      /* color data */
244         float *vedata, *ved;    /* velocity data */
245         float *ma_col;
246         int tot_vec_size, flag;
247         int totpoint, totve;
248 } ParticleDrawData;
249
250 #define PARTICLE_DRAW_DATA_UPDATED  1
251
252 #define PSYS_FRAND_COUNT    1024
253 extern unsigned int PSYS_FRAND_SEED_OFFSET[PSYS_FRAND_COUNT];
254 extern unsigned int PSYS_FRAND_SEED_MULTIPLIER[PSYS_FRAND_COUNT];
255 extern float PSYS_FRAND_BASE[PSYS_FRAND_COUNT];
256
257 void psys_init_rng(void);
258
259 BLI_INLINE float psys_frand(ParticleSystem *psys, unsigned int seed)
260 {
261         /* XXX far from ideal, this simply scrambles particle random numbers a bit
262          * to avoid obvious correlations.
263          * Can't use previous psys->frand arrays because these require initialization
264          * inside psys_check_enabled, which wreaks havok in multithreaded depgraph updates.
265          */
266         unsigned int offset = PSYS_FRAND_SEED_OFFSET[psys->seed % PSYS_FRAND_COUNT];
267         unsigned int multiplier = PSYS_FRAND_SEED_MULTIPLIER[psys->seed % PSYS_FRAND_COUNT];
268         return PSYS_FRAND_BASE[(offset + seed * multiplier) % PSYS_FRAND_COUNT];
269 }
270
271 BLI_INLINE void psys_frand_vec(ParticleSystem *psys, unsigned int seed, float vec[3])
272 {
273         unsigned int offset = PSYS_FRAND_SEED_OFFSET[psys->seed % PSYS_FRAND_COUNT];
274         unsigned int multiplier = PSYS_FRAND_SEED_MULTIPLIER[psys->seed % PSYS_FRAND_COUNT];
275         vec[0] = PSYS_FRAND_BASE[(offset + (seed + 0) * multiplier) % PSYS_FRAND_COUNT];
276         vec[1] = PSYS_FRAND_BASE[(offset + (seed + 1) * multiplier) % PSYS_FRAND_COUNT];
277         vec[2] = PSYS_FRAND_BASE[(offset + (seed + 2) * multiplier) % PSYS_FRAND_COUNT];
278 }
279
280 /* ----------- functions needed outside particlesystem ---------------- */
281 /* particle.c */
282 int count_particles(struct ParticleSystem *psys);
283 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
284
285 int psys_get_child_number(struct Scene *scene, struct ParticleSystem *psys);
286 int psys_get_tot_child(struct Scene *scene, struct ParticleSystem *psys);
287
288 struct ParticleSystem *psys_get_current(struct Object *ob);
289 /* for rna */
290 short psys_get_current_num(struct Object *ob);
291 void psys_set_current_num(Object *ob, int index);
292 /* UNUSED */
293 // struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
294
295 struct LatticeDeformData *psys_create_lattice_deform_data(struct ParticleSimulationData *sim);
296
297 bool psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
298 bool psys_check_enabled(struct Object *ob, struct ParticleSystem *psys, const bool use_render_params);
299 bool psys_check_edited(struct ParticleSystem *psys);
300
301 void psys_check_group_weights(struct ParticleSettings *part);
302 int psys_uses_gravity(struct ParticleSimulationData *sim);
303
304 /* free */
305 void BKE_particlesettings_free(struct ParticleSettings *part);
306 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
307 void psys_free(struct Object *ob, struct ParticleSystem *psys);
308
309 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[4][4], float winmat[4][4], int winx, int winy, int timeoffset);
310 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
311 bool psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
312
313 void psys_interpolate_uvs(const struct MTFace *tface, int quad, const float w[4], float uvco[2]);
314 void psys_interpolate_mcol(const struct MCol *mcol, int quad, const float w[4], struct MCol *mc);
315
316 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
317
318 CustomDataMask psys_emitter_customdata_mask(struct ParticleSystem *psys);
319 void psys_particle_on_emitter(struct ParticleSystemModifierData *psmd, int distr, int index, int index_dmcache,
320                               float fuv[4], float foffset, float vec[3], float nor[3],
321                               float utan[3], float vtan[3], float orco[3], float ornor[3]);
322 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
323
324 struct ModifierData *object_add_particle_system(struct Scene *scene, struct Object *ob, const char *name);
325 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
326 struct ParticleSettings *psys_new_settings(const char *name, struct Main *main);
327 struct ParticleSettings *BKE_particlesettings_copy(struct Main *bmain, const struct ParticleSettings *part);
328 void BKE_particlesettings_make_local(struct Main *bmain, struct ParticleSettings *part, const bool lib_local);
329
330 void psys_reset(struct ParticleSystem *psys, int mode);
331
332 void psys_find_parents(struct ParticleSimulationData *sim, const bool use_render_params);
333
334 void psys_cache_paths(struct ParticleSimulationData *sim, float cfra, const bool use_render_params);
335 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra, const bool use_render_params);
336 void psys_cache_child_paths(struct ParticleSimulationData *sim, float cfra, const bool editupdate, const bool use_render_params);
337 int do_guides(struct ParticleSettings *part, struct ListBase *effectors, ParticleKey *state, int pa_num, float time);
338 void precalc_guides(struct ParticleSimulationData *sim, struct ListBase *effectors);
339 float psys_get_timestep(struct ParticleSimulationData *sim);
340 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
341 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
342 void psys_get_particle_on_path(struct ParticleSimulationData *sim, int pa_num, struct ParticleKey *state, const bool vel);
343 int psys_get_particle_state(struct ParticleSimulationData *sim, int p, struct ParticleKey *state, int always);
344
345 /* child paths */
346 void BKE_particlesettings_clump_curve_init(struct ParticleSettings *part);
347 void BKE_particlesettings_rough_curve_init(struct ParticleSettings *part);
348 void psys_apply_child_modifiers(struct ParticleThreadContext *ctx, struct ListBase *modifiers,
349                                 struct ChildParticle *cpa, struct ParticleTexture *ptex, const float orco[3], const float ornor[3], float hairmat[4][4],
350                                 struct ParticleCacheKey *keys, struct ParticleCacheKey *parent_keys, const float parent_orco[3]);
351
352 void psys_sph_init(struct ParticleSimulationData *sim, struct SPHData *sphdata);
353 void psys_sph_finalise(struct SPHData *sphdata);
354 void psys_sph_density(struct BVHTree *tree, struct SPHData *data, float co[3], float vars[2]);
355
356 /* for anim.c */
357 void psys_get_dupli_texture(struct ParticleSystem *psys, struct ParticleSettings *part,
358                             struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa,
359                             float uv[2], float orco[3]);
360 void psys_get_dupli_path_transform(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ChildParticle *cpa,
361                                    struct ParticleCacheKey *cache, float mat[4][4], float *scale);
362
363 void psys_thread_context_init(struct ParticleThreadContext *ctx, struct ParticleSimulationData *sim);
364 void psys_thread_context_free(struct ParticleThreadContext *ctx);
365 void psys_tasks_create(struct ParticleThreadContext *ctx, int startpart, int endpart, struct ParticleTask **r_tasks, int *r_numtasks);
366 void psys_tasks_free(struct ParticleTask *tasks, int numtasks);
367
368 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
369 void psys_apply_hair_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
370
371 /* particle_system.c */
372 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
373 void psys_count_keyed_targets(struct ParticleSimulationData *sim);
374 void psys_update_particle_tree(struct ParticleSystem *psys, float cfra);
375 void psys_changed_type(struct Object *ob, struct ParticleSystem *psys);
376
377 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
378 void psys_get_pointcache_start_end(struct Scene *scene, ParticleSystem *psys, int *sfra, int *efra);
379
380 void psys_check_boid_data(struct ParticleSystem *psys);
381
382 void psys_get_birth_coords(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, float dtime, float cfra);
383
384 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, const bool use_render_params);
385
386 /* Callback format for performing operations on ID-pointers for particle systems */
387 typedef void (*ParticleSystemIDFunc)(struct ParticleSystem *psys, struct ID **idpoin, void *userdata, int cb_flag);
388
389 void BKE_particlesystem_id_loop(struct ParticleSystem *psys, ParticleSystemIDFunc func, void *userdata);
390
391 /* ----------- functions needed only inside particlesystem ------------ */
392 /* particle.c */
393 void psys_disable_all(struct Object *ob);
394 void psys_enable_all(struct Object *ob);
395
396 void free_hair(struct Object *ob, struct ParticleSystem *psys, int dynamics);
397 void free_keyed_keys(struct ParticleSystem *psys);
398 void psys_free_particles(struct ParticleSystem *psys);
399 void psys_free_children(struct ParticleSystem *psys);
400
401 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, bool velocity);
402 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float vec[3]);
403 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[4][4]);
404 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[4][4]);
405 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[4][4]);
406
407 float psys_get_dietime_from_cache(struct PointCache *cache, int index);
408
409 void psys_free_pdd(struct ParticleSystem *psys);
410
411 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
412 void psys_get_texture(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleTexture *ptex, int event, float cfra);
413 void psys_interpolate_face(struct MVert *mvert, struct MFace *mface, struct MTFace *tface,
414                            float (*orcodata)[3], float w[4], float vec[3], float nor[3], float utan[3], float vtan[3],
415                            float orco[3], float ornor[3]);
416 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
417 void psys_get_from_key(struct ParticleKey *key, float loc[3], float vel[3], float rot[4], float *time);
418
419 /* BLI_bvhtree_ray_cast callback */
420 void BKE_psys_collision_neartest_cb(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
421 void psys_particle_on_dm(struct DerivedMesh *dm_final, int from, int index, int index_dmcache,
422                          const float fw[4], float foffset, float vec[3], float nor[3], float utan[3], float vtan[3],
423                          float orco[3], float ornor[3]);
424
425 /* particle_system.c */
426 void distribute_particles(struct ParticleSimulationData *sim, int from);
427 void initialize_particle(struct ParticleSimulationData *sim, struct ParticleData *pa);
428 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm_final, struct DerivedMesh *dm_deformed, struct ParticleSystem *psys);
429 int psys_particle_dm_face_lookup(struct DerivedMesh *dm_final, struct DerivedMesh *dm_deformed, int findex, const float fw[4], struct LinkNode **poly_nodes);
430
431 void reset_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, float dtime, float cfra);
432
433 float psys_get_current_display_percentage(struct ParticleSystem *psys);
434
435 typedef struct ParticleRenderElem {
436         int curchild, totchild, reduce;
437         float lambda, t, scalemin, scalemax;
438 } ParticleRenderElem;
439
440 typedef struct ParticleRenderData {
441         ChildParticle *child;
442         ParticleCacheKey **pathcache;
443         ParticleCacheKey **childcache;
444         ListBase pathcachebufs, childcachebufs;
445         int totchild, totcached, totchildcache;
446         struct DerivedMesh *dm;
447         int totdmvert, totdmedge, totdmface;
448
449         float mat[4][4];
450         float viewmat[4][4], winmat[4][4];
451         int winx, winy;
452
453         int do_simplify;
454         int timeoffset;
455         ParticleRenderElem *elems;
456
457         /* ORIGINDEX */
458         const int *index_mf_to_mpoly;
459         const int *index_mp_to_orig;
460 } ParticleRenderData;
461
462 /* psys_reset */
463 #define PSYS_RESET_ALL          1
464 #define PSYS_RESET_DEPSGRAPH    2
465 /* #define PSYS_RESET_CHILDREN  3 */ /*UNUSED*/
466 #define PSYS_RESET_CACHE_MISS   4
467
468 /* index_dmcache */
469 #define DMCACHE_NOTFOUND    -1
470 #define DMCACHE_ISCHILD     -2
471
472 /* **** Depsgraph evaluation **** */
473
474 struct EvaluationContext;
475
476 void BKE_particle_system_settings_eval(struct EvaluationContext *eval_ctx,
477                                        struct ParticleSystem *psys);
478 void BKE_particle_system_settings_recalc_clear(struct EvaluationContext *UNUSED(eval_ctx),
479                                                struct ParticleSettings *particle_settings);
480
481 void BKE_particle_system_eval_init(struct EvaluationContext *eval_ctx,
482                                    struct Scene *scene,
483                                    struct Object *ob);
484
485 #endif
486
487 /* Draw Cache */
488 enum {
489         BKE_PARTICLE_BATCH_DIRTY_ALL = 0,
490 };
491 void BKE_particle_batch_cache_dirty(struct ParticleSystem *psys, int mode);
492 void BKE_particle_batch_cache_free(struct ParticleSystem *psys);