Particles todo item: particle textures
[blender-staging.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 #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 } ParticleSimulationData;
82
83 typedef struct ParticleTexture{
84         float ivel;                                                     /* used in reset */
85         float time, life, exist, size;          /* used in init */
86         float damp, gravity, field;                     /* used in physics */
87         float length, clump, kink, effector;/* used in path caching */
88         float rough1, rough2, roughe;           /* used in path caching */
89 } ParticleTexture;
90
91 typedef struct ParticleSeam{
92         float v0[3], v1[3];
93         float nor[3], dir[3], tan[3];
94         float length2;
95 } ParticleSeam;
96
97 typedef struct ParticleCacheKey{
98         float co[3];
99         float vel[3];
100         float rot[4];
101         float col[3];
102         float time;
103         int steps;
104 } ParticleCacheKey;
105
106 typedef struct ParticleThreadContext {
107         /* shared */
108         struct ParticleSimulationData sim;
109         struct DerivedMesh *dm;
110         struct Material *ma;
111
112         /* distribution */
113         struct KDTree *tree;
114
115         struct ParticleSeam *seams;
116         int totseam;
117
118         float *jit, *jitoff, *weight;
119         float maxweight;
120         int *index, *skip, jitlevel;
121
122         int from, cfrom, distr;
123
124         struct ParticleData *tpars;
125
126         /* path caching */
127         int editupdate, between, steps;
128         int totchild, totparent, parent_pass;
129
130         float cfra;
131
132         float *vg_length, *vg_clump, *vg_kink;
133         float *vg_rough1, *vg_rough2, *vg_roughe;
134         float *vg_effector;
135 } ParticleThreadContext;
136
137 typedef struct ParticleThread {
138         ParticleThreadContext *ctx;
139         struct RNG *rng, *rng_path;
140         int num, tot;
141 } ParticleThread;
142
143 typedef struct ParticleBillboardData
144 {
145         struct Object *ob;
146         float vec[3], vel[3];
147         float offset[2];
148         float size, tilt, random, time;
149         int uv[3];
150         int lock, num;
151         int totnum;
152         short align, uv_split, anim, split_offset;
153 } ParticleBillboardData;
154
155 /* container for moving data between deflet_particle and particle_intersect_face */
156 typedef struct ParticleCollision
157 {
158         struct Object *ob, *hit_ob; // collided and current objects
159         struct CollisionModifierData *md, *hit_md; // collision modifiers for current and hit object;
160         float nor[3]; // normal at collision point
161         float vel[3]; // velocity of collision point
162         float co1[3], co2[3]; // ray start and end points
163         float ve1[3], ve2[3]; // particle velocities
164         float ray_len; // original length of co2-co1, needed for collision time evaluation
165         float f;        // time factor of previous collision, needed for substracting face velocity
166         float cfra; // start of the timestep (during frame change, since previous integer frame)
167         float dfra; // duration of timestep in frames
168 } ParticleCollision;
169
170 typedef struct ParticleDrawData {
171         float *vdata, *vd;              /* vertice data */
172         float *ndata, *nd;              /* normal data */
173         float *cdata, *cd;              /* color data */
174         float *vedata, *ved;    /* velocity data */
175         float *ma_r, *ma_g, *ma_b;
176         int tot_vec_size, flag;
177         int totpoint, totve;
178 } ParticleDrawData;
179
180 #define PARTICLE_DRAW_DATA_UPDATED  1
181
182 /* ----------- functions needed outside particlesystem ---------------- */
183 /* particle.c */
184 int count_particles(struct ParticleSystem *psys);
185 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
186
187 struct ParticleSystem *psys_get_current(struct Object *ob);
188 /* for rna */
189 short psys_get_current_num(struct Object *ob);
190 void psys_set_current_num(Object *ob, int index);
191 struct Object *psys_find_object(struct Scene *scene, struct ParticleSystem *psys);
192
193 struct Object *psys_get_lattice(struct ParticleSimulationData *sim);
194
195 int psys_in_edit_mode(struct Scene *scene, struct ParticleSystem *psys);
196 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
197 int psys_check_edited(struct ParticleSystem *psys);
198
199 void psys_check_group_weights(struct ParticleSettings *part);
200 int psys_uses_gravity(struct ParticleSimulationData *sim);
201
202 /* free */
203 void psys_free_settings(struct ParticleSettings *part);
204 void psys_free_path_cache(struct ParticleSystem *psys, struct PTCacheEdit *edit);
205 void psys_free(struct Object * ob, struct ParticleSystem * psys);
206
207 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
208 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
209 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
210 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
211
212 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
213 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
214
215 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
216
217 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);
218 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
219
220 struct ModifierData *object_add_particle_system(struct Scene *scene, struct Object *ob, const char *name);
221 void object_remove_particle_system(struct Scene *scene, struct Object *ob);
222 struct ParticleSettings *psys_new_settings(const char *name, struct Main *main);
223 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
224 void make_local_particlesettings(struct ParticleSettings *part);
225
226 void psys_reset(struct ParticleSystem *psys, int mode);
227
228 void psys_find_parents(struct ParticleSimulationData *sim);
229
230 void psys_cache_paths(struct ParticleSimulationData *sim, float cfra);
231 void psys_cache_edit_paths(struct Scene *scene, struct Object *ob, struct PTCacheEdit *edit, float cfra);
232 void psys_cache_child_paths(struct ParticleSimulationData *sim, float cfra, int editupdate);
233 int do_guides(struct ListBase *effectors, ParticleKey *state, int pa_num, float time);
234 void precalc_guides(struct ParticleSimulationData *sim, struct ListBase *effectors);
235 float psys_get_timestep(struct ParticleSimulationData *sim);
236 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *birthtime, float *dietime);
237 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
238 void psys_get_particle_on_path(struct ParticleSimulationData *sim, int pa_num, struct ParticleKey *state, int vel);
239 int psys_get_particle_state(struct ParticleSimulationData *sim, int p, struct ParticleKey *state, int always);
240
241 /* for anim.c */
242 void psys_get_dupli_texture(struct Object *ob, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
243 void psys_get_dupli_path_transform(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ChildParticle *cpa, struct ParticleCacheKey *cache, float mat[][4], float *scale);
244
245 ParticleThread *psys_threads_create(struct ParticleSimulationData *sim);
246 void psys_threads_free(ParticleThread *threads);
247
248 void psys_make_billboard(ParticleBillboardData *bb, float xvec[3], float yvec[3], float zvec[3], float center[3]);
249 void psys_apply_hair_lattice(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
250
251 /* particle_system.c */
252 struct ParticleSystem *psys_get_target_system(struct Object *ob, struct ParticleTarget *pt);
253 void psys_count_keyed_targets(struct ParticleSimulationData *sim);
254 void psys_update_particle_tree(struct ParticleSystem *psys, float cfra);
255
256 void psys_make_temp_pointcache(struct Object *ob, struct ParticleSystem *psys);
257 void psys_get_pointcache_start_end(struct Scene *scene, ParticleSystem *psys, int *sfra, int *efra);
258
259 void psys_check_boid_data(struct ParticleSystem *psys);
260
261 void particle_system_update(struct Scene *scene, struct Object *ob, struct ParticleSystem *psys);
262
263 /* ----------- functions needed only inside particlesystem ------------ */
264 /* particle.c */
265 void psys_disable_all(struct Object *ob);
266 void psys_enable_all(struct Object *ob);
267
268 void free_hair(struct Object *ob, struct ParticleSystem *psys, int dynamics);
269 void free_keyed_keys(struct ParticleSystem *psys);
270 void psys_free_particles(struct ParticleSystem *psys);
271 void psys_free_children(struct ParticleSystem *psys);
272
273 void psys_interpolate_particle(short type, struct ParticleKey keys[4], float dt, struct ParticleKey *result, int velocity);
274 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
275 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
276 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
277 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
278
279 float psys_get_dietime_from_cache(struct PointCache *cache, int index);
280
281 void psys_free_pdd(struct ParticleSystem *psys);
282
283 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
284 void psys_get_texture(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleTexture *ptex, int event, float cfra);
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_particle_value_from_verts(struct DerivedMesh *dm, short from, struct ParticleData *pa, float *values);
287 void psys_get_from_key(struct ParticleKey *key, float *loc, float *vel, float *rot, float *time);
288
289 /* only in edisparticle.c*/
290 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);
291 /* BLI_bvhtree_ray_cast callback */
292 void particle_intersect_face(void *userdata, int index, const struct BVHTreeRay *ray, struct BVHTreeRayHit *hit);
293 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);
294
295 /* particle_system.c */
296 void initialize_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, int p);
297 void psys_calc_dmcache(struct Object *ob, struct DerivedMesh *dm, struct ParticleSystem *psys);
298 int psys_particle_dm_face_lookup(struct Object *ob, struct DerivedMesh *dm, int index, float *fw, struct LinkNode *node);
299
300 void reset_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, float dtime, float cfra);
301
302 /* psys_reset */
303 #define PSYS_RESET_ALL                  1
304 #define PSYS_RESET_DEPSGRAPH    2
305 /* #define PSYS_RESET_CHILDREN  3 */ /*UNUSED*/
306 #define PSYS_RESET_CACHE_MISS   4
307
308 /* index_dmcache */
309 #define DMCACHE_NOTFOUND        -1
310 #define DMCACHE_ISCHILD         -2
311
312 #endif