443c6923ed00eb911a0be0ba4ba049493281d38c
[blender.git] / source / blender / makesdna / DNA_smoke_types.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 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Daniel Genrich (Genscher)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_smoke_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_SMOKE_TYPES_H__
33 #define __DNA_SMOKE_TYPES_H__
34
35 /* flags */
36 enum {
37         MOD_SMOKE_HIGHRES = (1 << 1),  /* enable high resolution */
38         MOD_SMOKE_DISSOLVE = (1 << 2),  /* let smoke dissolve */
39         MOD_SMOKE_DISSOLVE_LOG = (1 << 3),  /* using 1/x for dissolve */
40
41 #ifdef DNA_DEPRECATED
42         MOD_SMOKE_HIGH_SMOOTH = (1 << 5),  /* -- Deprecated -- */
43 #endif
44         MOD_SMOKE_FILE_LOAD = (1 << 6),  /* flag for file load */
45         MOD_SMOKE_ADAPTIVE_DOMAIN = (1 << 7),
46 };
47
48 /* noise */
49 #define MOD_SMOKE_NOISEWAVE (1<<0)
50 #define MOD_SMOKE_NOISEFFT (1<<1)
51 #define MOD_SMOKE_NOISECURL (1<<2)
52 /* viewsettings */
53 #define MOD_SMOKE_VIEW_SHOWBIG (1<<0)
54
55 /* slice method */
56 enum {
57         MOD_SMOKE_SLICE_VIEW_ALIGNED = 0,
58         MOD_SMOKE_SLICE_AXIS_ALIGNED = 1,
59 };
60
61 /* axis aligned method */
62 enum {
63         AXIS_SLICE_FULL   = 0,
64         AXIS_SLICE_SINGLE = 1,
65 };
66
67 /* single slice direction */
68 enum {
69         SLICE_AXIS_AUTO = 0,
70         SLICE_AXIS_X    = 1,
71         SLICE_AXIS_Y    = 2,
72         SLICE_AXIS_Z    = 3,
73 };
74
75 enum {
76         VECTOR_DRAW_NEEDLE     = 0,
77         VECTOR_DRAW_STREAMLINE = 1,
78 };
79
80 enum {
81         FLUID_FIELD_DENSITY    = 0,
82         FLUID_FIELD_HEAT       = 1,
83         FLUID_FIELD_FUEL       = 2,
84         FLUID_FIELD_REACT      = 3,
85         FLUID_FIELD_FLAME      = 4,
86         FLUID_FIELD_VELOCITY_X = 5,
87         FLUID_FIELD_VELOCITY_Y = 6,
88         FLUID_FIELD_VELOCITY_Z = 7,
89         FLUID_FIELD_COLOR_R    = 8,
90         FLUID_FIELD_COLOR_G    = 9,
91         FLUID_FIELD_COLOR_B    = 10,
92         FLUID_FIELD_FORCE_X    = 11,
93         FLUID_FIELD_FORCE_Y    = 12,
94         FLUID_FIELD_FORCE_Z    = 13,
95 };
96
97 /* cache compression */
98 #define SM_CACHE_LIGHT          0
99 #define SM_CACHE_HEAVY          1
100
101 /* domain border collision */
102 #define SM_BORDER_OPEN          0
103 #define SM_BORDER_VERTICAL      1
104 #define SM_BORDER_CLOSED        2
105
106 /* collision types */
107 #define SM_COLL_STATIC          0
108 #define SM_COLL_RIGID           1
109 #define SM_COLL_ANIMATED        2
110
111 /* high resolution sampling types */
112 #define SM_HRES_NEAREST         0
113 #define SM_HRES_LINEAR          1
114 #define SM_HRES_FULLSAMPLE      2
115
116 /* smoke data fileds (active_fields) */
117 #define SM_ACTIVE_HEAT          (1<<0)
118 #define SM_ACTIVE_FIRE          (1<<1)
119 #define SM_ACTIVE_COLORS        (1<<2)
120 #define SM_ACTIVE_COLOR_SET     (1<<3)
121
122 enum {
123         VDB_COMPRESSION_BLOSC = 0,
124         VDB_COMPRESSION_ZIP   = 1,
125         VDB_COMPRESSION_NONE  = 2,
126 };
127
128 typedef struct SmokeDomainSettings {
129         struct SmokeModifierData *smd; /* for fast RNA access */
130         struct FLUID_3D *fluid;
131         void *fluid_mutex;
132         struct Collection *fluid_group;
133         struct Collection *eff_group; // UNUSED
134         struct Collection *coll_group; // collision objects group
135         struct WTURBULENCE *wt; // WTURBULENCE object, if active
136         struct GPUTexture *tex;
137         struct GPUTexture *tex_wt;
138         struct GPUTexture *tex_shadow;
139         struct GPUTexture *tex_flame;
140         struct GPUTexture *tex_velocity_x;
141         struct GPUTexture *tex_velocity_y;
142         struct GPUTexture *tex_velocity_z;
143         float *shadow;
144
145         /* simulation data */
146         float p0[3]; /* start point of BB in local space (includes sub-cell shift for adaptive domain)*/
147         float p1[3]; /* end point of BB in local space */
148         float dp0[3]; /* difference from object center to grid start point */
149         float cell_size[3]; /* size of simulation cell in local space */
150         float global_size[3]; /* global size of domain axises */
151         float prev_loc[3];
152         int shift[3]; /* current domain shift in simulation cells */
153         float shift_f[3]; /* exact domain shift */
154         float obj_shift_f[3]; /* how much object has shifted since previous smoke frame (used to "lock" domain while drawing) */
155         float imat[4][4]; /* domain object imat */
156         float obmat[4][4]; /* domain obmat */
157         float fluidmat[4][4]; /* low res fluid matrix */
158         float fluidmat_wt[4][4]; /* high res fluid matrix */
159
160         int base_res[3]; /* initial "non-adapted" resolution */
161         int res_min[3]; /* cell min */
162         int res_max[3]; /* cell max */
163         int res[3]; /* data resolution (res_max-res_min) */
164         int total_cells;
165         float dx; /* 1.0f / res */
166         float scale; /* largest domain size */
167
168         /* user settings */
169         int adapt_margin;
170         int adapt_res;
171         float adapt_threshold;
172
173         float alpha;
174         float beta;
175         int amplify; /* wavelet amplification */
176         int maxres; /* longest axis on the BB gets this resolution assigned */
177         int flags; /* show up-res or low res, etc */
178         int viewsettings;
179         short noise; /* noise type: wave, curl, anisotropic */
180         short diss_percent;
181         int diss_speed;/* in frames */
182         float strength;
183         int res_wt[3];
184         float dx_wt;
185         /* point cache options */
186         int cache_comp;
187         int cache_high_comp;
188         /* OpenVDB cache options */
189         int openvdb_comp;
190         char cache_file_format;
191         char data_depth;
192         char pad[2];
193
194         /* Smoke uses only one cache from now on (index [0]), but keeping the array for now for reading old files. */
195         struct PointCache *point_cache[2];      /* definition is in DNA_object_force_types.h */
196         struct ListBase ptcaches[2];
197         struct EffectorWeights *effector_weights;
198         int border_collisions;  /* How domain border collisions are handled */
199         float time_scale;
200         float vorticity;
201         int active_fields;
202         float active_color[3]; /* monitor color situation of simulation */
203         int highres_sampling;
204
205         /* flame parameters */
206         float burning_rate, flame_smoke, flame_vorticity;
207         float flame_ignition, flame_max_temp;
208         float flame_smoke_color[3];
209
210         /* Display settings */
211         char slice_method, axis_slice_method;
212         char slice_axis, draw_velocity;
213         float slice_per_voxel;
214         float slice_depth;
215         float display_thickness;
216
217         struct ColorBand *coba;
218         float vector_scale;
219         char vector_draw_type;
220         char use_coba;
221         char coba_field;  /* simulation field used for the color mapping */
222         char pad2;
223
224         float clipping;
225         float pad3;
226 } SmokeDomainSettings;
227
228
229 /* inflow / outflow */
230
231 /* type */
232 #define MOD_SMOKE_FLOW_TYPE_SMOKE 0
233 #define MOD_SMOKE_FLOW_TYPE_FIRE 1
234 #define MOD_SMOKE_FLOW_TYPE_OUTFLOW 2
235 #define MOD_SMOKE_FLOW_TYPE_SMOKEFIRE 3
236
237 /* flow source */
238 #define MOD_SMOKE_FLOW_SOURCE_PARTICLES 0
239 #define MOD_SMOKE_FLOW_SOURCE_MESH 1
240
241 /* flow texture type */
242 #define MOD_SMOKE_FLOW_TEXTURE_MAP_AUTO 0
243 #define MOD_SMOKE_FLOW_TEXTURE_MAP_UV 1
244
245 /* flags */
246 #define MOD_SMOKE_FLOW_ABSOLUTE (1<<1) /*old style emission*/
247 #define MOD_SMOKE_FLOW_INITVELOCITY (1<<2) /* passes particles speed to the smoke */
248 #define MOD_SMOKE_FLOW_TEXTUREEMIT (1<<3) /* use texture to control emission speed */
249 #define MOD_SMOKE_FLOW_USE_PART_SIZE (1<<4) /* use specific size for particles instead of closest cell */
250
251 typedef struct SmokeFlowSettings {
252         struct SmokeModifierData *smd; /* for fast RNA access */
253         struct DerivedMesh *dm;
254         struct ParticleSystem *psys;
255         struct Tex *noise_texture;
256
257         /* initial velocity */
258         float *verts_old; /* previous vertex positions in domain space */
259         int numverts;
260         float vel_multi; // Multiplier for inherited velocity
261         float vel_normal;
262         float vel_random;
263         /* emission */
264         float density;
265         float color[3];
266         float fuel_amount;
267         float temp; /* delta temperature (temp - ambient temp) */
268         float volume_density; /* density emitted within mesh volume */
269         float surface_distance; /* maximum emission distance from mesh surface */
270         float particle_size;
271         int subframes;
272         /* texture control */
273         float texture_size;
274         float texture_offset;
275         int pad;
276         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
277         short vgroup_density;
278
279         short type; /* smoke, flames, both, outflow */
280         short source;
281         short texture_type;
282         int flags; /* absolute emission etc*/
283 } SmokeFlowSettings;
284
285
286 // struct BVHTreeFromMesh *bvh;
287 // float mat[4][4];
288 // float mat_old[4][4];
289
290 /* collision objects (filled with smoke) */
291 typedef struct SmokeCollSettings {
292         struct SmokeModifierData *smd; /* for fast RNA access */
293         struct DerivedMesh *dm;
294         float *verts_old;
295         int numverts;
296         short type; // static = 0, rigid = 1, dynamic = 2
297         short pad;
298 } SmokeCollSettings;
299
300 #endif