synched with trunk at revision 32129
[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
36 /* Point cache clearing option, for BKE_ptcache_id_clear, before
37  * and after are non inclusive (they wont remove the cfra) */
38 #define PTCACHE_CLEAR_ALL               0
39 #define PTCACHE_CLEAR_FRAME             1
40 #define PTCACHE_CLEAR_BEFORE    2
41 #define PTCACHE_CLEAR_AFTER             3
42
43 /* Point cache reset options */
44 #define PTCACHE_RESET_DEPSGRAPH         0
45 #define PTCACHE_RESET_BAKED                     1
46 #define PTCACHE_RESET_OUTDATED          2
47 #define PTCACHE_RESET_FREE                      3
48
49 /* Add the blendfile name after blendcache_ */
50 #define PTCACHE_EXT ".bphys"
51 #define PTCACHE_PATH "blendcache_"
52
53 /* File open options, for BKE_ptcache_file_open */
54 #define PTCACHE_FILE_READ       0
55 #define PTCACHE_FILE_WRITE      1
56 #define PTCACHE_FILE_UPDATE     2
57
58 /* PTCacheID types */
59 #define PTCACHE_TYPE_SOFTBODY                   0
60 #define PTCACHE_TYPE_PARTICLES                  1
61 #define PTCACHE_TYPE_CLOTH                              2
62 #define PTCACHE_TYPE_SMOKE_DOMAIN               3
63 #define PTCACHE_TYPE_SMOKE_HIGHRES              4
64
65 /* PTCache read return code */
66 #define PTCACHE_READ_EXACT                              1
67 #define PTCACHE_READ_INTERPOLATED               2
68 #define PTCACHE_READ_OLD                                3
69
70 /* Structs */
71 struct ClothModifierData;
72 struct ListBase;
73 struct Main;
74 struct Object;
75 struct ParticleKey;
76 struct ParticleSystem;
77 struct PointCache;
78 struct Scene;
79 struct SmokeModifierData;
80 struct SoftBody;
81
82 /* temp structure for read/write */
83 typedef struct PTCacheData {
84         int index;
85         float loc[3];
86         float vel[3];
87         float rot[4];
88         float ave[3];
89         float size;
90         float times[3];
91         struct BoidData boids;
92 } PTCacheData;
93
94 typedef struct PTCacheFile {
95         FILE *fp;
96
97         int totpoint, type;
98         unsigned int data_types;
99
100         struct PTCacheData data;
101         void *cur[BPHYS_TOT_DATA];
102 } PTCacheFile;
103
104 #define PTCACHE_VEL_PER_SEC             1
105
106 typedef struct PTCacheID {
107         struct PTCacheID *next, *prev;
108
109         struct Scene *scene;
110         struct Object *ob;
111         void *calldata;
112         int type;
113         int stack_index;
114         int flag;
115
116         /* flags defined in DNA_object_force.h */
117         unsigned int data_types, info_types;
118
119         /* copies point data to cache data */
120         int (*write_elem)(int index, void *calldata, void **data, int cfra);
121         /* copies point data to cache data */
122         int (*write_stream)(PTCacheFile *pf, void *calldata);
123         /* copies cache cata to point data */
124         void (*read_elem)(int index, void *calldata, void **data, float frs_sec, float cfra, float *old_data);
125         /* copies cache cata to point data */
126         void (*read_stream)(PTCacheFile *pf, void *calldata);
127         /* interpolated between previously read point data and cache data */
128         void (*interpolate_elem)(int index, void *calldata, void **data, float frs_sec, float cfra, float cfra1, float cfra2, float *old_data);
129
130         /* total number of simulated points (the cfra parameter is just for using same function pointer with totwrite) */
131         int (*totpoint)(void *calldata, int cfra);
132         /* number of points written for current cache frame */
133         int (*totwrite)(void *calldata, int cfra);
134
135         int (*write_header)(PTCacheFile *pf);
136         int (*read_header)(PTCacheFile *pf);
137
138         struct PointCache *cache;
139         /* used for setting the current cache from ptcaches list */
140         struct PointCache **cache_ptr;
141         struct ListBase *ptcaches;
142 } PTCacheID;
143
144 typedef struct PTCacheBaker {
145         struct Main *main;
146         struct Scene *scene;
147         int bake;
148         int render;
149         int anim_init;
150         int quick_step;
151         struct PTCacheID *pid;
152         int (*break_test)(void *data);
153         void *break_data;
154         void (*progressbar)(void *data, int num);
155         void (*progressend)(void *data);
156         void *progresscontext;
157 } PTCacheBaker;
158
159 /* PTCacheEditKey->flag */
160 #define PEK_SELECT              1
161 #define PEK_TAG                 2
162 #define PEK_HIDE                4
163 #define PEK_USE_WCO             8
164
165 typedef struct PTCacheEditKey{
166         float *co;
167         float *vel;
168         float *rot;
169         float *time;
170
171         float world_co[3];
172         float ftime;
173         float length;
174         short flag;
175 } PTCacheEditKey;
176
177 /* PTCacheEditPoint->flag */
178 #define PEP_TAG                         1
179 #define PEP_EDIT_RECALC         2
180 #define PEP_TRANSFORM           4
181 #define PEP_HIDE                        8
182
183 typedef struct PTCacheEditPoint {
184         struct PTCacheEditKey *keys;
185         int totkey;
186         short flag;
187 } PTCacheEditPoint;
188
189 typedef struct PTCacheUndo {
190         struct PTCacheUndo *next, *prev;
191         struct PTCacheEditPoint *points;
192
193         /* particles stuff */
194         struct ParticleData *particles;
195         struct KDTree *emitter_field;
196         float *emitter_cosnos;
197         int psys_flag;
198
199         /* cache stuff */
200         struct ListBase mem_cache;
201
202         int totpoint;
203         char name[64];
204 } PTCacheUndo;
205
206 typedef struct PTCacheEdit {
207         ListBase undo;
208         struct PTCacheUndo *curundo;
209         PTCacheEditPoint *points;
210
211         struct PTCacheID pid;
212
213         /* particles stuff */
214         struct ParticleSystem *psys;
215         struct ParticleData *particles;
216         struct KDTree *emitter_field;
217         float *emitter_cosnos; /* localspace face centers and normals (average of its verts), from the derived mesh */
218         int *mirror_cache;
219
220         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
221         ListBase pathcachebufs;
222
223         int totpoint, totframes, totcached, edited;
224
225         char sel_col[3];
226         char nosel_col[3];
227 } PTCacheEdit;
228
229 /* Particle functions */
230 void BKE_ptcache_make_particle_key(struct ParticleKey *key, int index, void **data, float time);
231
232 /**************** Creating ID's ****************************/
233 void BKE_ptcache_id_from_softbody(PTCacheID *pid, struct Object *ob, struct SoftBody *sb);
234 void BKE_ptcache_id_from_particles(PTCacheID *pid, struct Object *ob, struct ParticleSystem *psys);
235 void BKE_ptcache_id_from_cloth(PTCacheID *pid, struct Object *ob, struct ClothModifierData *clmd);
236 void BKE_ptcache_id_from_smoke(PTCacheID *pid, struct Object *ob, struct SmokeModifierData *smd);
237 void BKE_ptcache_id_from_smoke_turbulence(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 /* Loads simulation from external (disk) cache files. */
304 void BKE_ptcache_load_external(struct PTCacheID *pid);
305
306 /* Set correct flags after successful simulation step */
307 void BKE_ptcache_validate(struct PointCache *cache, int framenr);
308
309 /* Set correct flags after unsuccessful simulation step */
310 void BKE_ptcache_invalidate(struct PointCache *cache);
311
312 #endif