synched with trunk at revision 34793
[blender.git] / source / blender / blenkernel / BKE_particle.h
1 /* BKE_particle.h
2  *
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * The Original Code is Copyright (C) 2007 by Janne Karhu.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #ifndef BKE_PARTICLE_H
33 #define BKE_PARTICLE_H
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 #define LOOP_DYNAMIC_PARTICLES for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++) if(pa->state.time > 0.f)
67
68 #define PSYS_FRAND_COUNT        1024
69 #define PSYS_FRAND(seed)        psys->frand[(seed) % PSYS_FRAND_COUNT]
70
71 /* fast but sure way to get the modifier*/
72 #define PARTICLE_PSMD ParticleSystemModifierData *psmd = sim->psmd ? sim->psmd : psys_get_modifier(sim->ob, sim->psys)
73
74 /* common stuff that many particle functions need */
75 typedef struct ParticleSimulationData {
76         struct Scene *scene;
77         struct Object *ob;
78         struct ParticleSystem *psys;
79         struct ParticleSystemModifierData *psmd;
80         struct ListBase *colliders;
81 } ParticleSimulationData;
82
83 //typedef struct ParticleReactEvent {
84 //      struct ParticleReactEvent *next, *prev;
85 //      int event, pa_num;
86 //      Object *ob;
87 //      struct ParticleSystem *psys;
88 //      struct ParticleKey state;
89 //
90 //      float time, size;
91 //}ParticleReactEvent;
92
93 typedef struct ParticleTexture{
94         float ivel;                                                     /* used in reset */
95         float time, life, exist, size;          /* used in init */
96         float pvel[3];                                          /* used in physics */
97         float length, clump, kink, effector;/* used in path caching */
98         float rough1, rough2, roughe;           /* used in path caching */
99 } ParticleTexture;
100
101 typedef struct ParticleSeam{
102         float v0[3], v1[3];
103         float nor[3], dir[3], tan[3];
104         float length2;
105 } ParticleSeam;
106
107 typedef struct ParticleCacheKey{
108         float co[3];
109         float vel[3];
110         float rot[4];
111         float col[3];
112         float time;
113         int steps;
114 } ParticleCacheKey;
115
116 typedef struct ParticleThreadContext {
117         /* shared */
118         struct ParticleSimulationData sim;
119         struct DerivedMesh *dm;
120         struct Material *ma;
121
122         /* distribution */
123         struct KDTree *tree;
124
125         struct ParticleSeam *seams;
126         int totseam;
127
128         float *jit, *jitoff, *weight;
129         float maxweight;
130         int *index, *skip, jitlevel;
131
132         int from, cfrom, distr;
133
134         struct ParticleData *tpars;
135
136         /* path caching */
137         int editupdate, between, steps;
138         int totchild, totparent, parent_pass;
139
140         float cfra;
141
142         float *vg_length, *vg_clump, *vg_kink;
143         float *vg_rough1, *vg_rough2, *vg_roughe;
144         float *vg_effector;
145 } ParticleThreadContext;
146
147 typedef struct ParticleThread {
148         ParticleThreadContext *ctx;
149         struct RNG *rng, *rng_path;
150         int num, tot;
151 } ParticleThread;
152
153 typedef struct ParticleBillboardData
154 {
155         struct Object *ob;
156         float vec[3], vel[3];
157         float offset[2];
158         float size, tilt, random, time;
159         int uv[3];
160         int lock, num;
161         int totnum;
162         short align, uv_split, anim, split_offset;
163 } ParticleBillboardData;
164
165 /* container for moving data between deflet_particle and particle_intersect_face */
166 typedef struct ParticleCollision
167 {
168         struct Object *ob, *hit_ob; // collided and current objects
169         struct CollisionModifierData *md, *hit_md; // collision modifiers for current and hit object;
170         float nor[3]; // normal at collision point
171         float vel[3]; // velocity of collision point
172         float co1[3], co2[3]; // ray start and end points
173         float ve1[3], ve2[3]; // particle velocities
174         float ray_len; // original length of co2-co1, needed for collision time evaluation
175         float f;        // time factor of previous collision, needed for substracting face velocity
176         float cfra; // start of the timestep (during frame change, since previous integer frame)
177         float dfra; // duration of timestep in frames
178 } ParticleCollision;
179
180 typedef struct ParticleDrawData {
181         float *vdata, *vd;              /* vertice data */
182         float *ndata, *nd;              /* normal data */
183         float *cdata, *cd;              /* color data */
184         float *vedata, *ved;    /* velocity data */
185         float *ma_r, *ma_g, *ma_b;
186         int tot_vec_size, flag;
187         int totpoint, totve;
188 } ParticleDrawData;
189
190 #define PARTICLE_DRAW_DATA_UPDATED  1
191
192 /* ----------- functions needed outside particlesystem ---------------- */
193 /* particle.c */
194 int count_particles(struct ParticleSystem *psys);
195 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
196
197 struct ParticleSystem *psys_get_current(struct Object *ob);
198 /* for rna */
199 short psys_get_current_num(struct Object *ob);
200 void psys_set_current_num(Object *ob, int index);
201 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
202
203 struct Object *psys_get_lattice(struct ParticleSimulationData *sim);
204
205 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
206 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
207 int psys_check_edited(struct ParticleSystem *psys);
208
209 void psys_check_group_weights(struct ParticleSettings *part);
210 int psys_uses_gravity(struct ParticleSimulationData *sim);
211
212 /* free */
213 void psys_free_settings(struct ParticleSettings *part);
214 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
215 void psys_free(struct Object * ob, struct ParticleSystem * psys);
216
217 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
218 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
219 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
220 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
221
222 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
223 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
224
225 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
226
227 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);
228 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
229
230 struct ModifierData *object_add_particle_system(struct Scene *scene, struct Object *ob, const char *name);
231 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
232 struct ParticleSettings *psys_new_settings(const char *name, struct Main *main);
233 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
234 void make_local_particlesettings(struct ParticleSettings *part);
235
236 void psys_reset(struct ParticleSystem *psys, int mode);
237
238 void psys_find_parents(struct ParticleSimulationData *sim);
239
240 void psys_cache_paths(struct ParticleSimulationData *sim, float cfra);
241 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra);
242 void psys_cache_child_paths(struct ParticleSimulationData *sim, float cfra, int editupdate);
243 int do_guides(struct ListBase *effectors, ParticleKey *state, int pa_num, float time);
244 void precalc_guides(struct ParticleSimulationData *sim, struct ListBase *effectors);
245 float psys_get_timestep(struct ParticleSimulationData *sim);
246 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
247 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
248 void psys_get_particle_on_path(struct ParticleSimulationData *sim, int pa_num, struct ParticleKey *state, int vel);
249 int psys_get_particle_state(struct ParticleSimulationData *sim, int p, struct ParticleKey *state, int always);
250
251 /* for anim.c */
252 void psys_get_dupli_texture(struct Object *ob, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
253 void psys_get_dupli_path_transform(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ChildParticle *cpa, struct ParticleCacheKey *cache, float mat[][4], float *scale);
254
255 ParticleThread *psys_threads_create(struct ParticleSimulationData *sim);
256 void psys_threads_free(ParticleThread *threads);
257
258 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
259 void psys_apply_hair_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
260
261 /* particle_system.c */
262 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
263 void psys_count_keyed_targets(struct ParticleSimulationData *sim);
264 void psys_update_particle_tree(struct ParticleSystem *psys, float cfra);
265
266 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
267 void psys_get_pointcache_start_end(struct Scene *scene, ParticleSystem *psys, int *sfra, int *efra);
268
269 void psys_check_boid_data(struct ParticleSystem *psys);
270
271 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
272
273 /* ----------- functions needed only inside particlesystem ------------ */
274 /* particle.c */
275 void psys_disable_all(struct Object *ob);
276 void psys_enable_all(struct Object *ob);
277
278 void free_hair(struct Object *ob, struct ParticleSystem *psys, int dynamics);
279 void free_keyed_keys(struct ParticleSystem *psys);
280 void psys_free_particles(struct ParticleSystem *psys);
281 void psys_free_children(struct ParticleSystem *psys);
282
283 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
284 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
285 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
286 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
287 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
288
289 float psys_get_dietime_from_cache(struct PointCache *cache, int index);
290
291 void psys_free_pdd(struct ParticleSystem *psys);
292
293 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
294 void psys_get_texture(struct ParticleSimulationData *sim, struct Material *ma, struct ParticleData *pa, struct ParticleTexture *ptex, int event);
295 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);
296 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
297 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
298
299 /* only in edisparticle.c*/
300 int psys_intersect_dm(struct Scene *scene, struct Object *ob, struct DerivedMesh *dm, float *vert_cos, float *co1, float* co2, float *min_d, int *min_face, float *min_uv, float *face_minmax, float *pa_minmax, float radius, float *ipoint);
301 /* BLI_bvhtree_ray_cast callback */
302 void particle_intersect_face(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
303 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);
304
305 /* particle_system.c */
306 void initialize_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, int p);
307 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
308 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
309
310 void reset_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, float dtime, float cfra);
311
312 /* psys_reset */
313 #define PSYS_RESET_ALL                  1
314 #define PSYS_RESET_DEPSGRAPH    2
315 /* #define PSYS_RESET_CHILDREN  3 */ /*UNUSED*/
316 #define PSYS_RESET_CACHE_MISS   4
317
318 /* index_dmcache */
319 #define DMCACHE_NOTFOUND        -1
320 #define DMCACHE_ISCHILD         -2
321
322 #endif