NLA SoC: Merge from 2.5
[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
59 typedef struct ParticleEffectorCache {
60         struct ParticleEffectorCache *next, *prev;
61         struct Object *ob;
62         
63         /* precalculated variables for guides */
64         float firstloc[4], firstdir[3];
65         float *distances;
66         float *locations;
67         /* precalculated variables for deflection */
68         float ob_minmax[6];
69         float *face_minmax;
70         float *vert_cos;
71         /* precalculated variables for boids */
72         struct KDTree *tree;
73
74         short type, psys_nbr;
75         
76         struct Object obcopy;   /* for restoring transformation data */
77         struct RNG *rng; /* random noise generator for e.g. wind */
78 } ParticleEffectorCache;
79
80 typedef struct ParticleReactEvent {
81         struct ParticleReactEvent *next, *prev;
82         int event, pa_num;
83         Object *ob;
84         struct ParticleSystem *psys;
85         struct ParticleKey state;
86
87         float time, size;
88 }ParticleReactEvent;
89
90 typedef struct ParticleTexture{
91         float ivel;                                                     /* used in reset */
92         float time, life, exist, size;          /* used in init */
93         float pvel[3];                                          /* used in physics */
94         float length, clump, kink, effector;/* used in path caching */
95         float rough1, rough2, roughe;           /* used in path caching */
96 } ParticleTexture;
97
98 typedef struct BoidVecFunc{
99         void (*Addf)(float *v, float *v1, float *v2);
100         void (*Subf)(float *v, float *v1, float *v2);
101         void (*Mulf)(float *v, float f);
102         float (*Length)(float *v);
103         float (*Normalize)(float *v);
104         float (*Inpf)(float *v1, float *v2);
105         void (*Copyf)(float *v1, float *v2);
106 } BoidVecFunc;
107
108 typedef struct ParticleSeam{
109         float v0[3], v1[3];
110         float nor[3], dir[3], tan[3];
111         float length2;
112 } ParticleSeam;
113
114 typedef struct ParticleCacheKey{
115         float co[3];
116         float vel[3];
117         float rot[4];
118         float col[3];
119         int steps;
120 } ParticleCacheKey;
121
122 typedef struct ParticleEditKey{
123         float *co;
124         float *vel;
125         float *rot;
126         float *time;
127
128         float world_co[3];
129         float length;
130         short flag;
131 } ParticleEditKey;
132
133 typedef struct ParticleUndo {
134         struct ParticleUndo *next, *prev;
135         struct ParticleEditKey **keys;
136         struct KDTree *emitter_field;
137         struct ParticleData *particles;
138         float *emitter_cosnos;
139         int totpart, totkeys;
140         char name[64];
141 } ParticleUndo;
142
143 typedef struct ParticleEdit {
144         ListBase undo;
145         struct ParticleUndo *curundo;
146
147         ParticleEditKey **keys;
148         int totkeys;
149
150         int *mirror_cache;
151
152         struct KDTree *emitter_field;
153         float *emitter_cosnos;
154
155         char sel_col[3];
156         char nosel_col[3];
157 } ParticleEdit;
158
159 typedef struct ParticleThreadContext {
160         /* shared */
161         struct Scene *scene;
162         struct Object *ob;
163         struct DerivedMesh *dm;
164         struct ParticleSystemModifierData *psmd;
165         struct ParticleSystem *psys;
166         struct Material *ma;
167
168         /* distribution */
169         struct KDTree *tree;
170
171         struct ParticleSeam *seams;
172         int totseam;
173
174         float *jit, *jitoff, *weight;
175         float maxweight;
176         int *index, *skip, jitlevel;
177
178         int from, cfrom, distr;
179
180         struct ParticleData *tpars;
181
182         /* path caching */
183         int editupdate, between, steps;
184         int totchild, totparent, parent_pass;
185
186         float cfra;
187
188         float *vg_length, *vg_clump, *vg_kink;
189         float *vg_rough1, *vg_rough2, *vg_roughe;
190         float *vg_effector;
191 } ParticleThreadContext;
192
193 typedef struct ParticleThread {
194         ParticleThreadContext *ctx;
195         struct RNG *rng, *rng_path;
196         int num, tot;
197 } ParticleThread;
198
199 typedef struct ParticleBillboardData
200 {
201         struct Object *ob;
202         float vec[3], vel[3];
203         float offset[2];
204         float size, tilt, random, time;
205         int uv[3];
206         int lock, num;
207         int totnum;
208         short align, uv_split, anim, split_offset;
209 }
210 ParticleBillboardData;
211
212 /* ----------- functions needed outside particlesystem ---------------- */
213 /* particle.c */
214 int count_particles(struct ParticleSystem *psys);
215 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
216 int psys_count_keys(struct ParticleSystem *psys);
217 char *psys_menu_string(struct Object *ob, int for_sb);
218
219 struct ParticleSystem *psys_get_current(struct Object *ob);
220 short psys_get_current_num(struct Object *ob);
221 void psys_set_current_num(Object *ob, int index);
222 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
223 //struct ParticleSystem *psys_get(struct Object *ob, int index);
224 struct ParticleData *psys_get_selected_particle(struct ParticleSystem *psys, int *index);
225 struct ParticleKey *psys_get_selected_key(struct ParticleSystem *psys, int pa_index, int *key_index);
226 void psys_change_act(void *ob_v, void *act_v);
227 struct Object *psys_get_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
228 void psys_disable_all(struct Object *ob);
229 void psys_enable_all(struct Object *ob);
230 int psys_ob_has_hair(struct Object *ob);
231 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
232 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
233
234 void psys_free_settings(struct ParticleSettings *part);
235 void free_child_path_cache(struct ParticleSystem *psys);
236 void psys_free_path_cache(struct ParticleSystem *psys);
237 void free_hair(struct ParticleSystem *psys, int softbody);
238 void free_keyed_keys(struct ParticleSystem *psys);
239 void psys_free(struct Object * ob, struct ParticleSystem * psys);
240 void psys_free_children(struct ParticleSystem *psys);
241
242 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
243 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
244 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
245 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
246
247 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
248 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
249
250 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
251
252 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);
253 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
254
255 void object_add_particle_system(struct Scene *scene, struct Object *ob);
256 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
257 struct ParticleSettings *psys_new_settings(char *name, struct Main *main);
258 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
259 void psys_flush_particle_settings(struct Scene *scene, struct ParticleSettings *part, int recalc);
260 void make_local_particlesettings(struct ParticleSettings *part);
261
262 struct LinkNode *psys_using_settings(struct Scene *scene, struct ParticleSettings *part, int flush_update);
263 void psys_changed_type(struct ParticleSystem *psys);
264 void psys_reset(struct ParticleSystem *psys, int mode);
265
266 void psys_find_parents(struct Object *ob, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys);
267
268 void psys_cache_paths(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
269 void psys_cache_child_paths(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
270 void psys_update_world_cos(struct Object *ob, struct ParticleSystem *psys);
271 int do_guide(struct Scene *scene, struct ParticleKey *state, int pa_num, float time, struct ListBase *lb);
272 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);
273 float psys_get_timestep(struct ParticleSettings *part);
274 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
275 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
276 void psys_get_particle_on_path(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, int pa_num, struct ParticleKey *state, int vel);
277 int psys_get_particle_state(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys, int p, struct ParticleKey *state, int always);
278 void psys_get_dupli_texture(struct Object *ob, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
279 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);
280
281 ParticleThread *psys_threads_create(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
282 int psys_threads_init_distribution(ParticleThread *threads, struct Scene *scene, struct DerivedMesh *dm, int from);
283 int psys_threads_init_path(ParticleThread *threads, struct Scene *scene, float cfra, int editupdate);
284 void psys_threads_free(ParticleThread *threads);
285
286 void psys_thread_distribute_particle(ParticleThread *thread, struct ParticleData *pa, struct ChildParticle *cpa, int p);
287 void psys_thread_create_path(ParticleThread *thread, struct ChildParticle *cpa, ParticleCacheKey *keys, int i);
288
289 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
290
291 /* particle_system.c */
292 int psys_count_keyed_targets(struct Object *ob, struct ParticleSystem *psys);
293 void psys_get_reactor_target(struct Object *ob, struct ParticleSystem *psys, struct Object **target_ob, struct ParticleSystem **target_psys);
294
295 void psys_init_effectors(struct Scene *scene, struct Object *obsrc, struct Group *group, struct ParticleSystem *psys);
296 void psys_end_effectors(struct ParticleSystem *psys);
297
298 void psys_get_pointcache_start_end(struct Scene *scene, struct ParticleSystem *psys, int *sfra, int *efra);
299
300 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
301
302 /* ----------- functions needed only inside particlesystem ------------ */
303 /* particle.c */
304 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
305 void psys_key_to_object(struct Object *ob, struct ParticleKey *key, float imat[][4]);
306 //void psys_key_to_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
307 //void psys_key_from_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
308 //void psys_face_mat(struct DerivedMesh *dm, struct ParticleData *pa, float mat[][4]);
309 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
310 //void psys_vec_rot_from_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
311 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
312 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
313 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
314
315 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
316 void psys_get_texture(struct Object *ob, struct Material *ma, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys, struct ParticleData *pa, struct ParticleTexture *ptex, int event);
317 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);
318 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
319 float psys_interpolate_value_from_verts(struct DerivedMesh *dm, short from, int index, float *fw, float *values);
320 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
321
322 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);
323 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);
324
325 /* particle_system.c */
326 void initialize_particle(struct ParticleData *pa, int p, struct Object *ob, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd);
327
328 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);
329
330 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
331 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
332
333 void reset_particle(struct Scene *scene, struct ParticleData *pa, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd, struct Object *ob,
334                                         float dtime, float cfra, float *vg_vel, float *vg_tan, float *vg_rot);
335
336
337 /* psys_reset */
338 #define PSYS_RESET_ALL                  1
339 #define PSYS_RESET_DEPSGRAPH    2
340 #define PSYS_RESET_CHILDREN     3
341 #define PSYS_RESET_CACHE_MISS   4
342
343 /* ParticleEffectorCache->type */
344 #define PSYS_EC_EFFECTOR        1
345 #define PSYS_EC_DEFLECT         2
346 #define PSYS_EC_PARTICLE        4
347 #define PSYS_EC_REACTOR         8
348
349 /* ParticleEditKey->flag */
350 #define PEK_SELECT              1
351 #define PEK_TO_SELECT   2
352 #define PEK_TAG                 4
353 #define PEK_HIDE                8
354
355 /* index_dmcache */
356 #define DMCACHE_NOTFOUND        -1
357 #define DMCACHE_ISCHILD         -2
358
359 #endif