svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r21899:21908
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 typedef struct ParticleEffectorCache {
63         struct ParticleEffectorCache *next, *prev;
64         struct Object *ob;
65         
66         /* precalculated variables for guides */
67         float firstloc[4], firstdir[3];
68         float *distances;
69         float *locations;
70         /* precalculated variables for deflection */
71         float ob_minmax[6];
72         float *face_minmax;
73         float *vert_cos;
74         /* precalculated variables for boids */
75         struct KDTree *tree;
76
77         short type, psys_nbr;
78         
79         struct Object obcopy;   /* for restoring transformation data */
80         struct RNG *rng; /* random noise generator for e.g. wind */
81 } ParticleEffectorCache;
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         int steps;
113 } ParticleCacheKey;
114
115 typedef struct ParticleEditKey{
116         float *co;
117         float *vel;
118         float *rot;
119         float *time;
120
121         float world_co[3];
122         float length;
123         short flag;
124 } ParticleEditKey;
125
126 typedef struct ParticleUndo {
127         struct ParticleUndo *next, *prev;
128         struct ParticleEditKey **keys;
129         struct KDTree *emitter_field;
130         struct ParticleData *particles;
131         float *emitter_cosnos;
132         int totpart, totkeys;
133         char name[64];
134 } ParticleUndo;
135
136 typedef struct ParticleEdit {
137         ListBase undo;
138         struct ParticleUndo *curundo;
139
140         ParticleEditKey **keys;
141         int totkeys;
142
143         int *mirror_cache;
144
145         struct KDTree *emitter_field;
146         float *emitter_cosnos;
147
148         char sel_col[3];
149         char nosel_col[3];
150 } ParticleEdit;
151
152 typedef struct ParticleThreadContext {
153         /* shared */
154         struct Scene *scene;
155         struct Object *ob;
156         struct DerivedMesh *dm;
157         struct ParticleSystemModifierData *psmd;
158         struct ParticleSystem *psys;
159         struct Material *ma;
160
161         /* distribution */
162         struct KDTree *tree;
163
164         struct ParticleSeam *seams;
165         int totseam;
166
167         float *jit, *jitoff, *weight;
168         float maxweight;
169         int *index, *skip, jitlevel;
170
171         int from, cfrom, distr;
172
173         struct ParticleData *tpars;
174
175         /* path caching */
176         int editupdate, between, steps;
177         int totchild, totparent, parent_pass;
178
179         float cfra;
180
181         float *vg_length, *vg_clump, *vg_kink;
182         float *vg_rough1, *vg_rough2, *vg_roughe;
183         float *vg_effector;
184 } ParticleThreadContext;
185
186 typedef struct ParticleThread {
187         ParticleThreadContext *ctx;
188         struct RNG *rng, *rng_path;
189         int num, tot;
190 } ParticleThread;
191
192 typedef struct ParticleBillboardData
193 {
194         struct Object *ob;
195         float vec[3], vel[3];
196         float offset[2];
197         float size, tilt, random, time;
198         int uv[3];
199         int lock, num;
200         int totnum;
201         short align, uv_split, anim, split_offset;
202 }
203 ParticleBillboardData;
204
205 /* container for moving data between deflet_particle and particle_intersect_face */
206 typedef struct ParticleCollision
207 {
208         struct Object *ob, *ob_t; // collided and current objects
209         struct CollisionModifierData *md; // collision modifier for ob_t;
210         float nor[3]; // normal at collision point
211         float vel[3]; // velocity of collision point
212         float co1[3], co2[3]; // ray start and end points
213         float ray_len; // original length of co2-co1, needed for collision time evaluation
214         float t;        // time of previous collision, needed for substracting face velocity
215 }
216 ParticleCollision;
217
218 /* ----------- functions needed outside particlesystem ---------------- */
219 /* particle.c */
220 int count_particles(struct ParticleSystem *psys);
221 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
222 int psys_count_keys(struct ParticleSystem *psys);
223 char *psys_menu_string(struct Object *ob, int for_sb);
224
225 struct ParticleSystem *psys_get_current(struct Object *ob);
226 short psys_get_current_num(struct Object *ob);
227 void psys_set_current_num(Object *ob, int index);
228 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
229 //struct ParticleSystem *psys_get(struct Object *ob, int index);
230 struct ParticleData *psys_get_selected_particle(struct ParticleSystem *psys, int *index);
231 struct ParticleKey *psys_get_selected_key(struct ParticleSystem *psys, int pa_index, int *key_index);
232 void psys_change_act(void *ob_v, void *act_v);
233 struct Object *psys_get_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
234 void psys_disable_all(struct Object *ob);
235 void psys_enable_all(struct Object *ob);
236 int psys_ob_has_hair(struct Object *ob);
237 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
238 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
239
240 void psys_free_boid_rules(struct ListBase *list);
241 void psys_free_settings(struct ParticleSettings *part);
242 void free_child_path_cache(struct ParticleSystem *psys);
243 void psys_free_path_cache(struct ParticleSystem *psys);
244 void free_hair(struct ParticleSystem *psys, int softbody);
245 void free_keyed_keys(struct ParticleSystem *psys);
246 void psys_free(struct Object * ob, struct ParticleSystem * psys);
247 void psys_free_children(struct ParticleSystem *psys);
248
249 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
250 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
251 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
252 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
253
254 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
255 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
256
257 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
258
259 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);
260 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
261
262 void object_add_particle_system(struct Scene *scene, struct Object *ob);
263 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
264 struct ParticleSettings *psys_new_settings(char *name, struct Main *main);
265 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
266 void psys_flush_particle_settings(struct Scene *scene, struct ParticleSettings *part, int recalc);
267 void make_local_particlesettings(struct ParticleSettings *part);
268
269 struct LinkNode *psys_using_settings(struct Scene *scene, struct ParticleSettings *part, int flush_update);
270 void psys_reset(struct ParticleSystem *psys, int mode);
271
272 void psys_find_parents(struct Object *ob, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys);
273
274 void psys_cache_paths(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
275 void psys_cache_child_paths(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
276 void psys_update_world_cos(struct Object *ob, struct ParticleSystem *psys);
277 int do_guide(struct Scene *scene, struct ParticleKey *state, int pa_num, float time, struct ListBase *lb);
278 float psys_get_size(struct Object *ob, struct Material *ma, struct ParticleSystemModifierData *psmd, struct IpoCurve *icu_size, struct ParticleSystem *psys, struct ParticleSettings *part, struct ParticleData *pa, float *vg_size);
279 float psys_get_timestep(struct ParticleSettings *part);
280 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
281 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
282 void psys_get_particle_on_path(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, int pa_num, struct ParticleKey *state, int vel);
283 int psys_get_particle_state(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, int p, struct ParticleKey *state, int always);
284 void psys_get_dupli_texture(struct Object *ob, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
285 void psys_get_dupli_path_transform(struct Object *ob, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, struct ParticleCacheKey *cache, float mat[][4], float *scale);
286
287 ParticleThread *psys_threads_create(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
288 int psys_threads_init_distribution(ParticleThread *threads, struct Scene *scene, struct DerivedMesh *dm, int from);
289 int psys_threads_init_path(ParticleThread *threads, struct Scene *scene, float cfra, int editupdate);
290 void psys_threads_free(ParticleThread *threads);
291
292 void psys_thread_distribute_particle(ParticleThread *thread, struct ParticleData *pa, struct ChildParticle *cpa, int p);
293 void psys_thread_create_path(ParticleThread *thread, struct ChildParticle *cpa, ParticleCacheKey *keys, int i);
294
295 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
296
297 /* particle_system.c */
298 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
299 void psys_count_keyed_targets(struct Object *ob, struct ParticleSystem *psys);
300 void psys_get_reactor_target(struct Object *ob, struct ParticleSystem *psys, struct Object **target_ob, struct ParticleSystem **target_psys);
301
302 void psys_init_effectors(struct Scene *scene, struct Object *obsrc, struct Group *group, struct ParticleSystem *psys);
303 void psys_end_effectors(struct ParticleSystem *psys);
304
305 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
306 void psys_end_temp_pointcache(struct ParticleSystem *psys);
307 void psys_get_pointcache_start_end(struct Scene *scene, struct ParticleSystem *psys, int *sfra, int *efra);
308
309 void psys_check_boid_data(struct ParticleSystem *psys);
310
311 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
312
313 /* ----------- functions needed only inside particlesystem ------------ */
314 /* particle.c */
315 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
316 void psys_key_to_object(struct Object *ob, struct ParticleKey *key, float imat[][4]);
317 //void psys_key_to_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
318 //void psys_key_from_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
319 //void psys_face_mat(struct DerivedMesh *dm, struct ParticleData *pa, float mat[][4]);
320 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
321 //void psys_vec_rot_from_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
322 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
323 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
324 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
325
326 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
327 void psys_get_texture(struct Object *ob, struct Material *ma, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys, struct ParticleData *pa, struct ParticleTexture *ptex, int event);
328 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);
329 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
330 float psys_interpolate_value_from_verts(struct DerivedMesh *dm, short from, int index, float *fw, float *values);
331 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
332
333 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);
334 void particle_intersect_face(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
335 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);
336
337 /* particle_system.c */
338 void initialize_particle(struct ParticleData *pa, int p, struct Object *ob, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd);
339
340 int effector_find_co(struct Scene *scene, float *pco, struct SurfaceModifierData *sur, struct Object *ob, struct PartDeflect *pd, float *co, float *nor, float *vel, int *index);
341 void do_effectors(int pa_no, struct ParticleData *pa, struct ParticleKey *state, struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, float *texco, float *force_field, float *vel,float framestep, float cfra);
342
343 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
344 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
345
346 void reset_particle(struct Scene *scene, struct ParticleData *pa, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd, struct Object *ob,
347                                         float dtime, float cfra, float *vg_vel, float *vg_tan, float *vg_rot);
348
349
350 /* psys_reset */
351 #define PSYS_RESET_ALL                  1
352 #define PSYS_RESET_DEPSGRAPH    2
353 #define PSYS_RESET_CHILDREN     3
354 #define PSYS_RESET_CACHE_MISS   4
355
356 /* ParticleEffectorCache->type */
357 #define PSYS_EC_EFFECTOR        1
358 #define PSYS_EC_DEFLECT         2
359 #define PSYS_EC_PARTICLE        4
360 #define PSYS_EC_REACTOR         8
361
362 /* ParticleEditKey->flag */
363 #define PEK_SELECT              1
364 #define PEK_TO_SELECT   2
365 #define PEK_TAG                 4
366 #define PEK_HIDE                8
367
368 /* index_dmcache */
369 #define DMCACHE_NOTFOUND        -1
370 #define DMCACHE_ISCHILD         -2
371
372 #endif