Smoke:
[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 #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 Object;
73 struct Scene;
74 struct SoftBody;
75 struct ParticleSystem;
76 struct ParticleKey;
77 struct ClothModifierData;
78 struct SmokeModifierData;
79 struct PointCache;
80 struct ListBase;
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 typedef struct PTCacheID {
105         struct PTCacheID *next, *prev;
106
107         struct Scene *scene;
108         struct Object *ob;
109         void *calldata;
110         int type;
111         int stack_index;
112
113         /* flags defined in DNA_object_force.h */
114         unsigned int data_types, info_types;
115
116         /* copies point data to cache data */
117         int (*write_elem)(int index, void *calldata, void **data);
118         /* copies point data to cache data */
119         int (*write_stream)(PTCacheFile *pf, void *calldata);
120         /* copies cache cata to point data */
121         void (*read_elem)(int index, void *calldata, void **data, float frs_sec, float cfra, float *old_data);
122         /* copies cache cata to point data */
123         void (*read_stream)(PTCacheFile *pf, void *calldata);
124         /* interpolated between previously read point data and cache data */
125         void (*interpolate_elem)(int index, void *calldata, void **data, float frs_sec, float cfra, float cfra1, float cfra2, float *old_data);
126
127         /* total number of simulated points */
128         int (*totpoint)(void *calldata);
129         /* number of points written for current cache frame (currently not used) */
130         int (*totwrite)(void *calldata);
131
132         int (*write_header)(PTCacheFile *pf);
133         int (*read_header)(PTCacheFile *pf);
134
135         struct PointCache *cache;
136         /* used for setting the current cache from ptcaches list */
137         struct PointCache **cache_ptr;
138         struct ListBase *ptcaches;
139 } PTCacheID;
140
141 typedef struct PTCacheBaker {
142         struct Scene *scene;
143         int bake;
144         int render;
145         int anim_init;
146         int quick_step;
147         struct PTCacheID *pid;
148         int (*break_test)(void *data);
149         void *break_data;
150         void (*progressbar)(void *data, int num);
151         void *progresscontext;
152 } PTCacheBaker;
153
154 /* Particle functions */
155 void BKE_ptcache_make_particle_key(struct ParticleKey *key, int index, void **data, float time);
156
157 /**************** Creating ID's ****************************/
158 void BKE_ptcache_id_from_softbody(PTCacheID *pid, struct Object *ob, struct SoftBody *sb);
159 void BKE_ptcache_id_from_particles(PTCacheID *pid, struct Object *ob, struct ParticleSystem *psys);
160 void BKE_ptcache_id_from_cloth(PTCacheID *pid, struct Object *ob, struct ClothModifierData *clmd);
161 void BKE_ptcache_id_from_smoke(PTCacheID *pid, struct Object *ob, struct SmokeModifierData *smd);
162
163 void BKE_ptcache_ids_from_object(struct ListBase *lb, struct Object *ob);
164
165 /***************** Global funcs ****************************/
166 void BKE_ptcache_remove(void);
167
168 /************ ID specific functions ************************/
169 void    BKE_ptcache_id_clear(PTCacheID *id, int mode, int cfra);
170 int             BKE_ptcache_id_exist(PTCacheID *id, int cfra);
171 int             BKE_ptcache_id_reset(struct Scene *scene, PTCacheID *id, int mode);
172 void    BKE_ptcache_id_time(PTCacheID *pid, struct Scene *scene, float cfra, int *startframe, int *endframe, float *timescale);
173 int             BKE_ptcache_object_reset(struct Scene *scene, struct Object *ob, int mode);
174
175 void BKE_ptcache_update_info(PTCacheID *pid);
176
177 /*********** General cache reading/writing ******************/
178
179 /* Size of cache data type. */
180 int             BKE_ptcache_data_size(int data_type);
181
182 /* Copy a specific data type from cache data to point data. */
183 void    BKE_ptcache_data_get(void **data, int type, int index, void *to);
184
185 /* Copy a specific data type from point data to cache data. */
186 void    BKE_ptcache_data_set(void **data, int type, void *from);
187
188 /* Main cache reading call. */
189 int             BKE_ptcache_read_cache(PTCacheID *pid, float cfra, float frs_sec);
190
191 /* Main cache writing call. */
192 int             BKE_ptcache_write_cache(PTCacheID *pid, int cfra);
193
194 /****************** Continue physics ***************/
195 void BKE_ptcache_set_continue_physics(struct Scene *scene, int enable);
196 int BKE_ptcache_get_continue_physics(void);
197
198 /******************* Allocate & free ***************/
199 struct PointCache *BKE_ptcache_add(struct ListBase *ptcaches);
200 void BKE_ptache_free_mem(struct PointCache *cache);
201 void BKE_ptcache_free(struct PointCache *cache);
202 void BKE_ptcache_free_list(struct ListBase *ptcaches);
203 struct PointCache *BKE_ptcache_copy_list(struct ListBase *ptcaches_new, struct ListBase *ptcaches_old);
204
205 /********************** Baking *********************/
206
207 /* Bakes cache with cache_step sized jumps in time, not accurate but very fast. */
208 void BKE_ptcache_quick_cache_all(struct Scene *scene);
209
210 /* Bake cache or simulate to current frame with settings defined in the baker. */
211 void BKE_ptcache_make_cache(struct PTCacheBaker* baker);
212
213 /* Convert disk cache to memory cache. */
214 void BKE_ptcache_disk_to_mem(struct PTCacheID *pid);
215
216 /* Convert memory cache to disk cache. */
217 void BKE_ptcache_mem_to_disk(struct PTCacheID *pid);
218
219 /* Convert disk cache to memory cache and vice versa. Clears the cache that was converted. */
220 void BKE_ptcache_toggle_disk_cache(struct PTCacheID *pid);
221
222 /* Loads simulation from external (disk) cache files. */
223 void BKE_ptcache_load_external(struct PTCacheID *pid);
224
225 #endif