minor edit - weight_to_rgb() and ramp_blend() now take a float vector rather than...
[blender.git] / source / blender / blenkernel / BKE_particle.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 by Janne Karhu.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef BKE_PARTICLE_H
29 #define BKE_PARTICLE_H
30
31 /** \file BKE_particle.h
32  *  \ingroup bke
33  */
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 #define LOOP_EXISTING_PARTICLES for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++) if(!(pa->flag & PARS_UNEXIST))
65 #define LOOP_SHOWN_PARTICLES for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++) if(!(pa->flag & (PARS_UNEXIST|PARS_NO_DISP)))
66 #define LOOP_DYNAMIC_PARTICLES for(p=0, pa=psys->particles; p<psys->totpart; p++, pa++) if(pa->state.time > 0.f)
67
68 #define PSYS_FRAND_COUNT        1024
69 #define PSYS_FRAND(seed)        psys->frand[(seed) % PSYS_FRAND_COUNT]
70
71 /* fast but sure way to get the modifier*/
72 #define PARTICLE_PSMD ParticleSystemModifierData *psmd = sim->psmd ? sim->psmd : psys_get_modifier(sim->ob, sim->psys)
73
74 /* common stuff that many particle functions need */
75 typedef struct ParticleSimulationData {
76         struct Scene *scene;
77         struct Object *ob;
78         struct ParticleSystem *psys;
79         struct ParticleSystemModifierData *psmd;
80         struct ListBase *colliders;
81         /* Courant number. This is used to implement an adaptive time step. Only the
82            maximum value per time step is important. Only sph_integrate makes use of
83            this at the moment. Other solvers could, too. */
84         float courant_num;
85 } ParticleSimulationData;
86
87 typedef struct ParticleTexture{
88         float ivel;                                                     /* used in reset */
89         float time, life, exist, size;          /* used in init */
90         float damp, gravity, field;                     /* used in physics */
91         float length, clump, kink, effector;/* used in path caching */
92         float rough1, rough2, roughe;           /* used in path caching */
93 } ParticleTexture;
94
95 typedef struct ParticleSeam{
96         float v0[3], v1[3];
97         float nor[3], dir[3], tan[3];
98         float length2;
99 } ParticleSeam;
100
101 typedef struct ParticleCacheKey{
102         float co[3];
103         float vel[3];
104         float rot[4];
105         float col[3];
106         float time;
107         int steps;
108 } ParticleCacheKey;
109
110 typedef struct ParticleThreadContext {
111         /* shared */
112         struct ParticleSimulationData sim;
113         struct DerivedMesh *dm;
114         struct Material *ma;
115
116         /* distribution */
117         struct KDTree *tree;
118
119         struct ParticleSeam *seams;
120         int totseam;
121
122         float *jit, *jitoff, *weight;
123         float maxweight;
124         int *index, *skip, jitlevel;
125
126         int from, cfrom, distr;
127
128         struct ParticleData *tpars;
129
130         /* path caching */
131         int editupdate, between, steps;
132         int totchild, totparent, parent_pass;
133
134         float cfra;
135
136         float *vg_length, *vg_clump, *vg_kink;
137         float *vg_rough1, *vg_rough2, *vg_roughe;
138         float *vg_effector;
139 } ParticleThreadContext;
140
141 typedef struct ParticleThread {
142         ParticleThreadContext *ctx;
143         struct RNG *rng, *rng_path;
144         int num, tot;
145 } ParticleThread;
146
147 typedef struct ParticleBillboardData
148 {
149         struct Object *ob;
150         float vec[3], vel[3];
151         float offset[2];
152         float size[2];
153         float tilt, random, time;
154         int uv[3];
155         int lock, num;
156         int totnum;
157         int lifetime;
158         short align, uv_split, anim, split_offset;
159 } ParticleBillboardData;
160
161 typedef struct ParticleCollisionElement
162 {
163         /* pointers to original data */
164         float *x[4], *v[4];
165
166         /* values interpolated from original data*/
167         float x0[3], x1[3], x2[3], p[3];
168         
169         /* results for found intersection point */
170         float nor[3], vel[3], uv[2];
171
172         /* count of original data (1-4) */
173         int tot;
174
175         /* index of the collision face */
176         int index;
177
178         /* flags for inversed normal / particle already inside element at start */
179         short inv_nor, inside;
180 } ParticleCollisionElement;
181
182 /* container for moving data between deflet_particle and particle_intersect_face */
183 typedef struct ParticleCollision
184 {
185         struct Object *current;
186         struct Object *hit;
187         struct Object *prev;
188         struct Object *skip;
189         struct Object *emitter;
190
191         struct CollisionModifierData *md; // collision modifier for current object;
192
193         float f;        // time factor of previous collision, needed for substracting face velocity
194         float fac1, fac2;
195
196         float cfra, old_cfra;
197
198         float original_ray_length; //original length of co2-co1, needed for collision time evaluation
199
200         int prev_index;
201
202         ParticleCollisionElement pce;
203
204         float total_time, inv_timestep;
205
206         float radius;
207         float co1[3], co2[3];
208         float ve1[3], ve2[3];
209
210         float acc[3], boid_z;
211
212         int boid;
213 } ParticleCollision;
214
215 typedef struct ParticleDrawData {
216         float *vdata, *vd;              /* vertice data */
217         float *ndata, *nd;              /* normal data */
218         float *cdata, *cd;              /* color data */
219         float *vedata, *ved;    /* velocity data */
220         float *ma_col;
221         int tot_vec_size, flag;
222         int totpoint, totve;
223 } ParticleDrawData;
224
225 #define PARTICLE_DRAW_DATA_UPDATED  1
226
227 /* ----------- functions needed outside particlesystem ---------------- */
228 /* particle.c */
229 int count_particles(struct ParticleSystem *psys);
230 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
231
232 struct ParticleSystem *psys_get_current(struct Object *ob);
233 /* for rna */
234 short psys_get_current_num(struct Object *ob);
235 void psys_set_current_num(Object *ob, int index);
236 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
237
238 struct Object *psys_get_lattice(struct ParticleSimulationData *sim);
239
240 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
241 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
242 int psys_check_edited(struct ParticleSystem *psys);
243
244 void psys_check_group_weights(struct ParticleSettings *part);
245 int psys_uses_gravity(struct ParticleSimulationData *sim);
246
247 /* free */
248 void psys_free_settings(struct ParticleSettings *part);
249 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
250 void psys_free(struct Object * ob, struct ParticleSystem * psys);
251
252 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
253 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
254 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
255 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
256
257 void psys_interpolate_uvs(const struct MTFace *tface, int quad, const float w[4], float uvco[2]);
258 void psys_interpolate_mcol(const struct MCol *mcol, int quad, const float w[4], struct MCol *mc);
259
260 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
261
262 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);
263 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
264
265 struct ModifierData *object_add_particle_system(struct Scene *scene, struct Object *ob, const char *name);
266 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
267 struct ParticleSettings *psys_new_settings(const char *name, struct Main *main);
268 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
269 void make_local_particlesettings(struct ParticleSettings *part);
270
271 void psys_reset(struct ParticleSystem *psys, int mode);
272
273 void psys_find_parents(struct ParticleSimulationData *sim);
274
275 void psys_cache_paths(struct ParticleSimulationData *sim, float cfra);
276 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra);
277 void psys_cache_child_paths(struct ParticleSimulationData *sim, float cfra, int editupdate);
278 int do_guides(struct ListBase *effectors, ParticleKey *state, int pa_num, float time);
279 void precalc_guides(struct ParticleSimulationData *sim, struct ListBase *effectors);
280 float psys_get_timestep(struct ParticleSimulationData *sim);
281 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
282 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
283 void psys_get_particle_on_path(struct ParticleSimulationData *sim, int pa_num, struct ParticleKey *state, int vel);
284 int psys_get_particle_state(struct ParticleSimulationData *sim, int p, struct ParticleKey *state, int always);
285
286 /* for anim.c */
287 void psys_get_dupli_texture(struct ParticleSystem *psys, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
288 void psys_get_dupli_path_transform(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ChildParticle *cpa, struct ParticleCacheKey *cache, float mat[][4], float *scale);
289
290 ParticleThread *psys_threads_create(struct ParticleSimulationData *sim);
291 void psys_threads_free(ParticleThread *threads);
292
293 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
294 void psys_apply_hair_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
295
296 /* particle_system.c */
297 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
298 void psys_count_keyed_targets(struct ParticleSimulationData *sim);
299 void psys_update_particle_tree(struct ParticleSystem *psys, float cfra);
300
301 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
302 void psys_get_pointcache_start_end(struct Scene *scene, ParticleSystem *psys, int *sfra, int *efra);
303
304 void psys_check_boid_data(struct ParticleSystem *psys);
305
306 void psys_get_birth_coordinates(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, float dtime, float cfra);
307
308 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
309
310 /* ----------- functions needed only inside particlesystem ------------ */
311 /* particle.c */
312 void psys_disable_all(struct Object *ob);
313 void psys_enable_all(struct Object *ob);
314
315 void free_hair(struct Object *ob, struct ParticleSystem *psys, int dynamics);
316 void free_keyed_keys(struct ParticleSystem *psys);
317 void psys_free_particles(struct ParticleSystem *psys);
318 void psys_free_children(struct ParticleSystem *psys);
319
320 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
321 void psys_vec_rot_to_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_get_dietime_from_cache(struct PointCache *cache, int index);
327
328 void psys_free_pdd(struct ParticleSystem *psys);
329
330 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
331 void psys_get_texture(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleTexture *ptex, int event, float cfra);
332 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);
333 float psys_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
334 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
335
336 /* BLI_bvhtree_ray_cast callback */
337 void BKE_psys_collision_neartest_cb(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
338 void psys_particle_on_dm(struct DerivedMesh *dm, int from, int index, int index_dmcache, const float fw[4], float foffset, float vec[3], float nor[3], float utan[3], float vtan[3], float orco[3], float ornor[3]);
339
340 /* particle_system.c */
341 void initialize_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, int p);
342 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
343 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, const float fw[4], struct LinkNode *node);
344
345 void reset_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, float dtime, float cfra);
346
347 /* psys_reset */
348 #define PSYS_RESET_ALL                  1
349 #define PSYS_RESET_DEPSGRAPH    2
350 /* #define PSYS_RESET_CHILDREN  3 */ /*UNUSED*/
351 #define PSYS_RESET_CACHE_MISS   4
352
353 /* index_dmcache */
354 #define DMCACHE_NOTFOUND        -1
355 #define DMCACHE_ISCHILD         -2
356
357 #endif