merge trunk 16118 -> 116886
[blender.git] / source / blender / blenkernel / BKE_particle.h
1 /* BKE_particle.h
2  *
3  *
4  * $Id: BKE_particle.h $
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 DerivedMesh;
48 struct ModifierData;
49 struct MTFace;
50 struct MCol;
51 struct MFace;
52 struct MVert;
53 struct IpoCurve;
54 struct LinkNode;
55 struct KDTree;
56 struct RNG;
57
58 typedef struct ParticleEffectorCache {
59         struct ParticleEffectorCache *next, *prev;
60         struct Object *ob;
61         
62         /* precalculated variables for guides */
63         float firstloc[4], firstdir[3];
64         float *distances;
65         float *locations;
66         /* precalculated variables for deflection */
67         float ob_minmax[6];
68         float *face_minmax;
69         float *vert_cos;
70         /* precalculated variables for boids */
71         struct KDTree *tree;
72
73         short type, psys_nbr;
74         
75         struct Object obcopy;   /* for restoring transformation data */
76         struct RNG *rng; /* random noise generator for e.g. wind */
77 } ParticleEffectorCache;
78
79 typedef struct ParticleReactEvent {
80         struct ParticleReactEvent *next, *prev;
81         int event, pa_num;
82         Object *ob;
83         struct ParticleSystem *psys;
84         struct ParticleKey state;
85
86         float time, size;
87 }ParticleReactEvent;
88
89 typedef struct ParticleTexture{
90         float ivel;                                                     /* used in reset */
91         float time, life, exist, size;          /* used in init */
92         float pvel[3];                                          /* used in physics */
93         float length, clump, kink, rough;       /* used in path caching */
94 } ParticleTexture;
95
96 typedef struct BoidVecFunc{
97         void (*Addf)(float *v, float *v1, float *v2);
98         void (*Subf)(float *v, float *v1, float *v2);
99         void (*Mulf)(float *v, float f);
100         float (*Length)(float *v);
101         float (*Normalize)(float *v);
102         float (*Inpf)(float *v1, float *v2);
103         void (*Copyf)(float *v1, float *v2);
104 } BoidVecFunc;
105
106 typedef struct ParticleSeam{
107         float v0[3], v1[3];
108         float nor[3], dir[3], tan[3];
109         float length2;
110 } ParticleSeam;
111
112 typedef struct ParticleCacheKey{
113         float co[3];
114         float vel[3];
115         float rot[4];
116         float col[3];
117         int steps;
118 } ParticleCacheKey;
119
120 typedef struct ParticleEditKey{
121         float *co;
122         float *vel;
123         float *rot;
124         float *time;
125
126         float world_co[3];
127         float length;
128         short flag;
129 } ParticleEditKey;
130
131 typedef struct ParticleUndo {
132         struct ParticleUndo *next, *prev;
133         struct ParticleEditKey **keys;
134         struct KDTree *emitter_field;
135         struct ParticleData *particles;
136         float *emitter_cosnos;
137         int totpart, totkeys;
138         char name[64];
139 } ParticleUndo;
140
141 typedef struct ParticleEdit{
142         ListBase undo;
143         struct ParticleUndo *curundo;
144         struct KDTree *emitter_field;
145         ParticleEditKey **keys;
146         int *mirror_cache;
147         float *emitter_cosnos;
148
149         int totkeys;
150 } ParticleEdit;
151
152 typedef struct ParticleThreadContext {
153         /* shared */
154         struct Object *ob;
155         struct DerivedMesh *dm;
156         struct ParticleSystemModifierData *psmd;
157         struct ParticleSystem *psys;
158         struct Material *ma;
159
160         /* distribution */
161         struct KDTree *tree;
162
163         struct ParticleSeam *seams;
164         int totseam;
165
166         float *jit, *jitoff, *weight;
167         float maxweight;
168         int *index, *skip, jitlevel;
169
170         int from, cfrom, distr;
171
172         struct ParticleData *tpars;
173
174         /* path caching */
175         int editupdate, between, steps;
176         int totchild, totparent;
177
178         float cfra;
179
180         float *vg_length, *vg_clump, *vg_kink;
181         float *vg_rough1, *vg_rough2, *vg_roughe;
182         float *vg_effector;
183 } ParticleThreadContext;
184
185 typedef struct ParticleThread {
186         ParticleThreadContext *ctx;
187         struct RNG *rng, *rng_path;
188         int num, tot;
189 } ParticleThread;
190
191 /* ----------- functions needed outside particlesystem ---------------- */
192 /* particle.c */
193 int count_particles(struct ParticleSystem *psys);
194 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
195 int psys_count_keys(struct ParticleSystem *psys);
196 char *psys_menu_string(struct Object *ob, int for_sb);
197
198 struct ParticleSystem *psys_get_current(struct Object *ob);
199 short psys_get_current_num(struct Object *ob);
200 //struct ParticleSystem *psys_get(struct Object *ob, int index);
201 struct ParticleData *psys_get_selected_particle(struct ParticleSystem *psys, int *index);
202 struct ParticleKey *psys_get_selected_key(struct ParticleSystem *psys, int pa_index, int *key_index);
203 void psys_change_act(void *ob_v, void *act_v);
204 struct Object *psys_get_lattice(struct Object *ob, struct ParticleSystem *psys);
205 void psys_disable_all(struct Object *ob);
206 void psys_enable_all(struct Object *ob);
207 int psys_ob_has_hair(struct Object *ob);
208 int psys_in_edit_mode(struct ParticleSystem *psys);
209 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
210
211 void psys_free_settings(struct ParticleSettings *part);
212 void free_child_path_cache(struct ParticleSystem *psys);
213 void psys_free_path_cache(struct ParticleSystem *psys);
214 void free_hair(struct ParticleSystem *psys, int softbody);
215 void free_keyed_keys(struct ParticleSystem *psys);
216 void psys_free(struct Object * ob, struct ParticleSystem * psys);
217 void psys_free_children(struct ParticleSystem *psys);
218
219 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
220 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
221 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
222 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
223
224 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
225 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
226
227 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
228
229 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);
230 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
231
232 struct ParticleSettings *psys_new_settings(char *name, struct Main *main);
233 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
234 void psys_flush_settings(struct ParticleSettings *part, int event, int hair_recalc);
235 void make_local_particlesettings(struct ParticleSettings *part);
236
237 struct LinkNode *psys_using_settings(struct ParticleSettings *part, int flush_update);
238 void psys_changed_type(struct ParticleSystem *psys);
239 void psys_reset(struct ParticleSystem *psys, int mode);
240
241 void psys_find_parents(struct Object *ob, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys);
242
243 void psys_cache_paths(struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
244 void psys_cache_child_paths(struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
245 int do_guide(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);
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 Object *ob, struct ParticleSystem *psys, int pa_num, struct ParticleKey *state, int vel);
251 int psys_get_particle_state(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 Object *ob, struct ParticleSystem *psys);
256 int psys_threads_init_distribution(ParticleThread *threads, struct DerivedMesh *dm, int from);
257 int psys_threads_init_path(ParticleThread *threads, 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 /* particle_system.c */
264 int psys_count_keyed_targets(struct Object *ob, struct ParticleSystem *psys);
265 void psys_get_reactor_target(struct Object *ob, struct ParticleSystem *psys, struct Object **target_ob, struct ParticleSystem **target_psys);
266
267 void psys_init_effectors(struct Object *obsrc, struct Group *group, struct ParticleSystem *psys);
268 void psys_end_effectors(struct ParticleSystem *psys);
269
270 void particle_system_update(struct Object *ob, struct ParticleSystem *psys);
271
272 /* ----------- functions needed only inside particlesystem ------------ */
273 /* particle.c */
274 void psys_key_to_object(struct Object *ob, struct ParticleKey *key, float imat[][4]);
275 //void psys_key_to_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
276 //void psys_key_from_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
277 //void psys_face_mat(struct DerivedMesh *dm, struct ParticleData *pa, float mat[][4]);
278 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
279 //void psys_vec_rot_from_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
280 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
281 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
282 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
283
284 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
285 void psys_get_texture(struct Object *ob, struct Material *ma, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys, struct ParticleData *pa, struct ParticleTexture *ptex, int event);
286 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);
287 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
288 float psys_interpolate_value_from_verts(struct DerivedMesh *dm, short from, int index, float *fw, float *values);
289 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
290
291 int psys_intersect_dm(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);
292 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);
293
294 /* particle_system.c */
295 void initialize_particle(struct ParticleData *pa, int p, struct Object *ob, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd);
296 void reset_particle(struct ParticleData *pa, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd, struct Object *ob, float dtime, float cfra, float *vg_vel, float *vg_tan, float *vg_rot);
297
298 void do_effectors(int pa_no, struct ParticleData *pa, struct ParticleKey *state, struct Object *ob, struct ParticleSystem *psys, float *texco, float *force_field, float *vel,float framestep, float cfra);
299
300 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
301 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
302
303 /* psys_reset */
304 #define PSYS_RESET_ALL                  1
305 #define PSYS_RESET_DEPSGRAPH    2
306 #define PSYS_RESET_CHILDREN     3
307 #define PSYS_RESET_CACHE_MISS   4
308
309 /* ParticleEffectorCache->type */
310 #define PSYS_EC_EFFECTOR        1
311 #define PSYS_EC_DEFLECT         2
312 #define PSYS_EC_PARTICLE        4
313 #define PSYS_EC_REACTOR         8
314
315 /* ParticleEditKey->flag */
316 #define PEK_SELECT              1
317 #define PEK_TO_SELECT   2
318 #define PEK_TAG                 4
319 #define PEK_HIDE                8
320
321 /* index_dmcache */
322 #define DMCACHE_NOTFOUND        -1
323 #define DMCACHE_ISCHILD         -2
324
325 #endif