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