synched with trunk at revision 30597
[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
67 #define PSYS_FRAND_COUNT        1024
68 #define PSYS_FRAND(seed)        psys->frand[(seed) % PSYS_FRAND_COUNT]
69
70 /* fast but sure way to get the modifier*/
71 #define PARTICLE_PSMD ParticleSystemModifierData *psmd = sim->psmd ? sim->psmd : psys_get_modifier(sim->ob, sim->psys)
72
73 /* common stuff that many particle functions need */
74 typedef struct ParticleSimulationData {
75         struct Scene *scene;
76         struct Object *ob;
77         struct ParticleSystem *psys;
78         struct ParticleSystemModifierData *psmd;
79         struct ListBase *colliders;
80 } ParticleSimulationData;
81
82 //typedef struct ParticleReactEvent {
83 //      struct ParticleReactEvent *next, *prev;
84 //      int event, pa_num;
85 //      Object *ob;
86 //      struct ParticleSystem *psys;
87 //      struct ParticleKey state;
88 //
89 //      float time, size;
90 //}ParticleReactEvent;
91
92 typedef struct ParticleTexture{
93         float ivel;                                                     /* used in reset */
94         float time, life, exist, size;          /* used in init */
95         float pvel[3];                                          /* used in physics */
96         float length, clump, kink, effector;/* used in path caching */
97         float rough1, rough2, roughe;           /* used in path caching */
98 } ParticleTexture;
99
100 typedef struct ParticleSeam{
101         float v0[3], v1[3];
102         float nor[3], dir[3], tan[3];
103         float length2;
104 } ParticleSeam;
105
106 typedef struct ParticleCacheKey{
107         float co[3];
108         float vel[3];
109         float rot[4];
110         float col[3];
111         float time;
112         int steps;
113 } ParticleCacheKey;
114
115 typedef struct ParticleThreadContext {
116         /* shared */
117         struct ParticleSimulationData sim;
118         struct DerivedMesh *dm;
119         struct Material *ma;
120
121         /* distribution */
122         struct KDTree *tree;
123
124         struct ParticleSeam *seams;
125         int totseam;
126
127         float *jit, *jitoff, *weight;
128         float maxweight;
129         int *index, *skip, jitlevel;
130
131         int from, cfrom, distr;
132
133         struct ParticleData *tpars;
134
135         /* path caching */
136         int editupdate, between, steps;
137         int totchild, totparent, parent_pass;
138
139         float cfra;
140
141         float *vg_length, *vg_clump, *vg_kink;
142         float *vg_rough1, *vg_rough2, *vg_roughe;
143         float *vg_effector;
144 } ParticleThreadContext;
145
146 typedef struct ParticleThread {
147         ParticleThreadContext *ctx;
148         struct RNG *rng, *rng_path;
149         int num, tot;
150 } ParticleThread;
151
152 typedef struct ParticleBillboardData
153 {
154         struct Object *ob;
155         float vec[3], vel[3];
156         float offset[2];
157         float size, tilt, random, time;
158         int uv[3];
159         int lock, num;
160         int totnum;
161         short align, uv_split, anim, split_offset;
162 } ParticleBillboardData;
163
164 /* container for moving data between deflet_particle and particle_intersect_face */
165 typedef struct ParticleCollision
166 {
167         struct Object *ob, *hit_ob; // collided and current objects
168         struct CollisionModifierData *md, *hit_md; // collision modifiers for current and hit object;
169         float nor[3]; // normal at collision point
170         float vel[3]; // velocity of collision point
171         float co1[3], co2[3]; // ray start and end points
172         float ve1[3], ve2[3]; // particle velocities
173         float ray_len; // original length of co2-co1, needed for collision time evaluation
174         float t;        // time of previous collision, needed for substracting face velocity
175 } ParticleCollision;
176
177 typedef struct ParticleDrawData {
178         float *vdata, *vd;              /* vertice data */
179         float *ndata, *nd;              /* normal data */
180         float *cdata, *cd;              /* color data */
181         float *vedata, *ved;    /* velocity data */
182         float *ma_r, *ma_g, *ma_b;
183         int tot_vec_size, flag;
184         int totpoint, totve;
185 } ParticleDrawData;
186
187 #define PARTICLE_DRAW_DATA_UPDATED  1
188
189 /* ----------- functions needed outside particlesystem ---------------- */
190 /* particle.c */
191 int count_particles(struct ParticleSystem *psys);
192 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
193
194 struct ParticleSystem *psys_get_current(struct Object *ob);
195 /* for rna */
196 short psys_get_current_num(struct Object *ob);
197 void psys_set_current_num(Object *ob, int index);
198 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
199
200 struct Object *psys_get_lattice(struct ParticleSimulationData *sim);
201
202 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
203 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
204 int psys_check_edited(struct ParticleSystem *psys);
205
206 void psys_check_group_weights(struct ParticleSettings *part);
207 int psys_uses_gravity(struct ParticleSimulationData *sim);
208
209 /* free */
210 void psys_free_settings(struct ParticleSettings *part);
211 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
212 void psys_free(struct Object * ob, struct ParticleSystem * psys);
213
214 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
215 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
216 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
217 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
218
219 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
220 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
221
222 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
223
224 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);
225 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
226
227 struct ModifierData *object_add_particle_system(struct Scene *scene, struct Object *ob, char *name);
228 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
229 struct ParticleSettings *psys_new_settings(char *name, struct Main *main);
230 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
231 void make_local_particlesettings(struct ParticleSettings *part);
232
233 void psys_reset(struct ParticleSystem *psys, int mode);
234
235 void psys_find_parents(struct ParticleSimulationData *sim);
236
237 void psys_cache_paths(struct ParticleSimulationData *sim, float cfra);
238 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra);
239 void psys_cache_child_paths(struct ParticleSimulationData *sim, float cfra, int editupdate);
240 int do_guides(struct ListBase *effectors, ParticleKey *state, int pa_num, float time);
241 void precalc_guides(struct ParticleSimulationData *sim, struct ListBase *effectors);
242 float psys_get_timestep(struct ParticleSimulationData *sim);
243 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
244 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
245 void psys_get_particle_on_path(struct ParticleSimulationData *sim, int pa_num, struct ParticleKey *state, int vel);
246 int psys_get_particle_state(struct ParticleSimulationData *sim, int p, struct ParticleKey *state, int always);
247
248 /* for anim.c */
249 void psys_get_dupli_texture(struct Object *ob, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
250 void psys_get_dupli_path_transform(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ChildParticle *cpa, struct ParticleCacheKey *cache, float mat[][4], float *scale);
251
252 ParticleThread *psys_threads_create(struct ParticleSimulationData *sim);
253 void psys_threads_free(ParticleThread *threads);
254
255 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
256
257 /* particle_system.c */
258 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
259 void psys_count_keyed_targets(struct ParticleSimulationData *sim);
260 void psys_update_particle_tree(struct ParticleSystem *psys, float cfra);
261
262 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
263 void psys_get_pointcache_start_end(struct Scene *scene, ParticleSystem *psys, int *sfra, int *efra);
264
265 void psys_check_boid_data(struct ParticleSystem *psys);
266
267 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
268
269 /* ----------- functions needed only inside particlesystem ------------ */
270 /* particle.c */
271 void psys_disable_all(struct Object *ob);
272 void psys_enable_all(struct Object *ob);
273
274 void free_hair(struct Object *ob, struct ParticleSystem *psys, int dynamics);
275 void free_keyed_keys(struct ParticleSystem *psys);
276 void psys_free_particles(struct ParticleSystem *psys);
277 void psys_free_children(struct ParticleSystem *psys);
278
279 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
280 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
281 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
282 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
283 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
284
285 void psys_free_pdd(struct ParticleSystem *psys);
286
287 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
288 void psys_get_texture(struct ParticleSimulationData *sim, struct Material *ma, struct ParticleData *pa, struct ParticleTexture *ptex, int event);
289 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);
290 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
291 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
292
293 /* only in edisparticle.c*/
294 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);
295 /* BLI_bvhtree_ray_cast callback */
296 void particle_intersect_face(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
297 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);
298
299 /* particle_system.c */
300 void initialize_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, int p);
301 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
302 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
303
304 void reset_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, float dtime, float cfra);
305
306 /* psys_reset */
307 #define PSYS_RESET_ALL                  1
308 #define PSYS_RESET_DEPSGRAPH    2
309 #define PSYS_RESET_CHILDREN     3
310 #define PSYS_RESET_CACHE_MISS   4
311
312 /* index_dmcache */
313 #define DMCACHE_NOTFOUND        -1
314 #define DMCACHE_ISCHILD         -2
315
316 #endif