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