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