Merge with trunk r39062
[blender.git] / source / blender / blenkernel / BKE_pointcache.h
1 /*
2 *
3 * ***** BEGIN GPL LICENSE BLOCK *****
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software  Foundation,
17 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 * The Original Code is Copyright (C) 2006 Blender Foundation.
20 * All rights reserved.
21 *
22 * The Original Code is: all of this file.
23 *
24 * Contributor(s): Campbell Barton <ideasman42@gmail.com>
25 *
26 * ***** END GPL LICENSE BLOCK *****
27 */
28
29 #ifndef BKE_POINTCACHE_H
30 #define BKE_POINTCACHE_H
31
32 /** \file BKE_pointcache.h
33  *  \ingroup bke
34  */
35
36 #include "DNA_ID.h"
37 #include "DNA_dynamicpaint_types.h"
38 #include "DNA_object_force.h"
39 #include "DNA_boid_types.h"
40 #include <stdio.h> /* for FILE */
41
42 /* Point cache clearing option, for BKE_ptcache_id_clear, before
43  * and after are non inclusive (they wont remove the cfra) */
44 #define PTCACHE_CLEAR_ALL               0
45 #define PTCACHE_CLEAR_FRAME             1
46 #define PTCACHE_CLEAR_BEFORE    2
47 #define PTCACHE_CLEAR_AFTER             3
48
49 /* Point cache reset options */
50 #define PTCACHE_RESET_DEPSGRAPH         0
51 #define PTCACHE_RESET_BAKED                     1
52 #define PTCACHE_RESET_OUTDATED          2
53 /* #define PTCACHE_RESET_FREE                   3 */ /*UNUSED*/
54
55 /* Add the blendfile name after blendcache_ */
56 #define PTCACHE_EXT ".bphys"
57 #define PTCACHE_PATH "blendcache_"
58
59 /* File open options, for BKE_ptcache_file_open */
60 #define PTCACHE_FILE_READ       0
61 #define PTCACHE_FILE_WRITE      1
62 #define PTCACHE_FILE_UPDATE     2
63
64 /* PTCacheID types */
65 #define PTCACHE_TYPE_SOFTBODY                   0
66 #define PTCACHE_TYPE_PARTICLES                  1
67 #define PTCACHE_TYPE_CLOTH                              2
68 #define PTCACHE_TYPE_SMOKE_DOMAIN               3
69 #define PTCACHE_TYPE_SMOKE_HIGHRES              4
70 #define PTCACHE_TYPE_DYNAMICPAINT               5
71
72 /* high bits reserved for flags that need to be stored in file */
73 #define PTCACHE_TYPEFLAG_COMPRESS               (1<<16)
74 #define PTCACHE_TYPEFLAG_EXTRADATA              (1<<17)
75
76 #define PTCACHE_TYPEFLAG_TYPEMASK                       0x0000FFFF
77 #define PTCACHE_TYPEFLAG_FLAGMASK                       0xFFFF0000
78
79 /* PTCache read return code */
80 #define PTCACHE_READ_EXACT                              1
81 #define PTCACHE_READ_INTERPOLATED               2
82 #define PTCACHE_READ_OLD                                3
83
84 /* Structs */
85 struct ClothModifierData;
86 struct ListBase;
87 struct Main;
88 struct Object;
89 struct ParticleKey;
90 struct ParticleSystem;
91 struct PointCache;
92 struct Scene;
93 struct SmokeModifierData;
94 struct SoftBody;
95
96 /* temp structure for read/write */
97 typedef struct PTCacheData {
98         unsigned int index;
99         float loc[3];
100         float vel[3];
101         float rot[4];
102         float ave[3];
103         float size;
104         float times[3];
105         struct BoidData boids;
106 } PTCacheData;
107
108 typedef struct PTCacheFile {
109         FILE *fp;
110
111         int frame, old_format;
112         unsigned int totpoint, type;
113         unsigned int data_types, flag;
114
115         struct PTCacheData data;
116         void *cur[BPHYS_TOT_DATA];
117 } PTCacheFile;
118
119 #define PTCACHE_VEL_PER_SEC             1
120
121 typedef struct PTCacheID {
122         struct PTCacheID *next, *prev;
123
124         struct Scene *scene;
125         struct Object *ob;
126         void *calldata;
127         unsigned int type;
128         unsigned int stack_index;
129         unsigned int flag;
130
131         /* flags defined in DNA_object_force.h */
132         unsigned int data_types, info_types;
133
134         /* copies point data to cache data */
135         int (*write_point)(int index, void *calldata, void **data, int cfra);
136         /* copies cache cata to point data */
137         void (*read_point)(int index, void *calldata, void **data, float cfra, float *old_data);
138         /* interpolated between previously read point data and cache data */
139         void (*interpolate_point)(int index, void *calldata, void **data, float cfra, float cfra1, float cfra2, float *old_data);
140
141         /* copies point data to cache data */
142         int (*write_stream)(PTCacheFile *pf, void *calldata);
143         /* copies cache cata to point data */
144         int (*read_stream)(PTCacheFile *pf, void *calldata);
145
146         /* copies custom extradata to cache data */
147         void (*write_extra_data)(void *calldata, struct PTCacheMem *pm, int cfra);
148         /* copies custom extradata to cache data */
149         void (*read_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra);
150         /* copies custom extradata to cache data */
151         void (*interpolate_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra, float cfra1, float cfra2);
152
153         /* total number of simulated points (the cfra parameter is just for using same function pointer with totwrite) */
154         int (*totpoint)(void *calldata, int cfra);
155         /* number of points written for current cache frame */
156         int (*totwrite)(void *calldata, int cfra);
157
158         int (*write_header)(PTCacheFile *pf);
159         int (*read_header)(PTCacheFile *pf);
160
161         struct PointCache *cache;
162         /* used for setting the current cache from ptcaches list */
163         struct PointCache **cache_ptr;
164         struct ListBase *ptcaches;
165 } PTCacheID;
166
167 typedef struct PTCacheBaker {
168         struct Main *main;
169         struct Scene *scene;
170         int bake;
171         int render;
172         int anim_init;
173         int quick_step;
174         struct PTCacheID *pid;
175         int (*break_test)(void *data);
176         void *break_data;
177         void (*progressbar)(void *data, int num);
178         void (*progressend)(void *data);
179         void *progresscontext;
180 } PTCacheBaker;
181
182 /* PTCacheEditKey->flag */
183 #define PEK_SELECT              1
184 #define PEK_TAG                 2
185 #define PEK_HIDE                4
186 #define PEK_USE_WCO             8
187
188 typedef struct PTCacheEditKey{
189         float *co;
190         float *vel;
191         float *rot;
192         float *time;
193
194         float world_co[3];
195         float ftime;
196         float length;
197         short flag;
198 } PTCacheEditKey;
199
200 /* PTCacheEditPoint->flag */
201 #define PEP_TAG                         1
202 #define PEP_EDIT_RECALC         2
203 #define PEP_TRANSFORM           4
204 #define PEP_HIDE                        8
205
206 typedef struct PTCacheEditPoint {
207         struct PTCacheEditKey *keys;
208         int totkey;
209         short flag;
210 } PTCacheEditPoint;
211
212 typedef struct PTCacheUndo {
213         struct PTCacheUndo *next, *prev;
214         struct PTCacheEditPoint *points;
215
216         /* particles stuff */
217         struct ParticleData *particles;
218         struct KDTree *emitter_field;
219         float *emitter_cosnos;
220         int psys_flag;
221
222         /* cache stuff */
223         struct ListBase mem_cache;
224
225         int totpoint;
226         char name[64];
227 } PTCacheUndo;
228
229 typedef struct PTCacheEdit {
230         ListBase undo;
231         struct PTCacheUndo *curundo;
232         PTCacheEditPoint *points;
233
234         struct PTCacheID pid;
235
236         /* particles stuff */
237         struct ParticleSystem *psys;
238         struct ParticleData *particles;
239         struct KDTree *emitter_field;
240         float *emitter_cosnos; /* localspace face centers and normals (average of its verts), from the derived mesh */
241         int *mirror_cache;
242
243         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
244         ListBase pathcachebufs;
245
246         int totpoint, totframes, totcached, edited;
247
248         unsigned char sel_col[3];
249         unsigned char nosel_col[3];
250 } PTCacheEdit;
251
252 /* Particle functions */
253 void BKE_ptcache_make_particle_key(struct ParticleKey *key, int index, void **data, float time);
254
255 /**************** Creating ID's ****************************/
256 void BKE_ptcache_id_from_softbody(PTCacheID *pid, struct Object *ob, struct SoftBody *sb);
257 void BKE_ptcache_id_from_particles(PTCacheID *pid, struct Object *ob, struct ParticleSystem *psys);
258 void BKE_ptcache_id_from_cloth(PTCacheID *pid, struct Object *ob, struct ClothModifierData *clmd);
259 void BKE_ptcache_id_from_smoke(PTCacheID *pid, struct Object *ob, struct SmokeModifierData *smd);
260 void BKE_ptcache_id_from_dynamicpaint(PTCacheID *pid, struct Object *ob, struct DynamicPaintSurface *surface);
261
262 void BKE_ptcache_ids_from_object(struct ListBase *lb, struct Object *ob, struct Scene *scene, int duplis);
263
264 /***************** Global funcs ****************************/
265 void BKE_ptcache_remove(void);
266
267 /************ ID specific functions ************************/
268 void    BKE_ptcache_id_clear(PTCacheID *id, int mode, unsigned int cfra);
269 int             BKE_ptcache_id_exist(PTCacheID *id, int cfra);
270 int             BKE_ptcache_id_reset(struct Scene *scene, PTCacheID *id, int mode);
271 void    BKE_ptcache_id_time(PTCacheID *pid, struct Scene *scene, float cfra, int *startframe, int *endframe, float *timescale);
272 int             BKE_ptcache_object_reset(struct Scene *scene, struct Object *ob, int mode);
273
274 void BKE_ptcache_update_info(PTCacheID *pid);
275
276 /*********** General cache reading/writing ******************/
277
278 /* Size of cache data type. */
279 int             BKE_ptcache_data_size(int data_type);
280
281 /* Is point with indes in memory cache */
282 int BKE_ptcache_mem_index_find(struct PTCacheMem *pm, unsigned int index);
283
284 /* Memory cache read/write helpers. */
285 void BKE_ptcache_mem_pointers_init(struct PTCacheMem *pm);
286 void BKE_ptcache_mem_pointers_incr(struct PTCacheMem *pm);
287 int  BKE_ptcache_mem_pointers_seek(int point_index, struct PTCacheMem *pm);
288
289 /* Copy a specific data type from cache data to point data. */
290 void    BKE_ptcache_data_get(void **data, int type, int index, void *to);
291
292 /* Copy a specific data type from point data to cache data. */
293 void    BKE_ptcache_data_set(void **data, int type, void *from);
294
295 /* Main cache reading call. */
296 int             BKE_ptcache_read(PTCacheID *pid, float cfra);
297
298 /* Main cache writing call. */
299 int             BKE_ptcache_write(PTCacheID *pid, unsigned int cfra);
300
301 /****************** Continue physics ***************/
302 void BKE_ptcache_set_continue_physics(struct Main *bmain, struct Scene *scene, int enable);
303 int BKE_ptcache_get_continue_physics(void);
304
305 /******************* Allocate & free ***************/
306 struct PointCache *BKE_ptcache_add(struct ListBase *ptcaches);
307 void BKE_ptcache_free_mem(struct ListBase *mem_cache);
308 void BKE_ptcache_free(struct PointCache *cache);
309 void BKE_ptcache_free_list(struct ListBase *ptcaches);
310 struct PointCache *BKE_ptcache_copy_list(struct ListBase *ptcaches_new, struct ListBase *ptcaches_old);
311
312 /********************** Baking *********************/
313
314 /* Bakes cache with cache_step sized jumps in time, not accurate but very fast. */
315 void BKE_ptcache_quick_cache_all(struct Main *bmain, struct Scene *scene);
316
317 /* Bake cache or simulate to current frame with settings defined in the baker. */
318 void BKE_ptcache_bake(struct PTCacheBaker* baker);
319
320 /* Convert disk cache to memory cache. */
321 void BKE_ptcache_disk_to_mem(struct PTCacheID *pid);
322
323 /* Convert memory cache to disk cache. */
324 void BKE_ptcache_mem_to_disk(struct PTCacheID *pid);
325
326 /* Convert disk cache to memory cache and vice versa. Clears the cache that was converted. */
327 void BKE_ptcache_toggle_disk_cache(struct PTCacheID *pid);
328
329 /* Rename all disk cache files with a new name. Doesn't touch the actual content of the files. */
330 void BKE_ptcache_disk_cache_rename(struct PTCacheID *pid, char *from, char *to);
331
332 /* Loads simulation from external (disk) cache files. */
333 void BKE_ptcache_load_external(struct PTCacheID *pid);
334
335 /* Set correct flags after successful simulation step */
336 void BKE_ptcache_validate(struct PointCache *cache, int framenr);
337
338 /* Set correct flags after unsuccessful simulation step */
339 void BKE_ptcache_invalidate(struct PointCache *cache);
340
341 #endif