remove/comment unused defines.
[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 typedef struct PTCacheFile {
103         FILE *fp;
104
105         int frame, old_format;
106         unsigned int totpoint, type;
107         unsigned int data_types, flag;
108
109         struct PTCacheData data;
110         void *cur[BPHYS_TOT_DATA];
111 } PTCacheFile;
112
113 #define PTCACHE_VEL_PER_SEC             1
114
115 typedef struct PTCacheID {
116         struct PTCacheID *next, *prev;
117
118         struct Scene *scene;
119         struct Object *ob;
120         void *calldata;
121         unsigned int type;
122         unsigned int stack_index;
123         unsigned int flag;
124
125         /* flags defined in DNA_object_force.h */
126         unsigned int data_types, info_types;
127
128         /* copies point data to cache data */
129         int (*write_point)(int index, void *calldata, void **data, int cfra);
130         /* copies cache cata to point data */
131         void (*read_point)(int index, void *calldata, void **data, float cfra, float *old_data);
132         /* interpolated between previously read point data and cache data */
133         void (*interpolate_point)(int index, void *calldata, void **data, float cfra, float cfra1, float cfra2, float *old_data);
134
135         /* copies point data to cache data */
136         int (*write_stream)(PTCacheFile *pf, void *calldata);
137         /* copies cache cata to point data */
138         void (*read_stream)(PTCacheFile *pf, void *calldata);
139
140         /* copies custom extradata to cache data */
141         void (*write_extra_data)(void *calldata, struct PTCacheMem *pm, int cfra);
142         /* copies custom extradata to cache data */
143         void (*read_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra);
144         /* copies custom extradata to cache data */
145         void (*interpolate_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra, float cfra1, float cfra2);
146
147         /* total number of simulated points (the cfra parameter is just for using same function pointer with totwrite) */
148         int (*totpoint)(void *calldata, int cfra);
149         /* number of points written for current cache frame */
150         int (*totwrite)(void *calldata, int cfra);
151
152         int (*write_header)(PTCacheFile *pf);
153         int (*read_header)(PTCacheFile *pf);
154
155         struct PointCache *cache;
156         /* used for setting the current cache from ptcaches list */
157         struct PointCache **cache_ptr;
158         struct ListBase *ptcaches;
159 } PTCacheID;
160
161 typedef struct PTCacheBaker {
162         struct Main *main;
163         struct Scene *scene;
164         int bake;
165         int render;
166         int anim_init;
167         int quick_step;
168         struct PTCacheID *pid;
169         int (*break_test)(void *data);
170         void *break_data;
171         void (*progressbar)(void *data, int num);
172         void (*progressend)(void *data);
173         void *progresscontext;
174 } PTCacheBaker;
175
176 /* PTCacheEditKey->flag */
177 #define PEK_SELECT              1
178 #define PEK_TAG                 2
179 #define PEK_HIDE                4
180 #define PEK_USE_WCO             8
181
182 typedef struct PTCacheEditKey{
183         float *co;
184         float *vel;
185         float *rot;
186         float *time;
187
188         float world_co[3];
189         float ftime;
190         float length;
191         short flag;
192 } PTCacheEditKey;
193
194 /* PTCacheEditPoint->flag */
195 #define PEP_TAG                         1
196 #define PEP_EDIT_RECALC         2
197 #define PEP_TRANSFORM           4
198 #define PEP_HIDE                        8
199
200 typedef struct PTCacheEditPoint {
201         struct PTCacheEditKey *keys;
202         int totkey;
203         short flag;
204 } PTCacheEditPoint;
205
206 typedef struct PTCacheUndo {
207         struct PTCacheUndo *next, *prev;
208         struct PTCacheEditPoint *points;
209
210         /* particles stuff */
211         struct ParticleData *particles;
212         struct KDTree *emitter_field;
213         float *emitter_cosnos;
214         int psys_flag;
215
216         /* cache stuff */
217         struct ListBase mem_cache;
218
219         int totpoint;
220         char name[64];
221 } PTCacheUndo;
222
223 typedef struct PTCacheEdit {
224         ListBase undo;
225         struct PTCacheUndo *curundo;
226         PTCacheEditPoint *points;
227
228         struct PTCacheID pid;
229
230         /* particles stuff */
231         struct ParticleSystem *psys;
232         struct ParticleData *particles;
233         struct KDTree *emitter_field;
234         float *emitter_cosnos; /* localspace face centers and normals (average of its verts), from the derived mesh */
235         int *mirror_cache;
236
237         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
238         ListBase pathcachebufs;
239
240         int totpoint, totframes, totcached, edited;
241
242         unsigned char sel_col[3];
243         unsigned char nosel_col[3];
244 } PTCacheEdit;
245
246 /* Particle functions */
247 void BKE_ptcache_make_particle_key(struct ParticleKey *key, int index, void **data, float time);
248
249 /**************** Creating ID's ****************************/
250 void BKE_ptcache_id_from_softbody(PTCacheID *pid, struct Object *ob, struct SoftBody *sb);
251 void BKE_ptcache_id_from_particles(PTCacheID *pid, struct Object *ob, struct ParticleSystem *psys);
252 void BKE_ptcache_id_from_cloth(PTCacheID *pid, struct Object *ob, struct ClothModifierData *clmd);
253 void BKE_ptcache_id_from_smoke(PTCacheID *pid, struct Object *ob, struct SmokeModifierData *smd);
254
255 void BKE_ptcache_ids_from_object(struct ListBase *lb, struct Object *ob, struct Scene *scene, int duplis);
256
257 /***************** Global funcs ****************************/
258 void BKE_ptcache_remove(void);
259
260 /************ ID specific functions ************************/
261 void    BKE_ptcache_id_clear(PTCacheID *id, int mode, unsigned int cfra);
262 int             BKE_ptcache_id_exist(PTCacheID *id, int cfra);
263 int             BKE_ptcache_id_reset(struct Scene *scene, PTCacheID *id, int mode);
264 void    BKE_ptcache_id_time(PTCacheID *pid, struct Scene *scene, float cfra, int *startframe, int *endframe, float *timescale);
265 int             BKE_ptcache_object_reset(struct Scene *scene, struct Object *ob, int mode);
266
267 void BKE_ptcache_update_info(PTCacheID *pid);
268
269 /*********** General cache reading/writing ******************/
270
271 /* Size of cache data type. */
272 int             BKE_ptcache_data_size(int data_type);
273
274 /* Is point with indes in memory cache */
275 int BKE_ptcache_mem_index_find(struct PTCacheMem *pm, unsigned int index);
276
277 /* Memory cache read/write helpers. */
278 void BKE_ptcache_mem_pointers_init(struct PTCacheMem *pm);
279 void BKE_ptcache_mem_pointers_incr(struct PTCacheMem *pm);
280 int  BKE_ptcache_mem_pointers_seek(int point_index, struct PTCacheMem *pm);
281
282 /* Copy a specific data type from cache data to point data. */
283 void    BKE_ptcache_data_get(void **data, int type, int index, void *to);
284
285 /* Copy a specific data type from point data to cache data. */
286 void    BKE_ptcache_data_set(void **data, int type, void *from);
287
288 /* Main cache reading call. */
289 int             BKE_ptcache_read(PTCacheID *pid, float cfra);
290
291 /* Main cache writing call. */
292 int             BKE_ptcache_write(PTCacheID *pid, unsigned int cfra);
293
294 /****************** Continue physics ***************/
295 void BKE_ptcache_set_continue_physics(struct Main *bmain, struct Scene *scene, int enable);
296 int BKE_ptcache_get_continue_physics(void);
297
298 /******************* Allocate & free ***************/
299 struct PointCache *BKE_ptcache_add(struct ListBase *ptcaches);
300 void BKE_ptcache_free_mem(struct ListBase *mem_cache);
301 void BKE_ptcache_free(struct PointCache *cache);
302 void BKE_ptcache_free_list(struct ListBase *ptcaches);
303 struct PointCache *BKE_ptcache_copy_list(struct ListBase *ptcaches_new, struct ListBase *ptcaches_old);
304
305 /********************** Baking *********************/
306
307 /* Bakes cache with cache_step sized jumps in time, not accurate but very fast. */
308 void BKE_ptcache_quick_cache_all(struct Main *bmain, struct Scene *scene);
309
310 /* Bake cache or simulate to current frame with settings defined in the baker. */
311 void BKE_ptcache_bake(struct PTCacheBaker* baker);
312
313 /* Convert disk cache to memory cache. */
314 void BKE_ptcache_disk_to_mem(struct PTCacheID *pid);
315
316 /* Convert memory cache to disk cache. */
317 void BKE_ptcache_mem_to_disk(struct PTCacheID *pid);
318
319 /* Convert disk cache to memory cache and vice versa. Clears the cache that was converted. */
320 void BKE_ptcache_toggle_disk_cache(struct PTCacheID *pid);
321
322 /* Rename all disk cache files with a new name. Doesn't touch the actual content of the files. */
323 void BKE_ptcache_disk_cache_rename(struct PTCacheID *pid, char *from, char *to);
324
325 /* Loads simulation from external (disk) cache files. */
326 void BKE_ptcache_load_external(struct PTCacheID *pid);
327
328 /* Set correct flags after successful simulation step */
329 void BKE_ptcache_validate(struct PointCache *cache, int framenr);
330
331 /* Set correct flags after unsuccessful simulation step */
332 void BKE_ptcache_invalidate(struct PointCache *cache);
333
334 #endif