New point cache file format:
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #include "MEM_guardedalloc.h"
37
38 /* Point cache clearing option, for BKE_ptcache_id_clear, before
39  * and after are non inclusive (they wont remove the cfra) */
40 #define PTCACHE_CLEAR_ALL               0
41 #define PTCACHE_CLEAR_FRAME             1
42 #define PTCACHE_CLEAR_BEFORE    2
43 #define PTCACHE_CLEAR_AFTER             3
44
45 /* Point cache reset options */
46 #define PTCACHE_RESET_DEPSGRAPH         0
47 #define PTCACHE_RESET_BAKED                     1
48 #define PTCACHE_RESET_OUTDATED          2
49 #define PTCACHE_RESET_FREE                      3
50
51 /* Add the blendfile name after blendcache_ */
52 #define PTCACHE_EXT ".bphys"
53 #define PTCACHE_PATH "blendcache_"
54
55 /* File open options, for BKE_ptcache_file_open */
56 #define PTCACHE_FILE_READ       0
57 #define PTCACHE_FILE_WRITE      1
58
59 /* PTCacheID types */
60 #define PTCACHE_TYPE_SOFTBODY   0
61 #define PTCACHE_TYPE_PARTICLES  1
62 #define PTCACHE_TYPE_CLOTH              2
63
64 /* PTCache read return code */
65 #define PTCACHE_READ_EXACT                              1
66 #define PTCACHE_READ_INTERPOLATED               2
67 #define PTCACHE_READ_OLD                                3
68
69 /* Structs */
70 struct Object;
71 struct Scene;
72 struct SoftBody;
73 struct ParticleSystem;
74 struct ClothModifierData;
75 struct PointCache;
76 struct ListBase;
77
78 /* temp structure for read/write */
79 typedef struct PTCacheData {
80         int index;
81         float loc[3];
82         float vel[3];
83         float rot[4];
84         float ave[3];
85         float size;
86         float times[3];
87         struct BoidData boids;
88 } PTCacheData;
89
90 typedef struct PTCacheFile {
91         FILE *fp;
92
93         int totpoint, type;
94         unsigned int data_types;
95
96         struct PTCacheData data;
97         void *cur[BPHYS_TOT_DATA];
98 } PTCacheFile;
99
100 typedef struct PTCacheID {
101         struct PTCacheID *next, *prev;
102
103         struct Scene *scene;
104         struct Object *ob;
105         void *calldata;
106         int type;
107         int stack_index;
108         unsigned int data_types, info_types;
109
110         int (*write_elem)(int index, void *calldata, void **data);
111         void (*read_elem)(int index, void *calldata, void **data, float frs_sec, float cfra, float *old_data);
112         void (*interpolate_elem)(int index, void *calldata, void **data, float frs_sec, float cfra, float cfra1, float cfra2, float *old_data);
113
114         int (*totpoint)(void *calldata);
115         int (*totwrite)(void *calldata);
116
117         int (*write_header)(PTCacheFile *pf);
118         int (*read_header)(PTCacheFile *pf);
119
120         struct PointCache *cache;
121         struct PointCache **cache_ptr;
122         struct ListBase *ptcaches;
123 } PTCacheID;
124
125 typedef struct PTCacheBaker {
126         struct Scene *scene;
127         int bake;
128         int render;
129         int anim_init;
130         int quick_step;
131         struct PTCacheID *pid;
132         int (*break_test)(void *data);
133         void *break_data;
134         void (*progressbar)(void *data, int num);
135         void *progresscontext;
136 } PTCacheBaker;
137
138 /* Particle functions */
139 void BKE_ptcache_make_particle_key(struct ParticleKey *key, int index, void **data, float time);
140
141 /* Creating ID's */
142 void BKE_ptcache_id_from_softbody(PTCacheID *pid, struct Object *ob, struct SoftBody *sb);
143 void BKE_ptcache_id_from_particles(PTCacheID *pid, struct Object *ob, struct ParticleSystem *psys);
144 void BKE_ptcache_id_from_cloth(PTCacheID *pid, struct Object *ob, struct ClothModifierData *clmd);
145
146 void BKE_ptcache_ids_from_object(struct ListBase *lb, struct Object *ob);
147
148 /* Global funcs */
149 void BKE_ptcache_remove(void);
150
151 /* ID specific functions */
152 void    BKE_ptcache_id_clear(PTCacheID *id, int mode, int cfra);
153 int             BKE_ptcache_id_exist(PTCacheID *id, int cfra);
154 int             BKE_ptcache_id_reset(struct Scene *scene, PTCacheID *id, int mode);
155 void    BKE_ptcache_id_time(PTCacheID *pid, struct Scene *scene, float cfra, int *startframe, int *endframe, float *timescale);
156 int             BKE_ptcache_object_reset(struct Scene *scene, struct Object *ob, int mode);
157
158 void BKE_ptcache_update_info(PTCacheID *pid);
159
160 /* General cache reading/writing */
161 int             BKE_ptcache_data_size(int data_type);
162 void    BKE_ptcache_data_get(void **data, int type, int index, void *to);
163 void    BKE_ptcache_data_set(void **data, int type, void *from);
164 int             BKE_ptcache_read_cache(PTCacheID *pid, float cfra, float frs_sec);
165 int             BKE_ptcache_write_cache(PTCacheID *pid, int cfra);
166
167 /* Continue physics */
168 void BKE_ptcache_set_continue_physics(struct Scene *scene, int enable);
169 int BKE_ptcache_get_continue_physics(void);
170
171 /* Point Cache */
172 struct PointCache *BKE_ptcache_add(struct ListBase *ptcaches);
173 void BKE_ptache_free_mem(struct PointCache *cache);
174 void BKE_ptcache_free(struct PointCache *cache);
175 void BKE_ptcache_free_list(struct ListBase *ptcaches);
176 struct PointCache *BKE_ptcache_copy(struct PointCache *cache);
177
178 /* Baking */
179 void BKE_ptcache_quick_cache_all(struct Scene *scene);
180 void BKE_ptcache_make_cache(struct PTCacheBaker* baker);
181 void BKE_ptcache_disk_to_mem(struct PTCacheID *pid);
182 void BKE_ptcache_toggle_disk_cache(struct PTCacheID *pid);
183
184 void BKE_ptcache_load_external(struct PTCacheID *pid);
185
186 #endif