Merging trunk into soc-2011-tomato up to revision 40540
[blender.git] / source / blender / blenkernel / BKE_particle.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2007 by Janne Karhu.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
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 "DNA_particle_types.h"
38 #include "DNA_object_types.h"
39
40 struct ParticleSystemModifierData;
41 struct ParticleSystem;
42 struct ParticleKey;
43 struct ParticleSettings;
44 struct HairKey;
45
46 struct Main;
47 struct Group;
48 struct Object;
49 struct Scene;
50 struct DerivedMesh;
51 struct ModifierData;
52 struct MTFace;
53 struct MCol;
54 struct MFace;
55 struct MVert;
56 struct IpoCurve;
57 struct LinkNode;
58 struct KDTree;
59 struct RNG;
60 struct SurfaceModifierData;
61 struct BVHTreeRay;
62 struct BVHTreeRayHit; 
63
64 #define PARTICLE_P                              ParticleData *pa; int p
65 #define LOOP_PARTICLES  for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++)
66 #define LOOP_EXISTING_PARTICLES for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++) if(!(pa->flag & PARS_UNEXIST))
67 #define LOOP_SHOWN_PARTICLES for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++) if(!(pa->flag & (PARS_UNEXIST|PARS_NO_DISP)))
68 #define LOOP_DYNAMIC_PARTICLES for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++) if(pa->state.time > 0.f)
69
70 #define PSYS_FRAND_COUNT        1024
71 #define PSYS_FRAND(seed)        psys->frand[(seed) % PSYS_FRAND_COUNT]
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 ParticleTexture{
90         float ivel;                                                     /* used in reset */
91         float time, life, exist, size;          /* used in init */
92         float damp, gravity, field;                     /* used in physics */
93         float length, clump, kink, effector;/* used in path caching */
94         float rough1, rough2, roughe;           /* used in path caching */
95 } ParticleTexture;
96
97 typedef struct ParticleSeam{
98         float v0[3], v1[3];
99         float nor[3], dir[3], tan[3];
100         float length2;
101 } ParticleSeam;
102
103 typedef struct ParticleCacheKey{
104         float co[3];
105         float vel[3];
106         float rot[4];
107         float col[3];
108         float time;
109         int steps;
110 } ParticleCacheKey;
111
112 typedef struct ParticleThreadContext {
113         /* shared */
114         struct ParticleSimulationData sim;
115         struct DerivedMesh *dm;
116         struct Material *ma;
117
118         /* distribution */
119         struct KDTree *tree;
120
121         struct ParticleSeam *seams;
122         int totseam;
123
124         float *jit, *jitoff, *weight;
125         float maxweight;
126         int *index, *skip, jitlevel;
127
128         int from, cfrom, distr;
129
130         struct ParticleData *tpars;
131
132         /* path caching */
133         int editupdate, between, steps;
134         int totchild, totparent, parent_pass;
135
136         float cfra;
137
138         float *vg_length, *vg_clump, *vg_kink;
139         float *vg_rough1, *vg_rough2, *vg_roughe;
140         float *vg_effector;
141 } ParticleThreadContext;
142
143 typedef struct ParticleThread {
144         ParticleThreadContext *ctx;
145         struct RNG *rng, *rng_path;
146         int num, tot;
147 } ParticleThread;
148
149 typedef struct ParticleBillboardData
150 {
151         struct Object *ob;
152         float vec[3], vel[3];
153         float offset[2];
154         float size[2];
155         float tilt, random, time;
156         int uv[3];
157         int lock, num;
158         int totnum;
159         int lifetime;
160         short align, uv_split, anim, split_offset;
161 } ParticleBillboardData;
162
163 typedef struct ParticleCollisionElement
164 {
165         /* pointers to original data */
166         float *x[4], *v[4];
167
168         /* values interpolated from original data*/
169         float x0[3], x1[3], x2[3], p[3];
170         
171         /* results for found intersection point */
172         float nor[3], vel[3], uv[2];
173
174         /* count of original data (1-4) */
175         int tot;
176
177         /* index of the collision face */
178         int index;
179
180         /* flags for inversed normal / particle already inside element at start */
181         short inv_nor, inside;
182 } ParticleCollisionElement;
183
184 /* container for moving data between deflet_particle and particle_intersect_face */
185 typedef struct ParticleCollision
186 {
187         struct Object *current;
188         struct Object *hit;
189         struct Object *prev;
190         struct Object *skip;
191         struct Object *emitter;
192
193         struct CollisionModifierData *md; // collision modifier for current object;
194
195         float f;        // time factor of previous collision, needed for substracting face velocity
196         float fac1, fac2;
197
198         float cfra, old_cfra;
199
200         float original_ray_length; //original length of co2-co1, needed for collision time evaluation
201
202         int prev_index;
203
204         ParticleCollisionElement pce;
205
206         float total_time, inv_timestep;
207
208         float radius;
209         float co1[3], co2[3];
210         float ve1[3], ve2[3];
211
212         float acc[3], boid_z;
213
214         int boid;
215 } ParticleCollision;
216
217 typedef struct ParticleDrawData {
218         float *vdata, *vd;              /* vertice data */
219         float *ndata, *nd;              /* normal data */
220         float *cdata, *cd;              /* color data */
221         float *vedata, *ved;    /* velocity data */
222         float *ma_r, *ma_g, *ma_b;
223         int tot_vec_size, flag;
224         int totpoint, totve;
225 } ParticleDrawData;
226
227 #define PARTICLE_DRAW_DATA_UPDATED  1
228
229 /* ----------- functions needed outside particlesystem ---------------- */
230 /* particle.c */
231 int count_particles(struct ParticleSystem *psys);
232 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
233
234 struct ParticleSystem *psys_get_current(struct Object *ob);
235 /* for rna */
236 short psys_get_current_num(struct Object *ob);
237 void psys_set_current_num(Object *ob, int index);
238 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
239
240 struct Object *psys_get_lattice(struct ParticleSimulationData *sim);
241
242 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
243 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
244 int psys_check_edited(struct ParticleSystem *psys);
245
246 void psys_check_group_weights(struct ParticleSettings *part);
247 int psys_uses_gravity(struct ParticleSimulationData *sim);
248
249 /* free */
250 void psys_free_settings(struct ParticleSettings *part);
251 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
252 void psys_free(struct Object * ob, struct ParticleSystem * psys);
253
254 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
255 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
256 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
257 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
258
259 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
260 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
261
262 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
263
264 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);
265 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
266
267 struct ModifierData *object_add_particle_system(struct Scene *scene, struct Object *ob, const char *name);
268 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
269 struct ParticleSettings *psys_new_settings(const char *name, struct Main *main);
270 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
271 void make_local_particlesettings(struct ParticleSettings *part);
272
273 void psys_reset(struct ParticleSystem *psys, int mode);
274
275 void psys_find_parents(struct ParticleSimulationData *sim);
276
277 void psys_cache_paths(struct ParticleSimulationData *sim, float cfra);
278 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra);
279 void psys_cache_child_paths(struct ParticleSimulationData *sim, float cfra, int editupdate);
280 int do_guides(struct ListBase *effectors, ParticleKey *state, int pa_num, float time);
281 void precalc_guides(struct ParticleSimulationData *sim, struct ListBase *effectors);
282 float psys_get_timestep(struct ParticleSimulationData *sim);
283 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
284 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
285 void psys_get_particle_on_path(struct ParticleSimulationData *sim, int pa_num, struct ParticleKey *state, int vel);
286 int psys_get_particle_state(struct ParticleSimulationData *sim, int p, struct ParticleKey *state, int always);
287
288 /* for anim.c */
289 void psys_get_dupli_texture(struct ParticleSystem *psys, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
290 void psys_get_dupli_path_transform(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ChildParticle *cpa, struct ParticleCacheKey *cache, float mat[][4], float *scale);
291
292 ParticleThread *psys_threads_create(struct ParticleSimulationData *sim);
293 void psys_threads_free(ParticleThread *threads);
294
295 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
296 void psys_apply_hair_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
297
298 /* particle_system.c */
299 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
300 void psys_count_keyed_targets(struct ParticleSimulationData *sim);
301 void psys_update_particle_tree(struct ParticleSystem *psys, float cfra);
302
303 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
304 void psys_get_pointcache_start_end(struct Scene *scene, ParticleSystem *psys, int *sfra, int *efra);
305
306 void psys_check_boid_data(struct ParticleSystem *psys);
307
308 void psys_get_birth_coordinates(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, float dtime, float cfra);
309
310 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
311
312 /* ----------- functions needed only inside particlesystem ------------ */
313 /* particle.c */
314 void psys_disable_all(struct Object *ob);
315 void psys_enable_all(struct Object *ob);
316
317 void free_hair(struct Object *ob, struct ParticleSystem *psys, int dynamics);
318 void free_keyed_keys(struct ParticleSystem *psys);
319 void psys_free_particles(struct ParticleSystem *psys);
320 void psys_free_children(struct ParticleSystem *psys);
321
322 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
323 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
324 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
325 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
326 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
327
328 float psys_get_dietime_from_cache(struct PointCache *cache, int index);
329
330 void psys_free_pdd(struct ParticleSystem *psys);
331
332 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
333 void psys_get_texture(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleTexture *ptex, int event, float cfra);
334 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);
335 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
336 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
337
338 /* BLI_bvhtree_ray_cast callback */
339 void BKE_psys_collision_neartest_cb(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
340 void psys_particle_on_dm(struct DerivedMesh *dm, int from, int index, int index_dmcache, float *fw, float foffset, float *vec, float *nor, float *utan, float *vtan, float *orco, float *ornor);
341
342 /* particle_system.c */
343 void initialize_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, int p);
344 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
345 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
346
347 void reset_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, float dtime, float cfra);
348
349 /* psys_reset */
350 #define PSYS_RESET_ALL                  1
351 #define PSYS_RESET_DEPSGRAPH    2
352 /* #define PSYS_RESET_CHILDREN  3 */ /*UNUSED*/
353 #define PSYS_RESET_CACHE_MISS   4
354
355 /* index_dmcache */
356 #define DMCACHE_NOTFOUND        -1
357 #define DMCACHE_ISCHILD         -2
358
359 #endif