Point Cache Refactoring
[blender-staging.git] / source / blender / blenkernel / BKE_particle.h
1 /* BKE_particle.h
2  *
3  *
4  * $Id: BKE_particle.h $
5  *
6  * ***** BEGIN GPL/BL DUAL 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. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2007 by Janne Karhu.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34
35 #ifndef BKE_PARTICLE_H
36 #define BKE_PARTICLE_H
37
38 #include "DNA_particle_types.h"
39 #include "DNA_object_types.h"
40
41 struct ParticleSystemModifierData;
42 struct ParticleSystem;
43 struct ParticleKey;
44 struct ParticleSettings;
45 struct HairKey;
46
47 struct Main;
48 struct Group;
49 struct Object;
50 struct DerivedMesh;
51 struct ModifierData;
52 struct MTFace;
53 struct MCol;
54 struct MFace;
55 struct MVert;
56 struct IpoCurve;
57 struct LinkNode;
58 struct KDTree;
59 struct RNG;
60
61 typedef struct ParticleEffectorCache {
62         struct ParticleEffectorCache *next, *prev;
63         struct Object *ob;
64         
65         /* precalculated variables for guides */
66         float firstloc[4], firstdir[3];
67         float *distances;
68         float *locations;
69         /* precalculated variables for deflection */
70         float ob_minmax[6];
71         float *face_minmax;
72         float *vert_cos;
73         /* precalculated variables for boids */
74         struct KDTree *tree;
75
76         short type, psys_nbr;
77         
78         struct Object obcopy;   /* for restoring transformation data */
79 } ParticleEffectorCache;
80
81 typedef struct ParticleReactEvent {
82         struct ParticleReactEvent *next, *prev;
83         int event, pa_num;
84         Object *ob;
85         struct ParticleSystem *psys;
86         struct ParticleKey state;
87
88         float time, size;
89 }ParticleReactEvent;
90
91 typedef struct ParticleTexture{
92         float ivel;                                                     /* used in reset */
93         float time, life, exist, size;          /* used in init */
94         float pvel[3];                                          /* used in physics */
95         float length, clump, kink, rough;       /* 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         struct KDTree *emitter_field;
147         ParticleEditKey **keys;
148         int *mirror_cache;
149         float *emitter_cosnos;
150
151         int totkeys;
152 } ParticleEdit;
153
154 typedef struct ParticleThreadContext {
155         /* shared */
156         struct Object *ob;
157         struct DerivedMesh *dm;
158         struct ParticleSystemModifierData *psmd;
159         struct ParticleSystem *psys;
160         struct Material *ma;
161
162         /* distribution */
163         struct KDTree *tree;
164
165         struct ParticleSeam *seams;
166         int totseam;
167
168         float *jit, *jitoff, *weight;
169         float maxweight;
170         int *index, *skip, jitlevel;
171
172         int from, cfrom, distr;
173
174         struct ParticleData *tpars;
175
176         /* path caching */
177         int editupdate, between, steps;
178         int totchild, totparent;
179
180         float cfra;
181
182         float *vg_length, *vg_clump, *vg_kink;
183         float *vg_rough1, *vg_rough2, *vg_roughe;
184         float *vg_effector;
185 } ParticleThreadContext;
186
187 typedef struct ParticleThread {
188         ParticleThreadContext *ctx;
189         struct RNG *rng, *rng_path;
190         int num, tot;
191 } ParticleThread;
192
193 /* ----------- functions needed outside particlesystem ---------------- */
194 /* particle.c */
195 int count_particles(struct ParticleSystem *psys);
196 int count_particles_mod(struct ParticleSystem *psys, int totgr, int cur);
197 int psys_count_keys(struct ParticleSystem *psys);
198 char *psys_menu_string(struct Object *ob, int for_sb);
199
200 struct ParticleSystem *psys_get_current(struct Object *ob);
201 short psys_get_current_num(struct Object *ob);
202 //struct ParticleSystem *psys_get(struct Object *ob, int index);
203 struct ParticleData *psys_get_selected_particle(struct ParticleSystem *psys, int *index);
204 struct ParticleKey *psys_get_selected_key(struct ParticleSystem *psys, int pa_index, int *key_index);
205 void psys_change_act(void *ob_v, void *act_v);
206 struct Object *psys_get_lattice(struct Object *ob, struct ParticleSystem *psys);
207 void psys_disable_all(struct Object *ob);
208 void psys_enable_all(struct Object *ob);
209 int psys_ob_has_hair(struct Object *ob);
210 int psys_in_edit_mode(struct ParticleSystem *psys);
211 int psys_check_enabled(struct Object *ob, struct ParticleSystem *psys);
212
213 void psys_free_settings(struct ParticleSettings *part);
214 void free_child_path_cache(struct ParticleSystem *psys);
215 void psys_free_path_cache(struct ParticleSystem *psys);
216 void free_hair(struct ParticleSystem *psys, int softbody);
217 void free_keyed_keys(struct ParticleSystem *psys);
218 void psys_free(struct Object * ob, struct ParticleSystem * psys);
219 void psys_free_children(struct ParticleSystem *psys);
220
221 void psys_render_set(struct Object *ob, struct ParticleSystem *psys, float viewmat[][4], float winmat[][4], int winx, int winy, int timeoffset);
222 void psys_render_restore(struct Object *ob, struct ParticleSystem *psys);
223 int psys_render_simplify_distribution(struct ParticleThreadContext *ctx, int tot);
224 int psys_render_simplify_params(struct ParticleSystem *psys, struct ChildParticle *cpa, float *params);
225
226 void psys_interpolate_uvs(struct MTFace *tface, int quad, float *uv, float *uvco);
227 void psys_interpolate_mcol(struct MCol *mcol, int quad, float *uv, struct MCol *mc);
228
229 void copy_particle_key(struct ParticleKey *to, struct ParticleKey *from, int time);
230
231 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);
232 struct ParticleSystemModifierData *psys_get_modifier(struct Object *ob, struct ParticleSystem *psys);
233
234 struct ParticleSettings *psys_new_settings(char *name, struct Main *main);
235 struct ParticleSettings *psys_copy_settings(struct ParticleSettings *part);
236 void psys_flush_settings(struct ParticleSettings *part, int event, int hair_recalc);
237
238 struct LinkNode *psys_using_settings(struct ParticleSettings *part, int flush_update);
239 void psys_changed_type(struct ParticleSystem *psys);
240 void psys_reset(struct ParticleSystem *psys, int mode);
241
242 void psys_find_parents(struct Object *ob, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys);
243
244 void psys_cache_paths(struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
245 void psys_cache_child_paths(struct Object *ob, struct ParticleSystem *psys, float cfra, int editupdate);
246 int do_guide(struct ParticleKey *state, int pa_num, float time, struct ListBase *lb);
247 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);
248 float psys_get_timestep(struct ParticleSettings *part);
249 float psys_get_child_time(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra);
250 float psys_get_child_size(struct ParticleSystem *psys, struct ChildParticle *cpa, float cfra, float *pa_time);
251 void psys_get_particle_on_path(struct Object *ob, struct ParticleSystem *psys, int pa_num, struct ParticleKey *state, int vel);
252 int psys_get_particle_state(struct Object *ob, struct ParticleSystem *psys, int p, struct ParticleKey *state, int always);
253 void psys_get_dupli_texture(struct Object *ob, struct ParticleSettings *part, struct ParticleSystemModifierData *psmd, struct ParticleData *pa, struct ChildParticle *cpa, float *uv, float *orco);
254 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);
255
256 ParticleThread *psys_threads_create(struct Object *ob, struct ParticleSystem *psys);
257 int psys_threads_init_distribution(ParticleThread *threads, struct DerivedMesh *dm, int from);
258 int psys_threads_init_path(ParticleThread *threads, float cfra, int editupdate);
259 void psys_threads_free(ParticleThread *threads);
260
261 void psys_thread_distribute_particle(ParticleThread *thread, struct ParticleData *pa, struct ChildParticle *cpa, int p);
262 void psys_thread_create_path(ParticleThread *thread, struct ChildParticle *cpa, ParticleCacheKey *keys, int i);
263
264 /* particle_system.c */
265 int psys_count_keyed_targets(struct Object *ob, struct ParticleSystem *psys);
266 void psys_get_reactor_target(struct Object *ob, struct ParticleSystem *psys, struct Object **target_ob, struct ParticleSystem **target_psys);
267
268 void psys_init_effectors(struct Object *obsrc, struct Group *group, struct ParticleSystem *psys);
269 void psys_end_effectors(struct ParticleSystem *psys);
270
271 void particle_system_update(struct Object *ob, struct ParticleSystem *psys);
272
273 /* ----------- functions needed only inside particlesystem ------------ */
274 /* particle.c */
275 void psys_key_to_object(struct Object *ob, struct ParticleKey *key, float imat[][4]);
276 //void psys_key_to_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
277 //void psys_key_from_geometry(struct DerivedMesh *dm, struct ParticleData *pa, struct ParticleKey *key);
278 //void psys_face_mat(struct DerivedMesh *dm, struct ParticleData *pa, float mat[][4]);
279 void psys_vec_rot_to_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
280 //void psys_vec_rot_from_face(struct DerivedMesh *dm, struct ParticleData *pa, float *vec);
281 void psys_mat_hair_to_object(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
282 void psys_mat_hair_to_global(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
283 void psys_mat_hair_to_orco(struct Object *ob, struct DerivedMesh *dm, short from, struct ParticleData *pa, float hairmat[][4]);
284
285 float *psys_cache_vgroup(struct DerivedMesh *dm, struct ParticleSystem *psys, int vgroup);
286 void psys_get_texture(struct Object *ob, struct Material *ma, struct ParticleSystemModifierData *psmd, struct ParticleSystem *psys, struct ParticleData *pa, struct ParticleTexture *ptex, int event);
287 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);
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 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);
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
308 /* ParticleEffectorCache->type */
309 #define PSYS_EC_EFFECTOR        1
310 #define PSYS_EC_DEFLECT         2
311 #define PSYS_EC_PARTICLE        4
312 #define PSYS_EC_REACTOR         8
313
314 /* ParticleEditKey->flag */
315 #define PEK_SELECT              1
316 #define PEK_TO_SELECT   2
317 #define PEK_TAG                 4
318 #define PEK_HIDE                8
319
320 /* index_dmcache */
321 #define DMCACHE_NOTFOUND        -1
322 #define DMCACHE_ISCHILD         -2
323
324 #endif