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