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