Cleanup: style (pointers)
[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_COLLISION_MAX_COLLISIONS 10
67
68 #define PARTICLE_P              ParticleData *pa; int p
69 #define LOOP_PARTICLES  for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++)
70 #define LOOP_EXISTING_PARTICLES for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++) if (!(pa->flag & PARS_UNEXIST))
71 #define LOOP_SHOWN_PARTICLES for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++) if (!(pa->flag & (PARS_UNEXIST | PARS_NO_DISP)))
72 /* OpenMP: Can only advance one variable within loop definition. */
73 #define LOOP_DYNAMIC_PARTICLES for (p = 0; p < psys->totpart; p++) if ((pa = psys->particles + p)->state.time > 0.0f)
74
75 /* fast but sure way to get the modifier*/
76 #define PARTICLE_PSMD ParticleSystemModifierData *psmd = sim->psmd ? sim->psmd : psys_get_modifier(sim->ob, sim->psys)
77
78 /* common stuff that many particle functions need */
79 typedef struct ParticleSimulationData {
80         struct Scene *scene;
81         struct Object *ob;
82         struct ParticleSystem *psys;
83         struct ParticleSystemModifierData *psmd;
84         struct ListBase *colliders;
85         /* Courant number. This is used to implement an adaptive time step. Only the
86          * maximum value per time step is important. Only sph_integrate makes use of
87          * this at the moment. Other solvers could, too. */
88         float courant_num;
89 } ParticleSimulationData;
90
91 typedef struct SPHData {
92         ParticleSystem *psys[10];
93         ParticleData *pa;
94         float mass;
95         struct EdgeHash *eh;
96         float *gravity;
97         float hfac;
98         /* Average distance to neighbours (other particles in the support domain),
99          * for calculating the Courant number (adaptive time step). */
100         int pass;
101         float element_size;
102         float flow[3];
103
104         /* Integrator callbacks. This allows different SPH implementations. */
105         void (*force_cb) (void *sphdata_v, ParticleKey *state, float *force, float *impulse);
106         void (*density_cb) (void *rangedata_v, int index, const float co[3], float squared_dist);
107 } SPHData;
108
109 typedef struct ParticleTexture {
110         float ivel;                           /* used in reset */
111         float time, life, exist, size;        /* used in init */
112         float damp, gravity, field;           /* used in physics */
113         float length, clump, kink_freq, kink_amp, effector;  /* used in path caching */
114         float rough1, rough2, roughe;         /* used in path caching */
115         float twist;  /* used in path caching */
116 } ParticleTexture;
117
118 typedef struct ParticleSeam {
119         float v0[3], v1[3];
120         float nor[3], dir[3], tan[3];
121         float length2;
122 } ParticleSeam;
123
124 typedef struct ParticleCacheKey {
125         float co[3];
126         float vel[3];
127         float rot[4];
128         float col[3];
129         float time;
130         int segments;
131 } ParticleCacheKey;
132
133 typedef struct ParticleThreadContext {
134         /* shared */
135         struct ParticleSimulationData sim;
136         struct DerivedMesh *dm;
137         struct Material *ma;
138
139         /* distribution */
140         struct KDTree *tree;
141
142         struct ParticleSeam *seams;
143         int totseam;
144
145         float *jit, *jitoff, *weight;
146         float maxweight;
147         int *index, *skip, jitlevel;
148
149         int cfrom, distr;
150
151         struct ParticleData *tpars;
152
153         /* path caching */
154         bool editupdate;
155         int between, segments, extra_segments;
156         int totchild, totparent, parent_pass;
157
158         float cfra;
159
160         float *vg_length, *vg_clump, *vg_kink;
161         float *vg_rough1, *vg_rough2, *vg_roughe;
162         float *vg_effector;
163         float *vg_twist;
164
165         struct CurveMapping *clumpcurve;
166         struct CurveMapping *roughcurve;
167         struct CurveMapping *twistcurve;
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 totpart, partsize;
250         int flag;
251         int totpoint, totve;
252 } ParticleDrawData;
253
254 #define PARTICLE_DRAW_DATA_UPDATED  1
255
256 #define PSYS_FRAND_COUNT    1024
257 extern unsigned int PSYS_FRAND_SEED_OFFSET[PSYS_FRAND_COUNT];
258 extern unsigned int PSYS_FRAND_SEED_MULTIPLIER[PSYS_FRAND_COUNT];
259 extern float PSYS_FRAND_BASE[PSYS_FRAND_COUNT];
260
261 void psys_init_rng(void);
262
263 BLI_INLINE float psys_frand(ParticleSystem *psys, unsigned int seed)
264 {
265         /* XXX far from ideal, this simply scrambles particle random numbers a bit
266          * to avoid obvious correlations.
267          * Can't use previous psys->frand arrays because these require initialization
268          * inside psys_check_enabled, which wreaks havok in multithreaded depgraph updates.
269          */
270         unsigned int offset = PSYS_FRAND_SEED_OFFSET[psys->seed % PSYS_FRAND_COUNT];
271         unsigned int multiplier = PSYS_FRAND_SEED_MULTIPLIER[psys->seed % PSYS_FRAND_COUNT];
272         return PSYS_FRAND_BASE[(offset + seed * multiplier) % PSYS_FRAND_COUNT];
273 }
274
275 BLI_INLINE void psys_frand_vec(ParticleSystem *psys, unsigned int seed, float vec[3])
276 {
277         unsigned int offset = PSYS_FRAND_SEED_OFFSET[psys->seed % PSYS_FRAND_COUNT];
278         unsigned int multiplier = PSYS_FRAND_SEED_MULTIPLIER[psys->seed % PSYS_FRAND_COUNT];
279         vec[0] = PSYS_FRAND_BASE[(offset + (seed + 0) * multiplier) % PSYS_FRAND_COUNT];
280         vec[1] = PSYS_FRAND_BASE[(offset + (seed + 1) * multiplier) % PSYS_FRAND_COUNT];
281         vec[2] = PSYS_FRAND_BASE[(offset + (seed + 2) * multiplier) % PSYS_FRAND_COUNT];
282 }
283
284 /* ----------- functions needed outside particlesystem ---------------- */
285 /* particle.c */
286 int count_particles(struct ParticleSystem *psys);
287 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
288
289 int psys_get_child_number(struct Scene *scene, struct ParticleSystem *psys);
290 int psys_get_tot_child(struct Scene *scene, struct ParticleSystem *psys);
291
292 struct ParticleSystem *psys_get_current(struct Object *ob);
293 /* for rna */
294 short psys_get_current_num(struct Object *ob);
295 void psys_set_current_num(Object *ob, int index);
296 /* UNUSED */
297 // struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
298
299 struct LatticeDeformData *psys_create_lattice_deform_data(struct ParticleSimulationData *sim);
300
301 bool psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
302 bool psys_check_enabled(struct Object *ob, struct ParticleSystem *psys, const bool use_render_params);
303 bool psys_check_edited(struct ParticleSystem *psys);
304
305 void psys_check_group_weights(struct ParticleSettings *part);
306 int psys_uses_gravity(struct ParticleSimulationData *sim);
307 void BKE_particlesettings_fluid_default_settings(struct ParticleSettings *part);
308
309 /* free */
310 void BKE_particlesettings_free(struct ParticleSettings *part);
311 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
312 void psys_free(struct Object *ob, struct ParticleSystem *psys);
313
314 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[4][4], float winmat[4][4], int winx, int winy, int timeoffset);
315 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
316 bool psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
317
318 void psys_interpolate_uvs(const struct MTFace *tface, int quad, const float w[4], float uvco[2]);
319 void psys_interpolate_mcol(const struct MCol *mcol, int quad, const float w[4], struct MCol *mc);
320
321 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
322
323 CustomDataMask psys_emitter_customdata_mask(struct ParticleSystem *psys);
324 void psys_particle_on_emitter(struct ParticleSystemModifierData *psmd, int distr, int index, int index_dmcache,
325                               float fuv[4], float foffset, float vec[3], float nor[3],
326                               float utan[3], float vtan[3], float orco[3], float ornor[3]);
327 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
328
329 struct ModifierData *object_add_particle_system(
330         struct Main *bmain, struct Scene *scene, struct Object *ob, const char *name);
331 void object_remove_particle_system(struct Main *bmain, struct Scene *scene, struct Object *ob);
332 struct ParticleSettings *BKE_particlesettings_add(struct Main *bmain, 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 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 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 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 Main *bmain, 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);
444
445 typedef struct ParticleRenderElem {
446         int curchild, totchild, reduce;
447         float lambda, t, scalemin, scalemax;
448 } ParticleRenderElem;
449
450 typedef struct ParticleRenderData {
451         ChildParticle *child;
452         ParticleCacheKey **pathcache;
453         ParticleCacheKey **childcache;
454         ListBase pathcachebufs, childcachebufs;
455         int totchild, totcached, totchildcache;
456         struct DerivedMesh *dm;
457         int totdmvert, totdmedge, totdmface;
458
459         float mat[4][4];
460         float viewmat[4][4], winmat[4][4];
461         int winx, winy;
462
463         int do_simplify;
464         int timeoffset;
465         ParticleRenderElem *elems;
466
467         /* ORIGINDEX */
468         const int *index_mf_to_mpoly;
469         const int *index_mp_to_orig;
470 } ParticleRenderData;
471
472 /* psys_reset */
473 #define PSYS_RESET_ALL          1
474 #define PSYS_RESET_DEPSGRAPH    2
475 /* #define PSYS_RESET_CHILDREN  3 */ /*UNUSED*/
476 #define PSYS_RESET_CACHE_MISS   4
477
478 /* index_dmcache */
479 #define DMCACHE_NOTFOUND    -1
480 #define DMCACHE_ISCHILD     -2
481
482 /* **** Depsgraph evaluation **** */
483
484 struct EvaluationContext;
485
486 void BKE_particle_system_eval_init(struct EvaluationContext *eval_ctx,
487                                    struct Scene *scene,
488                                    struct Object *ob);
489
490 #endif