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