Cleanup: sort forward declarations of enum & struct
[blender.git] / source / blender / blenkernel / BKE_pointcache.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Campbell Barton <ideasman42@gmail.com>
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_POINTCACHE_H__
29 #define __BKE_POINTCACHE_H__
30
31 /** \file BKE_pointcache.h
32  *  \ingroup bke
33  */
34
35 #include "DNA_ID.h"
36 #include "DNA_dynamicpaint_types.h"
37 #include "DNA_object_force_types.h"
38 #include "DNA_boid_types.h"
39 #include <stdio.h> /* for FILE */
40
41 /* Point cache clearing option, for BKE_ptcache_id_clear, before
42  * and after are non inclusive (they wont remove the cfra) */
43 #define PTCACHE_CLEAR_ALL       0
44 #define PTCACHE_CLEAR_FRAME     1
45 #define PTCACHE_CLEAR_BEFORE    2
46 #define PTCACHE_CLEAR_AFTER     3
47
48 /* Point cache reset options */
49 #define PTCACHE_RESET_DEPSGRAPH     0
50 #define PTCACHE_RESET_BAKED         1
51 #define PTCACHE_RESET_OUTDATED      2
52 /* #define PTCACHE_RESET_FREE                   3 */ /*UNUSED*/
53
54 /* Add the blendfile name after blendcache_ */
55 #define PTCACHE_EXT ".bphys"
56 #define PTCACHE_PATH "blendcache_"
57
58 /* File open options, for BKE_ptcache_file_open */
59 #define PTCACHE_FILE_READ   0
60 #define PTCACHE_FILE_WRITE  1
61 #define PTCACHE_FILE_UPDATE 2
62
63 /* PTCacheID types */
64 #define PTCACHE_TYPE_SOFTBODY           0
65 #define PTCACHE_TYPE_PARTICLES          1
66 #define PTCACHE_TYPE_CLOTH              2
67 #define PTCACHE_TYPE_SMOKE_DOMAIN       3
68 #define PTCACHE_TYPE_SMOKE_HIGHRES      4
69 #define PTCACHE_TYPE_DYNAMICPAINT       5
70 #define PTCACHE_TYPE_RIGIDBODY          6
71
72 /* high bits reserved for flags that need to be stored in file */
73 #define PTCACHE_TYPEFLAG_COMPRESS       (1 << 16)
74 #define PTCACHE_TYPEFLAG_EXTRADATA      (1 << 17)
75
76 #define PTCACHE_TYPEFLAG_TYPEMASK           0x0000FFFF
77 #define PTCACHE_TYPEFLAG_FLAGMASK           0xFFFF0000
78
79 /* PTCache read return code */
80 #define PTCACHE_READ_EXACT              1
81 #define PTCACHE_READ_INTERPOLATED       2
82 #define PTCACHE_READ_OLD                3
83
84 /* Structs */
85 struct ClothModifierData;
86 struct ListBase;
87 struct Main;
88 struct Object;
89 struct ParticleKey;
90 struct ParticleSystem;
91 struct PointCache;
92 struct RigidBodyWorld;
93 struct Scene;
94 struct SmokeModifierData;
95 struct SoftBody;
96
97 struct OpenVDBReader;
98 struct OpenVDBWriter;
99
100 /* temp structure for read/write */
101 typedef struct PTCacheData {
102         unsigned int index;
103         float loc[3];
104         float vel[3];
105         float rot[4];
106         float ave[3];
107         float size;
108         float times[3];
109         struct BoidData boids;
110 } PTCacheData;
111
112 typedef struct PTCacheFile {
113         FILE *fp;
114
115         int frame, old_format;
116         unsigned int totpoint, type;
117         unsigned int data_types, flag;
118
119         struct PTCacheData data;
120         void *cur[BPHYS_TOT_DATA];
121 } PTCacheFile;
122
123 #define PTCACHE_VEL_PER_SEC     1
124
125 enum {
126         PTCACHE_FILE_PTCACHE = 0,
127         PTCACHE_FILE_OPENVDB = 1,
128 };
129
130 typedef struct PTCacheID {
131         struct PTCacheID *next, *prev;
132
133         struct Scene *scene;
134         struct Object *ob;
135         void *calldata;
136         unsigned int type, file_type;
137         unsigned int stack_index;
138         unsigned int flag;
139
140         unsigned int default_step;
141         unsigned int max_step;
142
143         /* flags defined in DNA_object_force_types.h */
144         unsigned int data_types, info_types;
145
146         /* copies point data to cache data */
147         int (*write_point)(int index, void *calldata, void **data, int cfra);
148         /* copies cache cata to point data */
149         void (*read_point)(int index, void *calldata, void **data, float cfra, float *old_data);
150         /* interpolated between previously read point data and cache data */
151         void (*interpolate_point)(int index, void *calldata, void **data, float cfra, float cfra1, float cfra2, float *old_data);
152
153         /* copies point data to cache data */
154         int (*write_stream)(PTCacheFile *pf, void *calldata);
155         /* copies cache cata to point data */
156         int (*read_stream)(PTCacheFile *pf, void *calldata);
157
158         /* copies point data to cache data */
159         int (*write_openvdb_stream)(struct OpenVDBWriter *writer, void *calldata);
160         /* copies cache cata to point data */
161         int (*read_openvdb_stream)(struct OpenVDBReader *reader, void *calldata);
162
163         /* copies custom extradata to cache data */
164         void (*write_extra_data)(void *calldata, struct PTCacheMem *pm, int cfra);
165         /* copies custom extradata to cache data */
166         void (*read_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra);
167         /* copies custom extradata to cache data */
168         void (*interpolate_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra, float cfra1, float cfra2);
169
170         /* total number of simulated points (the cfra parameter is just for using same function pointer with totwrite) */
171         int (*totpoint)(void *calldata, int cfra);
172         /* report error if number of points does not match */
173         void (*error)(void *calldata, const char *message);
174         /* number of points written for current cache frame */
175         int (*totwrite)(void *calldata, int cfra);
176
177         int (*write_header)(PTCacheFile *pf);
178         int (*read_header)(PTCacheFile *pf);
179
180         struct PointCache *cache;
181         /* used for setting the current cache from ptcaches list */
182         struct PointCache **cache_ptr;
183         struct ListBase *ptcaches;
184 } PTCacheID;
185
186 typedef struct PTCacheBaker {
187         struct Main *bmain;
188         struct Scene *scene;
189         int bake;
190         int render;
191         int anim_init;
192         int quick_step;
193         struct PTCacheID pid;
194
195         void (*update_progress)(void *data, float progress, int *cancel);
196         void *bake_job;
197 } PTCacheBaker;
198
199 /* PTCacheEditKey->flag */
200 #define PEK_SELECT      1
201 #define PEK_TAG         2
202 #define PEK_HIDE        4
203 #define PEK_USE_WCO     8
204
205 typedef struct PTCacheEditKey {
206         float *co;
207         float *vel;
208         float *rot;
209         float *time;
210
211         float world_co[3];
212         float ftime;
213         float length;
214         short flag;
215 } PTCacheEditKey;
216
217 /* PTCacheEditPoint->flag */
218 #define PEP_TAG             1
219 #define PEP_EDIT_RECALC     2
220 #define PEP_TRANSFORM       4
221 #define PEP_HIDE            8
222
223 typedef struct PTCacheEditPoint {
224         struct PTCacheEditKey *keys;
225         int totkey;
226         short flag;
227 } PTCacheEditPoint;
228
229 typedef struct PTCacheUndo {
230         struct PTCacheEditPoint *points;
231
232         /* particles stuff */
233         struct ParticleData *particles;
234         struct KDTree *emitter_field;
235         float *emitter_cosnos;
236         int psys_flag;
237
238         /* cache stuff */
239         struct ListBase mem_cache;
240
241         int totpoint;
242
243         size_t undo_size;
244 } PTCacheUndo;
245
246 typedef struct PTCacheEdit {
247         PTCacheEditPoint *points;
248
249         struct PTCacheID pid;
250
251         /* particles stuff */
252         struct ParticleSystem *psys;
253         struct KDTree *emitter_field;
254         float *emitter_cosnos; /* localspace face centers and normals (average of its verts), from the derived mesh */
255         int *mirror_cache;
256
257         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
258         ListBase pathcachebufs;
259
260         int totpoint, totframes, totcached, edited;
261
262         unsigned char sel_col[3];
263         unsigned char nosel_col[3];
264 } PTCacheEdit;
265
266 /* Particle functions */
267 void BKE_ptcache_make_particle_key(struct ParticleKey *key, int index, void **data, float time);
268
269 /**************** Creating ID's ****************************/
270 void BKE_ptcache_id_from_softbody(PTCacheID *pid, struct Object *ob, struct SoftBody *sb);
271 void BKE_ptcache_id_from_particles(PTCacheID *pid, struct Object *ob, struct ParticleSystem *psys);
272 void BKE_ptcache_id_from_cloth(PTCacheID *pid, struct Object *ob, struct ClothModifierData *clmd);
273 void BKE_ptcache_id_from_smoke(PTCacheID *pid, struct Object *ob, struct SmokeModifierData *smd);
274 void BKE_ptcache_id_from_dynamicpaint(PTCacheID *pid, struct Object *ob, struct DynamicPaintSurface *surface);
275 void BKE_ptcache_id_from_rigidbody(PTCacheID *pid, struct Object *ob, struct RigidBodyWorld *rbw);
276
277 void BKE_ptcache_ids_from_object(
278         struct Main *bmain, struct ListBase *lb, struct Object *ob, struct Scene *scene, int duplis);
279
280 /***************** Global funcs ****************************/
281 void BKE_ptcache_remove(void);
282
283 /************ ID specific functions ************************/
284 void    BKE_ptcache_id_clear(PTCacheID *id, int mode, unsigned int cfra);
285 int     BKE_ptcache_id_exist(PTCacheID *id, int cfra);
286 int     BKE_ptcache_id_reset(struct Scene *scene, PTCacheID *id, int mode);
287 void    BKE_ptcache_id_time(PTCacheID *pid, struct Scene *scene, float cfra, int *startframe, int *endframe, float *timescale);
288 int     BKE_ptcache_object_reset(struct Scene *scene, struct Object *ob, int mode);
289
290 void BKE_ptcache_update_info(PTCacheID *pid);
291
292 /*********** General cache reading/writing ******************/
293
294 /* Size of cache data type. */
295 int     BKE_ptcache_data_size(int data_type);
296
297 /* Is point with index in memory cache */
298 int BKE_ptcache_mem_index_find(struct PTCacheMem *pm, unsigned int index);
299
300 /* Memory cache read/write helpers. */
301 void BKE_ptcache_mem_pointers_init(struct PTCacheMem *pm);
302 void BKE_ptcache_mem_pointers_incr(struct PTCacheMem *pm);
303 int  BKE_ptcache_mem_pointers_seek(int point_index, struct PTCacheMem *pm);
304
305 /* Main cache reading call. */
306 int     BKE_ptcache_read(PTCacheID *pid, float cfra, bool no_extrapolate_old);
307
308 /* Main cache writing call. */
309 int     BKE_ptcache_write(PTCacheID *pid, unsigned int cfra);
310
311 /******************* Allocate & free ***************/
312 struct PointCache *BKE_ptcache_add(struct ListBase *ptcaches);
313 void BKE_ptcache_free_mem(struct ListBase *mem_cache);
314 void BKE_ptcache_free(struct PointCache *cache);
315 void BKE_ptcache_free_list(struct ListBase *ptcaches);
316 struct PointCache *BKE_ptcache_copy_list(struct ListBase *ptcaches_new, const struct ListBase *ptcaches_old, const int flag);
317
318 /********************** Baking *********************/
319
320 /* Bakes cache with cache_step sized jumps in time, not accurate but very fast. */
321 void BKE_ptcache_quick_cache_all(struct Main *bmain, struct Scene *scene);
322
323 /* Bake cache or simulate to current frame with settings defined in the baker. */
324 void BKE_ptcache_bake(struct PTCacheBaker *baker);
325
326 /* Convert disk cache to memory cache. */
327 void BKE_ptcache_disk_to_mem(struct PTCacheID *pid);
328
329 /* Convert memory cache to disk cache. */
330 void BKE_ptcache_mem_to_disk(struct PTCacheID *pid);
331
332 /* Convert disk cache to memory cache and vice versa. Clears the cache that was converted. */
333 void BKE_ptcache_toggle_disk_cache(struct PTCacheID *pid);
334
335 /* Rename all disk cache files with a new name. Doesn't touch the actual content of the files. */
336 void BKE_ptcache_disk_cache_rename(struct PTCacheID *pid, const char *name_src, const char *name_dst);
337
338 /* Loads simulation from external (disk) cache files. */
339 void BKE_ptcache_load_external(struct PTCacheID *pid);
340
341 /* Set correct flags after successful simulation step */
342 void BKE_ptcache_validate(struct PointCache *cache, int framenr);
343
344 /* Set correct flags after unsuccessful simulation step */
345 void BKE_ptcache_invalidate(struct PointCache *cache);
346
347 #endif