code cleanup: header cleanup and remove some duplicate defines.
[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  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_PARTICLE_H__
29 #define __BKE_PARTICLE_H__
30
31 /** \file BKE_particle.h
32  *  \ingroup bke
33  */
34
35 #include "DNA_particle_types.h"
36 #include "DNA_object_types.h"
37
38 struct ParticleSystemModifierData;
39 struct ParticleSystem;
40 struct ParticleKey;
41 struct ParticleSettings;
42 struct HairKey;
43
44 struct Main;
45 struct Group;
46 struct Object;
47 struct Scene;
48 struct DerivedMesh;
49 struct ModifierData;
50 struct MTFace;
51 struct MCol;
52 struct MFace;
53 struct MVert;
54 struct IpoCurve;
55 struct LinkNode;
56 struct KDTree;
57 struct RNG;
58 struct SurfaceModifierData;
59 struct BVHTreeRay;
60 struct BVHTreeRayHit; 
61
62 #define PARTICLE_P              ParticleData * pa; int p
63 #define LOOP_PARTICLES  for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++)
64 #define LOOP_EXISTING_PARTICLES for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++) if (!(pa->flag & PARS_UNEXIST))
65 #define LOOP_SHOWN_PARTICLES for (p = 0, pa = psys->particles; p < psys->totpart; p++, pa++) if (!(pa->flag & (PARS_UNEXIST | PARS_NO_DISP)))
66 /* OpenMP: Can only advance one variable within loop definition. */
67 #define LOOP_DYNAMIC_PARTICLES for (p = 0; p < psys->totpart; p++) if ((pa = psys->particles + p)->state.time > 0.0f)
68
69 #define PSYS_FRAND_COUNT    1024
70 #define PSYS_FRAND(seed)    psys->frand[(seed) % PSYS_FRAND_COUNT]
71
72 /* fast but sure way to get the modifier*/
73 #define PARTICLE_PSMD ParticleSystemModifierData * psmd = sim->psmd ? sim->psmd : psys_get_modifier(sim->ob, sim->psys)
74
75 /* common stuff that many particle functions need */
76 typedef struct ParticleSimulationData {
77         struct Scene *scene;
78         struct Object *ob;
79         struct ParticleSystem *psys;
80         struct ParticleSystemModifierData *psmd;
81         struct ListBase *colliders;
82         /* Courant number. This is used to implement an adaptive time step. Only the
83          * maximum value per time step is important. Only sph_integrate makes use of
84          * this at the moment. Other solvers could, too. */
85         float courant_num;
86 } ParticleSimulationData;
87
88 typedef struct ParticleTexture {
89         float ivel;                           /* used in reset */
90         float time, life, exist, size;        /* used in init */
91         float damp, gravity, field;           /* used in physics */
92         float length, clump, kink, effector;  /* used in path caching */
93         float rough1, rough2, roughe;         /* used in path caching */
94 } ParticleTexture;
95
96 typedef struct ParticleSeam {
97         float v0[3], v1[3];
98         float nor[3], dir[3], tan[3];
99         float length2;
100 } ParticleSeam;
101
102 typedef struct ParticleCacheKey {
103         float co[3];
104         float vel[3];
105         float rot[4];
106         float col[3];
107         float time;
108         int steps;
109 } ParticleCacheKey;
110
111 typedef struct ParticleThreadContext {
112         /* shared */
113         struct ParticleSimulationData sim;
114         struct DerivedMesh *dm;
115         struct Material *ma;
116
117         /* distribution */
118         struct KDTree *tree;
119
120         struct ParticleSeam *seams;
121         int totseam;
122
123         float *jit, *jitoff, *weight;
124         float maxweight;
125         int *index, *skip, jitlevel;
126
127         int from, cfrom, distr;
128
129         struct ParticleData *tpars;
130
131         /* path caching */
132         int editupdate, between, steps;
133         int totchild, totparent, parent_pass;
134
135         float cfra;
136
137         float *vg_length, *vg_clump, *vg_kink;
138         float *vg_rough1, *vg_rough2, *vg_roughe;
139         float *vg_effector;
140 } ParticleThreadContext;
141
142 typedef struct ParticleThread {
143         ParticleThreadContext *ctx;
144         struct RNG *rng, *rng_path;
145         int num, tot;
146 } ParticleThread;
147
148 typedef struct ParticleBillboardData {
149         struct Object *ob;
150         float vec[3], vel[3];
151         float offset[2];
152         float size[2];
153         float tilt, random, time;
154         int uv[3];
155         int lock, num;
156         int totnum;
157         int lifetime;
158         short align, uv_split, anim, split_offset;
159 } ParticleBillboardData;
160
161 typedef struct ParticleCollisionElement {
162         /* pointers to original data */
163         float *x[4], *v[4];
164
165         /* values interpolated from original data*/
166         float x0[3], x1[3], x2[3], p[3];
167         
168         /* results for found intersection point */
169         float nor[3], vel[3], uv[2];
170
171         /* count of original data (1-4) */
172         int tot;
173
174         /* index of the collision face */
175         int index;
176
177         /* flags for inversed normal / particle already inside element at start */
178         short inv_nor, inside;
179 } ParticleCollisionElement;
180
181 /* container for moving data between deflet_particle and particle_intersect_face */
182 typedef struct ParticleCollision {
183         struct Object *current;
184         struct Object *hit;
185         struct Object *prev;
186         struct Object *skip;
187         struct Object *emitter;
188
189         struct CollisionModifierData *md; // collision modifier for current object;
190
191         float f;    // time factor of previous collision, needed for substracting face velocity
192         float fac1, fac2;
193
194         float cfra, old_cfra;
195
196         float original_ray_length; //original length of co2-co1, needed for collision time evaluation
197
198         int prev_index;
199
200         ParticleCollisionElement pce;
201
202         float total_time, inv_timestep;
203
204         float radius;
205         float co1[3], co2[3];
206         float ve1[3], ve2[3];
207
208         float acc[3], boid_z;
209
210         int boid;
211 } ParticleCollision;
212
213 typedef struct ParticleDrawData {
214         float *vdata, *vd;      /* vertice data */
215         float *ndata, *nd;      /* normal data */
216         float *cdata, *cd;      /* color data */
217         float *vedata, *ved;    /* velocity data */
218         float *ma_col;
219         int tot_vec_size, flag;
220         int totpoint, totve;
221 } ParticleDrawData;
222
223 #define PARTICLE_DRAW_DATA_UPDATED  1
224
225 /* ----------- functions needed outside particlesystem ---------------- */
226 /* particle.c */
227 int count_particles(struct ParticleSystem *psys);
228 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
229
230 struct ParticleSystem *psys_get_current(struct Object *ob);
231 /* for rna */
232 short psys_get_current_num(struct Object *ob);
233 void psys_set_current_num(Object *ob, int index);
234 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
235
236 struct Object *psys_get_lattice(struct ParticleSimulationData *sim);
237
238 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
239 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
240 int psys_check_edited(struct ParticleSystem *psys);
241
242 void psys_check_group_weights(struct ParticleSettings *part);
243 int psys_uses_gravity(struct ParticleSimulationData *sim);
244
245 /* free */
246 void BKE_particlesettings_free(struct ParticleSettings *part);
247 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
248 void psys_free(struct Object *ob, struct ParticleSystem *psys);
249
250 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
251 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
252 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
253 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
254
255 void psys_interpolate_uvs(const struct MTFace *tface, int quad, const float w[4], float uvco[2]);
256 void psys_interpolate_mcol(const struct MCol *mcol, int quad, const float w[4], struct MCol *mc);
257
258 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
259
260 void psys_particle_on_emitter(struct ParticleSystemModifierData *psmd, int distr, int index, int index_dmcache, float *fuv, float foffset, float *vec, float *nor, float *utan, float *vtan, float *orco, float *ornor);
261 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
262
263 struct ModifierData *object_add_particle_system(struct Scene *scene, struct Object *ob, const char *name);
264 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
265 struct ParticleSettings *psys_new_settings(const char *name, struct Main *main);
266 struct ParticleSettings *BKE_particlesettings_copy(struct ParticleSettings *part);
267 void BKE_particlesettings_make_local(struct ParticleSettings *part);
268
269 void psys_reset(struct ParticleSystem *psys, int mode);
270
271 void psys_find_parents(struct ParticleSimulationData *sim);
272
273 void psys_cache_paths(struct ParticleSimulationData *sim, float cfra);
274 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra);
275 void psys_cache_child_paths(struct ParticleSimulationData *sim, float cfra, int editupdate);
276 int do_guides(struct ListBase *effectors, ParticleKey *state, int pa_num, float time);
277 void precalc_guides(struct ParticleSimulationData *sim, struct ListBase *effectors);
278 float psys_get_timestep(struct ParticleSimulationData *sim);
279 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
280 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
281 void psys_get_particle_on_path(struct ParticleSimulationData *sim, int pa_num, struct ParticleKey *state, int vel);
282 int psys_get_particle_state(struct ParticleSimulationData *sim, int p, struct ParticleKey *state, int always);
283
284 /* for anim.c */
285 void psys_get_dupli_texture(struct ParticleSystem *psys, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
286 void psys_get_dupli_path_transform(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ChildParticle *cpa, struct ParticleCacheKey *cache, float mat[][4], float *scale);
287
288 ParticleThread *psys_threads_create(struct ParticleSimulationData *sim);
289 void psys_threads_free(ParticleThread *threads);
290
291 void psys_make_billboard(ParticleBillboardData * bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
292 void psys_apply_hair_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
293
294 /* particle_system.c */
295 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
296 void psys_count_keyed_targets(struct ParticleSimulationData *sim);
297 void psys_update_particle_tree(struct ParticleSystem *psys, float cfra);
298
299 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
300 void psys_get_pointcache_start_end(struct Scene *scene, ParticleSystem *psys, int *sfra, int *efra);
301
302 void psys_check_boid_data(struct ParticleSystem *psys);
303
304 void psys_get_birth_coordinates(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, float dtime, float cfra);
305
306 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
307
308 /* ----------- functions needed only inside particlesystem ------------ */
309 /* particle.c */
310 void psys_disable_all(struct Object *ob);
311 void psys_enable_all(struct Object *ob);
312
313 void free_hair(struct Object *ob, struct ParticleSystem *psys, int dynamics);
314 void free_keyed_keys(struct ParticleSystem *psys);
315 void psys_free_particles(struct ParticleSystem *psys);
316 void psys_free_children(struct ParticleSystem *psys);
317
318 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
319 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float vec[3]);
320 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
321 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
322 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
323
324 float psys_get_dietime_from_cache(struct PointCache *cache, int index);
325
326 void psys_free_pdd(struct ParticleSystem *psys);
327
328 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
329 void psys_get_texture(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleTexture *ptex, int event, float cfra);
330 void psys_interpolate_face(struct MVert *mvert, struct MFace *mface, struct MTFace *tface, float (*orcodata)[3], float *uv, float *vec, float *nor, float *utan, float *vtan, float *orco, float *ornor);
331 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
332 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
333
334 /* BLI_bvhtree_ray_cast callback */
335 void BKE_psys_collision_neartest_cb(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
336 void psys_particle_on_dm(struct DerivedMesh *dm, int from, int index, int index_dmcache, const float fw[4], float foffset, float vec[3], float nor[3], float utan[3], float vtan[3], float orco[3], float ornor[3]);
337
338 /* particle_system.c */
339 void initialize_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, int p);
340 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
341 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, const float fw[4], struct LinkNode *node);
342
343 void reset_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, float dtime, float cfra);
344
345 /* psys_reset */
346 #define PSYS_RESET_ALL          1
347 #define PSYS_RESET_DEPSGRAPH    2
348 /* #define PSYS_RESET_CHILDREN  3 */ /*UNUSED*/
349 #define PSYS_RESET_CACHE_MISS   4
350
351 /* index_dmcache */
352 #define DMCACHE_NOTFOUND    -1
353 #define DMCACHE_ISCHILD     -2
354
355 #endif