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