Moved particle code for distributions into own file to make hacking
[blender-staging.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 struct ParticleSystemModifierData;
43 struct ParticleSystem;
44 struct ParticleKey;
45 struct ParticleSettings;
46 struct HairKey;
47
48 struct Main;
49 struct Group;
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 IpoCurve;
59 struct LatticeDeformData;
60 struct LinkNode;
61 struct KDTree;
62 struct RNG;
63 struct SurfaceModifierData;
64 struct BVHTreeRay;
65 struct BVHTreeRayHit; 
66 struct EdgeHash;
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, 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, effector;  /* used in path caching */
114         float rough1, rough2, roughe;         /* used in path caching */
115 } ParticleTexture;
116
117 typedef struct ParticleSeam {
118         float v0[3], v1[3];
119         float nor[3], dir[3], tan[3];
120         float length2;
121 } ParticleSeam;
122
123 typedef struct ParticleCacheKey {
124         float co[3];
125         float vel[3];
126         float rot[4];
127         float col[3];
128         float time;
129         int steps;
130 } ParticleCacheKey;
131
132 typedef struct ParticleThreadContext {
133         /* shared */
134         struct ParticleSimulationData sim;
135         struct DerivedMesh *dm;
136         struct Material *ma;
137
138         /* distribution */
139         struct KDTree *tree;
140
141         struct ParticleSeam *seams;
142         int totseam;
143
144         float *jit, *jitoff, *weight;
145         float maxweight;
146         int *index, *skip, jitlevel;
147
148         int from, cfrom, distr;
149
150         struct ParticleData *tpars;
151
152         /* path caching */
153         int editupdate, between, steps;
154         int totchild, totparent, parent_pass;
155
156         float cfra;
157
158         float *vg_length, *vg_clump, *vg_kink;
159         float *vg_rough1, *vg_rough2, *vg_roughe;
160         float *vg_effector;
161 } ParticleThreadContext;
162
163 typedef struct ParticleTask {
164         ParticleThreadContext *ctx;
165         struct RNG *rng, *rng_path;
166         int begin, end;
167 } ParticleTask;
168
169 typedef struct ParticleBillboardData {
170         struct Object *ob;
171         float vec[3], vel[3];
172         float offset[2];
173         float size[2];
174         float tilt, random, time;
175         int uv[3];
176         int lock, num;
177         int totnum;
178         int lifetime;
179         short align, uv_split, anim, split_offset;
180 } ParticleBillboardData;
181
182 typedef struct ParticleCollisionElement {
183         /* pointers to original data */
184         float *x[4], *v[4];
185
186         /* values interpolated from original data*/
187         float x0[3], x1[3], x2[3], p[3];
188         
189         /* results for found intersection point */
190         float nor[3], vel[3], uv[2];
191
192         /* count of original data (1-4) */
193         int tot;
194
195         /* index of the collision face */
196         int index;
197
198         /* flags for inversed normal / particle already inside element at start */
199         short inv_nor, inside;
200 } ParticleCollisionElement;
201
202 /* container for moving data between deflet_particle and particle_intersect_face */
203 typedef struct ParticleCollision {
204         struct Object *current;
205         struct Object *hit;
206         struct Object *prev;
207         struct Object *skip;
208         struct Object *emitter;
209
210         struct CollisionModifierData *md; // collision modifier for current object;
211
212         float f;    // time factor of previous collision, needed for substracting face velocity
213         float fac1, fac2;
214
215         float cfra, old_cfra;
216
217         float original_ray_length; //original length of co2-co1, needed for collision time evaluation
218
219         int prev_index;
220
221         ParticleCollisionElement pce;
222
223         /* total_time is the amount of time in this subframe
224          * inv_total_time is the opposite
225          * inv_timestep is the inverse of the amount of time in this frame */
226         float total_time, inv_total_time, inv_timestep;
227
228         float radius;
229         float co1[3], co2[3];
230         float ve1[3], ve2[3];
231
232         float acc[3], boid_z;
233
234         int boid;
235 } ParticleCollision;
236
237 typedef struct ParticleDrawData {
238         float *vdata, *vd;      /* vertice data */
239         float *ndata, *nd;      /* normal data */
240         float *cdata, *cd;      /* color data */
241         float *vedata, *ved;    /* velocity data */
242         float *ma_col;
243         int tot_vec_size, flag;
244         int totpoint, totve;
245 } ParticleDrawData;
246
247 #define PARTICLE_DRAW_DATA_UPDATED  1
248
249 #define PSYS_FRAND_COUNT    1024
250 extern unsigned int PSYS_FRAND_SEED_OFFSET[PSYS_FRAND_COUNT];
251 extern unsigned int PSYS_FRAND_SEED_MULTIPLIER[PSYS_FRAND_COUNT];
252 extern float PSYS_FRAND_BASE[PSYS_FRAND_COUNT];
253
254 void psys_init_rng(void);
255
256 BLI_INLINE float psys_frand(ParticleSystem *psys, unsigned int seed)
257 {
258         /* XXX far from ideal, this simply scrambles particle random numbers a bit
259          * to avoid obvious correlations.
260          * Can't use previous psys->frand arrays because these require initialization
261          * inside psys_check_enabled, which wreaks havok in multithreaded depgraph updates.
262          */
263         unsigned int offset = PSYS_FRAND_SEED_OFFSET[psys->seed % PSYS_FRAND_COUNT];
264         unsigned int multiplier = PSYS_FRAND_SEED_MULTIPLIER[psys->seed % PSYS_FRAND_COUNT];
265         return PSYS_FRAND_BASE[(offset + seed * multiplier) % PSYS_FRAND_COUNT];
266 }
267
268 BLI_INLINE void psys_frand_vec(ParticleSystem *psys, unsigned int seed, float vec[3])
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         vec[0] = PSYS_FRAND_BASE[(offset + (seed + 0) * multiplier) % PSYS_FRAND_COUNT];
273         vec[1] = PSYS_FRAND_BASE[(offset + (seed + 1) * multiplier) % PSYS_FRAND_COUNT];
274         vec[2] = PSYS_FRAND_BASE[(offset + (seed + 2) * multiplier) % PSYS_FRAND_COUNT];
275 }
276
277 /* ----------- functions needed outside particlesystem ---------------- */
278 /* particle.c */
279 int count_particles(struct ParticleSystem *psys);
280 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
281
282 int psys_get_child_number(struct Scene *scene, struct ParticleSystem *psys);
283 int psys_get_tot_child(struct Scene *scene, struct ParticleSystem *psys);
284
285 struct ParticleSystem *psys_get_current(struct Object *ob);
286 /* for rna */
287 short psys_get_current_num(struct Object *ob);
288 void psys_set_current_num(Object *ob, int index);
289 /* UNUSED */
290 // struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
291
292 struct LatticeDeformData *psys_create_lattice_deform_data(struct ParticleSimulationData *sim);
293
294 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
295 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
296 int psys_check_edited(struct ParticleSystem *psys);
297
298 void psys_check_group_weights(struct ParticleSettings *part);
299 int psys_uses_gravity(struct ParticleSimulationData *sim);
300
301 /* free */
302 void BKE_particlesettings_free(struct ParticleSettings *part);
303 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
304 void psys_free(struct Object *ob, struct ParticleSystem *psys);
305
306 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[4][4], float winmat[4][4], int winx, int winy, int timeoffset);
307 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
308 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
309 bool psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
310
311 void psys_interpolate_uvs(const struct MTFace *tface, int quad, const float w[4], float uvco[2]);
312 void psys_interpolate_mcol(const struct MCol *mcol, int quad, const float w[4], struct MCol *mc);
313
314 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
315
316 void psys_particle_on_emitter(struct ParticleSystemModifierData *psmd, int distr, int index, int index_dmcache,
317                               float fuv[4], float foffset, float vec[3], float nor[3],
318                               float utan[3], float vtan[3], float orco[3], float ornor[3]);
319 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
320
321 struct ModifierData *object_add_particle_system(struct Scene *scene, struct Object *ob, const char *name);
322 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
323 struct ParticleSettings *psys_new_settings(const char *name, struct Main *main);
324 struct ParticleSettings *BKE_particlesettings_copy(struct ParticleSettings *part);
325 void BKE_particlesettings_make_local(struct ParticleSettings *part);
326
327 void psys_reset(struct ParticleSystem *psys, int mode);
328
329 void psys_find_parents(struct ParticleSimulationData *sim);
330
331 void psys_cache_paths(struct ParticleSimulationData *sim, float cfra);
332 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra);
333 void psys_cache_child_paths(struct ParticleSimulationData *sim, float cfra, int editupdate);
334 int do_guides(struct ListBase *effectors, ParticleKey *state, int pa_num, float time);
335 void precalc_guides(struct ParticleSimulationData *sim, struct ListBase *effectors);
336 float psys_get_timestep(struct ParticleSimulationData *sim);
337 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
338 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
339 void psys_get_particle_on_path(struct ParticleSimulationData *sim, int pa_num, struct ParticleKey *state, const bool vel);
340 int psys_get_particle_state(struct ParticleSimulationData *sim, int p, struct ParticleKey *state, int always);
341
342 void psys_sph_init(struct ParticleSimulationData *sim, struct SPHData *sphdata);
343 void psys_sph_finalise(struct SPHData *sphdata);
344 void psys_sph_density(struct BVHTree *tree, struct SPHData *data, float co[3], float vars[2]);
345
346 /* for anim.c */
347 void psys_get_dupli_texture(struct ParticleSystem *psys, struct ParticleSettings *part,
348                             struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa,
349                             float uv[2], float orco[3]);
350 void psys_get_dupli_path_transform(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ChildParticle *cpa,
351                                    struct ParticleCacheKey *cache, float mat[4][4], float *scale);
352
353 void psys_thread_context_init(struct ParticleThreadContext *ctx, struct ParticleSimulationData *sim);
354 void psys_tasks_create(struct ParticleThreadContext *ctx, int totpart, struct ParticleTask **r_tasks, int *r_numtasks);
355 void psys_tasks_free(struct ParticleTask *tasks, int numtasks);
356
357 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
358 void psys_apply_hair_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
359
360 /* particle_system.c */
361 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
362 void psys_count_keyed_targets(struct ParticleSimulationData *sim);
363 void psys_update_particle_tree(struct ParticleSystem *psys, float cfra);
364 void psys_changed_type(struct Object *ob, struct ParticleSystem *psys);
365
366 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
367 void psys_get_pointcache_start_end(struct Scene *scene, ParticleSystem *psys, int *sfra, int *efra);
368
369 void psys_check_boid_data(struct ParticleSystem *psys);
370
371 void psys_get_birth_coords(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, float dtime, float cfra);
372
373 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
374
375 /* ----------- functions needed only inside particlesystem ------------ */
376 /* particle.c */
377 void psys_disable_all(struct Object *ob);
378 void psys_enable_all(struct Object *ob);
379
380 void free_hair(struct Object *ob, struct ParticleSystem *psys, int dynamics);
381 void free_keyed_keys(struct ParticleSystem *psys);
382 void psys_free_particles(struct ParticleSystem *psys);
383 void psys_free_children(struct ParticleSystem *psys);
384
385 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, bool velocity);
386 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float vec[3]);
387 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[4][4]);
388 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[4][4]);
389 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[4][4]);
390
391 float psys_get_dietime_from_cache(struct PointCache *cache, int index);
392
393 void psys_free_pdd(struct ParticleSystem *psys);
394
395 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
396 void psys_get_texture(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleTexture *ptex, int event, float cfra);
397 void psys_interpolate_face(struct MVert *mvert, struct MFace *mface, struct MTFace *tface,
398                            float (*orcodata)[3], float w[4], float vec[3], float nor[3], float utan[3], float vtan[3],
399                            float orco[3], float ornor[3]);
400 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
401 void psys_get_from_key(struct ParticleKey *key, float loc[3], float vel[3], float rot[4], float *time);
402
403 /* BLI_bvhtree_ray_cast callback */
404 void BKE_psys_collision_neartest_cb(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
405 void psys_particle_on_dm(struct DerivedMesh *dm, int from, int index, int index_dmcache,
406                          const float fw[4], float foffset, float vec[3], float nor[3], float utan[3], float vtan[3],
407                          float orco[3], float ornor[3]);
408
409 /* particle_system.c */
410 void distribute_particles(struct ParticleSimulationData *sim, int from);
411 void initialize_particle(struct ParticleSimulationData *sim, struct ParticleData *pa);
412 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
413 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, const float fw[4], struct LinkNode *node);
414
415 void reset_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, float dtime, float cfra);
416
417 float psys_get_current_display_percentage(struct ParticleSystem *psys);
418
419 /* psys_reset */
420 #define PSYS_RESET_ALL          1
421 #define PSYS_RESET_DEPSGRAPH    2
422 /* #define PSYS_RESET_CHILDREN  3 */ /*UNUSED*/
423 #define PSYS_RESET_CACHE_MISS   4
424
425 /* index_dmcache */
426 #define DMCACHE_NOTFOUND    -1
427 #define DMCACHE_ISCHILD     -2
428
429 #endif