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