svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22935:23022
[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 #define PARTICLE_P                              ParticleData *pa; int p
63 #define LOOP_PARTICLES  for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++)
64
65 typedef struct ParticleEffectorCache {
66         struct ParticleEffectorCache *next, *prev;
67         struct Object *ob;
68         
69         /* precalculated variables for guides */
70         float firstloc[4], firstdir[3];
71         float *distances;
72         float *locations;
73         /* precalculated variables for deflection */
74         float ob_minmax[6];
75         float *face_minmax;
76         float *vert_cos;
77         /* precalculated variables for boids */
78         struct KDTree *tree;
79
80         short type, psys_nbr;
81         
82         struct Object obcopy;   /* for restoring transformation data */
83         struct RNG *rng; /* random noise generator for e.g. wind */
84 } ParticleEffectorCache;
85
86 typedef struct ParticleReactEvent {
87         struct ParticleReactEvent *next, *prev;
88         int event, pa_num;
89         Object *ob;
90         struct ParticleSystem *psys;
91         struct ParticleKey state;
92
93         float time, size;
94 }ParticleReactEvent;
95
96 typedef struct ParticleTexture{
97         float ivel;                                                     /* used in reset */
98         float time, life, exist, size;          /* used in init */
99         float pvel[3];                                          /* used in physics */
100         float length, clump, kink, effector;/* used in path caching */
101         float rough1, rough2, roughe;           /* used in path caching */
102 } ParticleTexture;
103
104 typedef struct ParticleSeam{
105         float v0[3], v1[3];
106         float nor[3], dir[3], tan[3];
107         float length2;
108 } ParticleSeam;
109
110 typedef struct ParticleCacheKey{
111         float co[3];
112         float vel[3];
113         float rot[4];
114         float col[3];
115         float time;
116         int steps;
117 } ParticleCacheKey;
118
119 typedef struct ParticleThreadContext {
120         /* shared */
121         struct Scene *scene;
122         struct Object *ob;
123         struct DerivedMesh *dm;
124         struct ParticleSystemModifierData *psmd;
125         struct ParticleSystem *psys;
126         struct Material *ma;
127
128         /* distribution */
129         struct KDTree *tree;
130
131         struct ParticleSeam *seams;
132         int totseam;
133
134         float *jit, *jitoff, *weight;
135         float maxweight;
136         int *index, *skip, jitlevel;
137
138         int from, cfrom, distr;
139
140         struct ParticleData *tpars;
141
142         /* path caching */
143         int editupdate, between, steps;
144         int totchild, totparent, parent_pass;
145
146         float cfra;
147
148         float *vg_length, *vg_clump, *vg_kink;
149         float *vg_rough1, *vg_rough2, *vg_roughe;
150         float *vg_effector;
151 } ParticleThreadContext;
152
153 typedef struct ParticleThread {
154         ParticleThreadContext *ctx;
155         struct RNG *rng, *rng_path;
156         int num, tot;
157 } ParticleThread;
158
159 typedef struct ParticleBillboardData
160 {
161         struct Object *ob;
162         float vec[3], vel[3];
163         float offset[2];
164         float size, tilt, random, time;
165         int uv[3];
166         int lock, num;
167         int totnum;
168         short align, uv_split, anim, split_offset;
169 }
170 ParticleBillboardData;
171
172 /* container for moving data between deflet_particle and particle_intersect_face */
173 typedef struct ParticleCollision
174 {
175         struct Object *ob, *ob_t; // collided and current objects
176         struct CollisionModifierData *md; // collision modifier for ob_t;
177         float nor[3]; // normal at collision point
178         float vel[3]; // velocity of collision point
179         float co1[3], co2[3]; // ray start and end points
180         float ray_len; // original length of co2-co1, needed for collision time evaluation
181         float t;        // time of previous collision, needed for substracting face velocity
182 }
183 ParticleCollision;
184
185 /* ----------- functions needed outside particlesystem ---------------- */
186 /* particle.c */
187 int count_particles(struct ParticleSystem *psys);
188 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
189 int psys_count_keys(struct ParticleSystem *psys);
190 char *psys_menu_string(struct Object *ob, int for_sb);
191
192 struct ParticleSystem *psys_get_current(struct Object *ob);
193 short psys_get_current_num(struct Object *ob);
194 void psys_set_current_num(Object *ob, int index);
195 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
196 //struct ParticleSystem *psys_get(struct Object *ob, int index);
197 struct ParticleData *psys_get_selected_particle(struct ParticleSystem *psys, int *index);
198 struct ParticleKey *psys_get_selected_key(struct ParticleSystem *psys, int pa_index, int *key_index);
199 void psys_change_act(void *ob_v, void *act_v);
200 struct Object *psys_get_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
201 void psys_disable_all(struct Object *ob);
202 void psys_enable_all(struct Object *ob);
203 int psys_ob_has_hair(struct Object *ob);
204 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
205 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
206
207 void psys_free_boid_rules(struct ListBase *list);
208 void psys_free_settings(struct ParticleSettings *part);
209 void free_child_path_cache(struct ParticleSystem *psys);
210 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
211 void free_hair(struct ParticleSystem *psys, int softbody);
212 void free_keyed_keys(struct ParticleSystem *psys);
213 void psys_free_particles(struct ParticleSystem *psys);
214 void psys_free(struct Object * ob, struct ParticleSystem * psys);
215 void psys_free_children(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 void object_add_particle_system(struct Scene *scene, struct Object *ob);
231 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
232 struct ParticleSettings *psys_new_settings(char *name, struct Main *main);
233 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
234 void psys_flush_particle_settings(struct Scene *scene, struct ParticleSettings *part, int recalc);
235 void make_local_particlesettings(struct ParticleSettings *part);
236
237 struct LinkNode *psys_using_settings(struct Scene *scene, struct ParticleSettings *part, int flush_update);
238 void psys_reset(struct ParticleSystem *psys, int mode);
239
240 void psys_find_parents(struct Object *ob, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys);
241
242 void psys_cache_paths(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, float cfra);
243 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra);
244 void psys_cache_child_paths(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
245 int do_guide(struct Scene *scene, struct ParticleKey *state, int pa_num, float time, struct ListBase *lb);
246 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);
247 float psys_get_timestep(struct ParticleSettings *part);
248 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
249 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
250 void psys_get_particle_on_path(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, int pa_num, struct ParticleKey *state, int vel);
251 int psys_get_particle_state(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, int p, struct ParticleKey *state, int always);
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 Object *ob, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, struct ParticleCacheKey *cache, float mat[][4], float *scale);
254
255 ParticleThread *psys_threads_create(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
256 int psys_threads_init_distribution(ParticleThread *threads, struct Scene *scene, struct DerivedMesh *dm, int from);
257 int psys_threads_init_path(ParticleThread *threads, struct Scene *scene, float cfra, int editupdate);
258 void psys_threads_free(ParticleThread *threads);
259
260 void psys_thread_distribute_particle(ParticleThread *thread, struct ParticleData *pa, struct ChildParticle *cpa, int p);
261 void psys_thread_create_path(ParticleThread *thread, struct ChildParticle *cpa, ParticleCacheKey *keys, int i);
262
263 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
264
265 /* particle_system.c */
266 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
267 void psys_count_keyed_targets(struct Object *ob, struct ParticleSystem *psys);
268 void psys_get_reactor_target(struct Object *ob, struct ParticleSystem *psys, struct Object **target_ob, struct ParticleSystem **target_psys);
269
270 void psys_init_effectors(struct Scene *scene, struct Object *obsrc, struct Group *group, struct ParticleSystem *psys);
271 void psys_end_effectors(struct ParticleSystem *psys);
272
273 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
274 void psys_end_temp_pointcache(struct ParticleSystem *psys);
275 void psys_get_pointcache_start_end(struct Scene *scene, struct ParticleSystem *psys, int *sfra, int *efra);
276
277 void psys_check_boid_data(struct ParticleSystem *psys);
278
279 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
280
281 /* ----------- functions needed only inside particlesystem ------------ */
282 /* particle.c */
283 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
284 void psys_key_to_object(struct Object *ob, struct ParticleKey *key, float imat[][4]);
285 //void psys_key_to_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
286 //void psys_key_from_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
287 //void psys_face_mat(struct DerivedMesh *dm, struct ParticleData *pa, float mat[][4]);
288 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
289 //void psys_vec_rot_from_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
290 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
291 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
292 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
293
294 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
295 void psys_get_texture(struct Object *ob, struct Material *ma, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys, struct ParticleData *pa, struct ParticleTexture *ptex, int event);
296 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);
297 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
298 float psys_interpolate_value_from_verts(struct DerivedMesh *dm, short from, int index, float *fw, float *values);
299 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
300
301 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);
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 ParticleData *pa, int p, struct Object *ob, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd);
307
308 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);
309 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);
310
311 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
312 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
313
314 void reset_particle(struct Scene *scene, struct ParticleData *pa, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd, struct Object *ob,
315                                         float dtime, float cfra, float *vg_vel, float *vg_tan, float *vg_rot);
316
317
318 /* psys_reset */
319 #define PSYS_RESET_ALL                  1
320 #define PSYS_RESET_DEPSGRAPH    2
321 #define PSYS_RESET_CHILDREN     3
322 #define PSYS_RESET_CACHE_MISS   4
323
324 /* ParticleEffectorCache->type */
325 #define PSYS_EC_EFFECTOR        1
326 #define PSYS_EC_DEFLECT         2
327 #define PSYS_EC_PARTICLE        4
328 #define PSYS_EC_REACTOR         8
329
330 /* index_dmcache */
331 #define DMCACHE_NOTFOUND        -1
332 #define DMCACHE_ISCHILD         -2
333
334 #endif