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