svn merge -r 14561:14627 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[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 } ParticleEffectorCache;
77
78 typedef struct ParticleReactEvent {
79         struct ParticleReactEvent *next, *prev;
80         int event, pa_num;
81         Object *ob;
82         struct ParticleSystem *psys;
83         struct ParticleKey state;
84
85         float time, size;
86 }ParticleReactEvent;
87
88 typedef struct ParticleTexture{
89         float ivel;                                                     /* used in reset */
90         float time, life, exist, size;          /* used in init */
91         float pvel[3];                                          /* used in physics */
92         float length, clump, kink, rough;       /* used in path caching */
93 } ParticleTexture;
94
95 typedef struct BoidVecFunc{
96         void (*Addf)(float *v, float *v1, float *v2);
97         void (*Subf)(float *v, float *v1, float *v2);
98         void (*Mulf)(float *v, float f);
99         float (*Length)(float *v);
100         float (*Normalize)(float *v);
101         float (*Inpf)(float *v1, float *v2);
102         void (*Copyf)(float *v1, float *v2);
103 } BoidVecFunc;
104
105 typedef struct ParticleSeam{
106         float v0[3], v1[3];
107         float nor[3], dir[3], tan[3];
108         float length2;
109 } ParticleSeam;
110
111 typedef struct ParticleCacheKey{
112         float co[3];
113         float vel[3];
114         float rot[4];
115         float col[3];
116         int steps;
117 } ParticleCacheKey;
118
119 typedef struct ParticleEditKey{
120         float *co;
121         float *vel;
122         float *rot;
123         float *time;
124
125         float world_co[3];
126         float length;
127         short flag;
128 } ParticleEditKey;
129
130 typedef struct ParticleUndo {
131         struct ParticleUndo *next, *prev;
132         struct ParticleEditKey **keys;
133         struct KDTree *emitter_field;
134         struct ParticleData *particles;
135         float *emitter_cosnos;
136         int totpart, totkeys;
137         char name[64];
138 } ParticleUndo;
139
140 typedef struct ParticleEdit{
141         ListBase undo;
142         struct ParticleUndo *curundo;
143         struct KDTree *emitter_field;
144         ParticleEditKey **keys;
145         int *mirror_cache;
146         float *emitter_cosnos;
147
148         int totkeys;
149 } ParticleEdit;
150
151 typedef struct ParticleThreadContext {
152         /* shared */
153         struct Object *ob;
154         struct DerivedMesh *dm;
155         struct ParticleSystemModifierData *psmd;
156         struct ParticleSystem *psys;
157         struct Material *ma;
158
159         /* distribution */
160         struct KDTree *tree;
161
162         struct ParticleSeam *seams;
163         int totseam;
164
165         float *jit, *jitoff, *weight;
166         float maxweight;
167         int *index, *skip, jitlevel;
168
169         int from, cfrom, distr;
170
171         struct ParticleData *tpars;
172
173         /* path caching */
174         int editupdate, between, steps;
175         int totchild, totparent;
176
177         float cfra;
178
179         float *vg_length, *vg_clump, *vg_kink;
180         float *vg_rough1, *vg_rough2, *vg_roughe;
181         float *vg_effector;
182 } ParticleThreadContext;
183
184 typedef struct ParticleThread {
185         ParticleThreadContext *ctx;
186         struct RNG *rng, *rng_path;
187         int num, tot;
188 } ParticleThread;
189
190 /* ----------- functions needed outside particlesystem ---------------- */
191 /* particle.c */
192 int count_particles(struct ParticleSystem *psys);
193 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
194 int psys_count_keys(struct ParticleSystem *psys);
195 char *psys_menu_string(struct Object *ob, int for_sb);
196
197 struct ParticleSystem *psys_get_current(struct Object *ob);
198 short psys_get_current_num(struct Object *ob);
199 //struct ParticleSystem *psys_get(struct Object *ob, int index);
200 struct ParticleData *psys_get_selected_particle(struct ParticleSystem *psys, int *index);
201 struct ParticleKey *psys_get_selected_key(struct ParticleSystem *psys, int pa_index, int *key_index);
202 void psys_change_act(void *ob_v, void *act_v);
203 struct Object *psys_get_lattice(struct Object *ob, struct ParticleSystem *psys);
204 void psys_disable_all(struct Object *ob);
205 void psys_enable_all(struct Object *ob);
206 int psys_ob_has_hair(struct Object *ob);
207 int psys_in_edit_mode(struct ParticleSystem *psys);
208 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
209
210 void psys_free_settings(struct ParticleSettings *part);
211 void free_child_path_cache(struct ParticleSystem *psys);
212 void psys_free_path_cache(struct ParticleSystem *psys);
213 void free_hair(struct ParticleSystem *psys, int softbody);
214 void free_keyed_keys(struct ParticleSystem *psys);
215 void psys_free(struct Object * ob, struct ParticleSystem * psys);
216 void psys_free_children(struct ParticleSystem *psys);
217
218 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
219 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
220 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
221 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
222
223 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
224 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
225
226 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
227
228 void psys_particle_on_emitter(struct Object *ob, 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);
229 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
230
231 struct ParticleSettings *psys_new_settings(char *name, struct Main *main);
232 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
233 void psys_flush_settings(struct ParticleSettings *part, int event, int hair_recalc);
234 void make_local_particlesettings(struct ParticleSettings *part);
235
236 struct LinkNode *psys_using_settings(struct ParticleSettings *part, int flush_update);
237 void psys_changed_type(struct ParticleSystem *psys);
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 Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
243 void psys_cache_child_paths(struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
244 int do_guide(struct ParticleKey *state, int pa_num, float time, struct ListBase *lb);
245 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);
246 float psys_get_timestep(struct ParticleSettings *part);
247 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra);
248 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
249 void psys_get_particle_on_path(struct Object *ob, struct ParticleSystem *psys, int pa_num, struct ParticleKey *state, int vel);
250 int psys_get_particle_state(struct Object *ob, struct ParticleSystem *psys, int p, struct ParticleKey *state, int always);
251 void psys_get_dupli_texture(struct Object *ob, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
252 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);
253
254 ParticleThread *psys_threads_create(struct Object *ob, struct ParticleSystem *psys);
255 int psys_threads_init_distribution(ParticleThread *threads, struct DerivedMesh *dm, int from);
256 int psys_threads_init_path(ParticleThread *threads, float cfra, int editupdate);
257 void psys_threads_free(ParticleThread *threads);
258
259 void psys_thread_distribute_particle(ParticleThread *thread, struct ParticleData *pa, struct ChildParticle *cpa, int p);
260 void psys_thread_create_path(ParticleThread *thread, struct ChildParticle *cpa, ParticleCacheKey *keys, int i);
261
262 /* particle_system.c */
263 int psys_count_keyed_targets(struct Object *ob, struct ParticleSystem *psys);
264 void psys_get_reactor_target(struct Object *ob, struct ParticleSystem *psys, struct Object **target_ob, struct ParticleSystem **target_psys);
265
266 void psys_init_effectors(struct Object *obsrc, struct Group *group, struct ParticleSystem *psys);
267 void psys_end_effectors(struct ParticleSystem *psys);
268
269 void particle_system_update(struct Object *ob, struct ParticleSystem *psys);
270
271 /* ----------- functions needed only inside particlesystem ------------ */
272 /* particle.c */
273 void psys_key_to_object(struct Object *ob, struct ParticleKey *key, float imat[][4]);
274 //void psys_key_to_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
275 //void psys_key_from_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
276 //void psys_face_mat(struct DerivedMesh *dm, struct ParticleData *pa, float mat[][4]);
277 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
278 //void psys_vec_rot_from_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
279 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
280 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
281 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
282
283 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
284 void psys_get_texture(struct Object *ob, struct Material *ma, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys, struct ParticleData *pa, struct ParticleTexture *ptex, int event);
285 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);
286 float psys_interpolate_value_from_verts(struct DerivedMesh *dm, short from, int index, float *fw, float *values);
287 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
288
289 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);
290 void psys_particle_on_dm(struct Object *ob, 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);
291
292 /* particle_system.c */
293 void initialize_particle(struct ParticleData *pa, int p, struct Object *ob, struct ParticleSystem *psys, struct ParticleSystemModifierData *psmd);
294 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);
295
296 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);
297
298 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
299 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
300
301 /* psys_reset */
302 #define PSYS_RESET_ALL                  1
303 #define PSYS_RESET_DEPSGRAPH    2
304 #define PSYS_RESET_CHILDREN     3
305
306 /* ParticleEffectorCache->type */
307 #define PSYS_EC_EFFECTOR        1
308 #define PSYS_EC_DEFLECT         2
309 #define PSYS_EC_PARTICLE        4
310 #define PSYS_EC_REACTOR         8
311
312 /* ParticleEditKey->flag */
313 #define PEK_SELECT              1
314 #define PEK_TO_SELECT   2
315 #define PEK_TAG                 4
316 #define PEK_HIDE                8
317
318 /* index_dmcache */
319 #define DMCACHE_NOTFOUND        -1
320 #define DMCACHE_ISCHILD         -2
321
322 #endif