Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_smoke.c
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  * Contributor(s): Daniel Genrich
19  *                 Blender Foundation
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file blender/makesrna/intern/rna_smoke.c
25  *  \ingroup RNA
26  */
27
28
29 #include <stdlib.h>
30 #include <limits.h>
31
32 #include "BLI_sys_types.h"
33 #include "BLI_threads.h"
34
35 #include "RNA_define.h"
36 #include "RNA_enum_types.h"
37
38 #include "rna_internal.h"
39
40 #include "BKE_modifier.h"
41 #include "BKE_smoke.h"
42 #include "BKE_pointcache.h"
43
44 #include "DNA_modifier_types.h"
45 #include "DNA_object_force_types.h"
46 #include "DNA_object_types.h"
47 #include "DNA_scene_types.h"
48 #include "DNA_smoke_types.h"
49
50 #include "WM_types.h"
51
52
53 #ifdef RNA_RUNTIME
54
55 #include "BKE_colorband.h"
56 #include "BKE_context.h"
57 #include "BKE_particle.h"
58
59 #include "DEG_depsgraph.h"
60 #include "DEG_depsgraph_build.h"
61
62 #include "smoke_API.h"
63
64
65 static void rna_Smoke_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
66 {
67         DEG_id_tag_update(ptr->id.data, OB_RECALC_DATA);
68 }
69
70 static void rna_Smoke_dependency_update(Main *bmain, Scene *scene, PointerRNA *ptr)
71 {
72         rna_Smoke_update(bmain, scene, ptr);
73         DEG_relations_tag_update(bmain);
74 }
75
76 static void rna_Smoke_resetCache(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
77 {
78         SmokeDomainSettings *settings = (SmokeDomainSettings *)ptr->data;
79         if (settings->smd && settings->smd->domain)
80                 settings->point_cache[0]->flag |= PTCACHE_OUTDATED;
81         DEG_id_tag_update(ptr->id.data, OB_RECALC_DATA);
82 }
83
84 static void rna_Smoke_cachetype_set(struct PointerRNA *ptr, int value)
85 {
86         SmokeDomainSettings *settings = (SmokeDomainSettings *)ptr->data;
87         Object *ob = (Object *)ptr->id.data;
88
89         if (value != settings->cache_file_format) {
90                 /* Clear old caches. */
91                 PTCacheID id;
92                 BKE_ptcache_id_from_smoke(&id, ob, settings->smd);
93                 BKE_ptcache_id_clear(&id, PTCACHE_CLEAR_ALL, 0);
94
95                 settings->cache_file_format = value;
96         }
97 }
98
99 static void rna_Smoke_reset(Main *bmain, Scene *scene, PointerRNA *ptr)
100 {
101         SmokeDomainSettings *settings = (SmokeDomainSettings *)ptr->data;
102
103         smokeModifier_reset(settings->smd);
104         rna_Smoke_resetCache(bmain, scene, ptr);
105
106         rna_Smoke_update(bmain, scene, ptr);
107 }
108
109 static void rna_Smoke_reset_dependency(Main *bmain, Scene *scene, PointerRNA *ptr)
110 {
111         SmokeDomainSettings *settings = (SmokeDomainSettings *)ptr->data;
112
113         smokeModifier_reset(settings->smd);
114
115         if (settings->smd && settings->smd->domain)
116                 settings->smd->domain->point_cache[0]->flag |= PTCACHE_OUTDATED;
117
118         rna_Smoke_dependency_update(bmain, scene, ptr);
119 }
120
121 static char *rna_SmokeDomainSettings_path(PointerRNA *ptr)
122 {
123         SmokeDomainSettings *settings = (SmokeDomainSettings *)ptr->data;
124         ModifierData *md = (ModifierData *)settings->smd;
125         char name_esc[sizeof(md->name) * 2];
126
127         BLI_strescape(name_esc, md->name, sizeof(name_esc));
128         return BLI_sprintfN("modifiers[\"%s\"].domain_settings", name_esc);
129 }
130
131 static char *rna_SmokeFlowSettings_path(PointerRNA *ptr)
132 {
133         SmokeFlowSettings *settings = (SmokeFlowSettings *)ptr->data;
134         ModifierData *md = (ModifierData *)settings->smd;
135         char name_esc[sizeof(md->name) * 2];
136
137         BLI_strescape(name_esc, md->name, sizeof(name_esc));
138         return BLI_sprintfN("modifiers[\"%s\"].flow_settings", name_esc);
139 }
140
141 static char *rna_SmokeCollSettings_path(PointerRNA *ptr)
142 {
143         SmokeCollSettings *settings = (SmokeCollSettings *)ptr->data;
144         ModifierData *md = (ModifierData *)settings->smd;
145         char name_esc[sizeof(md->name) * 2];
146
147         BLI_strescape(name_esc, md->name, sizeof(name_esc));
148         return BLI_sprintfN("modifiers[\"%s\"].coll_settings", name_esc);
149 }
150
151 static int rna_SmokeModifier_grid_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
152 {
153 #ifdef WITH_SMOKE
154         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
155         float *density = NULL;
156         int size = 0;
157
158         if (sds->flags & MOD_SMOKE_HIGHRES && sds->wt) {
159                 /* high resolution smoke */
160                 int res[3];
161
162                 smoke_turbulence_get_res(sds->wt, res);
163                 size = res[0] * res[1] * res[2];
164
165                 density = smoke_turbulence_get_density(sds->wt);
166         }
167         else if (sds->fluid) {
168                 /* regular resolution */
169                 size = sds->res[0] * sds->res[1] * sds->res[2];
170                 density = smoke_get_density(sds->fluid);
171         }
172
173         length[0] = (density) ? size : 0;
174 #else
175         (void)ptr;
176         length[0] = 0;
177 #endif
178         return length[0];
179 }
180
181 static int rna_SmokeModifier_color_grid_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
182 {
183         rna_SmokeModifier_grid_get_length(ptr, length);
184
185         length[0] *= 4;
186         return length[0];
187 }
188
189 static int rna_SmokeModifier_velocity_grid_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
190 {
191 #ifdef WITH_SMOKE
192         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
193         float *vx = NULL;
194         float *vy = NULL;
195         float *vz = NULL;
196         int size = 0;
197
198         /* Velocity data is always low-resolution. */
199         if (sds->fluid) {
200                 size = 3 * sds->res[0] * sds->res[1] * sds->res[2];
201                 vx = smoke_get_velocity_x(sds->fluid);
202                 vy = smoke_get_velocity_y(sds->fluid);
203                 vz = smoke_get_velocity_z(sds->fluid);
204         }
205
206         length[0] = (vx && vy && vz) ? size : 0;
207 #else
208         (void)ptr;
209         length[0] = 0;
210 #endif
211         return length[0];
212 }
213
214 static int rna_SmokeModifier_heat_grid_get_length(
215         PointerRNA *ptr,
216         int length[RNA_MAX_ARRAY_DIMENSION])
217 {
218 #ifdef WITH_SMOKE
219         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
220         float *heat = NULL;
221         int size = 0;
222
223         /* Heat data is always low-resolution. */
224         if (sds->fluid) {
225                 size = sds->res[0] * sds->res[1] * sds->res[2];
226                 heat = smoke_get_heat(sds->fluid);
227         }
228
229         length[0] = (heat) ? size : 0;
230 #else
231         (void)ptr;
232         length[0] = 0;
233 #endif
234         return length[0];
235 }
236
237 static void rna_SmokeModifier_density_grid_get(PointerRNA *ptr, float *values)
238 {
239 #ifdef WITH_SMOKE
240         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
241         int length[RNA_MAX_ARRAY_DIMENSION];
242         int size = rna_SmokeModifier_grid_get_length(ptr, length);
243         float *density;
244
245         BLI_rw_mutex_lock(sds->fluid_mutex, THREAD_LOCK_READ);
246         
247         if (sds->flags & MOD_SMOKE_HIGHRES && sds->wt)
248                 density = smoke_turbulence_get_density(sds->wt);
249         else
250                 density = smoke_get_density(sds->fluid);
251
252         memcpy(values, density, size * sizeof(float));
253
254         BLI_rw_mutex_unlock(sds->fluid_mutex);
255 #else
256         UNUSED_VARS(ptr, values);
257 #endif
258 }
259
260 static void rna_SmokeModifier_velocity_grid_get(PointerRNA *ptr, float *values)
261 {
262 #ifdef WITH_SMOKE
263         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
264         int length[RNA_MAX_ARRAY_DIMENSION];
265         int size = rna_SmokeModifier_velocity_grid_get_length(ptr, length);
266         float *vx, *vy, *vz;
267         int i;
268
269         BLI_rw_mutex_lock(sds->fluid_mutex, THREAD_LOCK_READ);
270
271         vx = smoke_get_velocity_x(sds->fluid);
272         vy = smoke_get_velocity_y(sds->fluid);
273         vz = smoke_get_velocity_z(sds->fluid);
274
275         for (i = 0; i < size; i += 3) {
276                 *(values++) = *(vx++);
277                 *(values++) = *(vy++);
278                 *(values++) = *(vz++);
279         }
280
281         BLI_rw_mutex_unlock(sds->fluid_mutex);
282 #else
283         UNUSED_VARS(ptr, values);
284 #endif
285 }
286
287 static void rna_SmokeModifier_color_grid_get(PointerRNA *ptr, float *values)
288 {
289 #ifdef WITH_SMOKE
290         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
291
292         BLI_rw_mutex_lock(sds->fluid_mutex, THREAD_LOCK_READ);
293
294         if (sds->flags & MOD_SMOKE_HIGHRES) {
295                 if (smoke_turbulence_has_colors(sds->wt))
296                         smoke_turbulence_get_rgba(sds->wt, values, 0);
297                 else
298                         smoke_turbulence_get_rgba_from_density(sds->wt, sds->active_color, values, 0);
299         }
300         else {
301                 if (smoke_has_colors(sds->fluid))
302                         smoke_get_rgba(sds->fluid, values, 0);
303                 else
304                         smoke_get_rgba_from_density(sds->fluid, sds->active_color, values, 0);
305         }
306
307         BLI_rw_mutex_unlock(sds->fluid_mutex);
308 #else
309         UNUSED_VARS(ptr, values);
310 #endif
311 }
312
313 static void rna_SmokeModifier_flame_grid_get(PointerRNA *ptr, float *values)
314 {
315 #ifdef WITH_SMOKE
316         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
317         int length[RNA_MAX_ARRAY_DIMENSION];
318         int size = rna_SmokeModifier_grid_get_length(ptr, length);
319         float *flame;
320
321         BLI_rw_mutex_lock(sds->fluid_mutex, THREAD_LOCK_READ);
322         
323         if (sds->flags & MOD_SMOKE_HIGHRES && sds->wt)
324                 flame = smoke_turbulence_get_flame(sds->wt);
325         else
326                 flame = smoke_get_flame(sds->fluid);
327         
328         if (flame)
329                 memcpy(values, flame, size * sizeof(float));
330         else
331                 memset(values, 0, size * sizeof(float));
332
333         BLI_rw_mutex_unlock(sds->fluid_mutex);
334 #else
335         UNUSED_VARS(ptr, values);
336 #endif
337 }
338
339 static void rna_SmokeModifier_heat_grid_get(PointerRNA *ptr, float *values)
340 {
341 #ifdef WITH_SMOKE
342         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
343         int length[RNA_MAX_ARRAY_DIMENSION];
344         int size = rna_SmokeModifier_heat_grid_get_length(ptr, length);
345         float *heat;
346
347         BLI_rw_mutex_lock(sds->fluid_mutex, THREAD_LOCK_READ);
348
349         heat = smoke_get_heat(sds->fluid);
350
351         if (heat != NULL) {
352                 /* scale heat values from -2.0-2.0 to -1.0-1.0. */
353                 for (int i = 0; i < size; i++) {
354                         values[i] = heat[i] * 0.5f;
355                 }
356         }
357         else {
358                 memset(values, 0, size * sizeof(float));
359         }
360
361         BLI_rw_mutex_unlock(sds->fluid_mutex);
362 #else
363         UNUSED_VARS(ptr, values);
364 #endif
365 }
366
367 static void rna_SmokeModifier_temperature_grid_get(PointerRNA *ptr, float *values)
368 {
369 #ifdef WITH_SMOKE
370         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
371         int length[RNA_MAX_ARRAY_DIMENSION];
372         int size = rna_SmokeModifier_grid_get_length(ptr, length);
373         float *flame;
374
375         BLI_rw_mutex_lock(sds->fluid_mutex, THREAD_LOCK_READ);
376
377         if (sds->flags & MOD_SMOKE_HIGHRES && sds->wt) {
378                 flame = smoke_turbulence_get_flame(sds->wt);
379         }
380         else {
381                 flame = smoke_get_flame(sds->fluid);
382         }
383
384         if (flame) {
385                 /* Output is such that 0..1 maps to 0..1000K */
386                 float offset = sds->flame_ignition;
387                 float scale = sds->flame_max_temp - sds->flame_ignition;
388
389                 for (int i = 0; i < size; i++) {
390                         values[i] = (flame[i] > 0.01f) ? offset + flame[i] * scale : 0.0f;
391                 }
392         }
393         else {
394                 memset(values, 0, size * sizeof(float));
395         }
396
397         BLI_rw_mutex_unlock(sds->fluid_mutex);
398 #else
399         UNUSED_VARS(ptr, values);
400 #endif
401 }
402
403 static void rna_SmokeFlow_density_vgroup_get(PointerRNA *ptr, char *value)
404 {
405         SmokeFlowSettings *flow = (SmokeFlowSettings *)ptr->data;
406         rna_object_vgroup_name_index_get(ptr, value, flow->vgroup_density);
407 }
408
409 static int rna_SmokeFlow_density_vgroup_length(PointerRNA *ptr)
410 {
411         SmokeFlowSettings *flow = (SmokeFlowSettings *)ptr->data;
412         return rna_object_vgroup_name_index_length(ptr, flow->vgroup_density);
413 }
414
415 static void rna_SmokeFlow_density_vgroup_set(PointerRNA *ptr, const char *value)
416 {
417         SmokeFlowSettings *flow = (SmokeFlowSettings *)ptr->data;
418         rna_object_vgroup_name_index_set(ptr, value, &flow->vgroup_density);
419 }
420
421 static void rna_SmokeFlow_uvlayer_set(PointerRNA *ptr, const char *value)
422 {
423         SmokeFlowSettings *flow = (SmokeFlowSettings *)ptr->data;
424         rna_object_uvlayer_name_set(ptr, value, flow->uvlayer_name, sizeof(flow->uvlayer_name));
425 }
426
427 static void rna_Smoke_use_color_ramp_set(PointerRNA *ptr, int value)
428 {
429         SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
430
431         sds->use_coba = value;
432
433         if (value && sds->coba == NULL) {
434                 sds->coba = BKE_colorband_add(false);
435         }
436 }
437
438 #else
439
440 static void rna_def_smoke_domain_settings(BlenderRNA *brna)
441 {
442         StructRNA *srna;
443         PropertyRNA *prop;
444
445         static const EnumPropertyItem prop_noise_type_items[] = {
446                 {MOD_SMOKE_NOISEWAVE, "NOISEWAVE", 0, "Wavelet", ""},
447 #ifdef WITH_FFTW3
448                 {MOD_SMOKE_NOISEFFT, "NOISEFFT", 0, "FFT", ""},
449 #endif
450                 /*  {MOD_SMOKE_NOISECURL, "NOISECURL", 0, "Curl", ""}, */
451                 {0, NULL, 0, NULL, NULL}
452         };
453
454         static const EnumPropertyItem prop_compression_items[] = {
455                 { VDB_COMPRESSION_ZIP, "ZIP", 0, "Zip", "Effective but slow compression" },
456 #ifdef WITH_OPENVDB_BLOSC
457                 { VDB_COMPRESSION_BLOSC, "BLOSC", 0, "Blosc", "Multithreaded compression, similar in size and quality as 'Zip'" },
458 #endif
459                 { VDB_COMPRESSION_NONE, "NONE", 0, "None", "Do not use any compression" },
460                 { 0, NULL, 0, NULL, NULL }
461         };
462
463         static const EnumPropertyItem smoke_cache_comp_items[] = {
464                 {SM_CACHE_LIGHT, "CACHELIGHT", 0, "Light", "Fast but not so effective compression"},
465                 {SM_CACHE_HEAVY, "CACHEHEAVY", 0, "Heavy", "Effective but slow compression"},
466                 {0, NULL, 0, NULL, NULL}
467         };
468
469         static const EnumPropertyItem smoke_highres_sampling_items[] = {
470                 {SM_HRES_FULLSAMPLE, "FULLSAMPLE", 0, "Full Sample", ""},
471                 {SM_HRES_LINEAR, "LINEAR", 0, "Linear", ""},
472                 {SM_HRES_NEAREST, "NEAREST", 0, "Nearest", ""},
473                 {0, NULL, 0, NULL, NULL}
474         };
475
476         static const EnumPropertyItem smoke_data_depth_items[] = {
477                 {16, "16", 0, "Float (Half)", "Half float (16 bit data)"},
478                 {0,  "32", 0, "Float (Full)", "Full float (32 bit data)"},  /* default */
479                 {0, NULL, 0, NULL, NULL},
480         };
481
482         static const EnumPropertyItem smoke_domain_colli_items[] = {
483                 {SM_BORDER_OPEN, "BORDEROPEN", 0, "Open", "Smoke doesn't collide with any border"},
484                 {SM_BORDER_VERTICAL, "BORDERVERTICAL", 0, "Vertically Open",
485                  "Smoke doesn't collide with top and bottom sides"},
486                 {SM_BORDER_CLOSED, "BORDERCLOSED", 0, "Collide All", "Smoke collides with every side"},
487                 {0, NULL, 0, NULL, NULL}
488         };
489
490         static const EnumPropertyItem cache_file_type_items[] = {
491                 {PTCACHE_FILE_PTCACHE, "POINTCACHE", 0, "Point Cache", "Blender specific point cache file format"},
492 #ifdef WITH_OPENVDB
493                 {PTCACHE_FILE_OPENVDB, "OPENVDB", 0, "OpenVDB", "OpenVDB file format"},
494 #endif
495                 {0, NULL, 0, NULL, NULL}
496         };
497
498         static const EnumPropertyItem smoke_view_items[] = {
499             {MOD_SMOKE_SLICE_VIEW_ALIGNED, "VIEW_ALIGNED", 0, "View", "Slice volume parallel to the view plane"},
500             {MOD_SMOKE_SLICE_AXIS_ALIGNED, "AXIS_ALIGNED", 0, "Axis", "Slice volume parallel to the major axis"},
501             {0, NULL, 0, NULL, NULL}
502         };
503
504         static const EnumPropertyItem axis_slice_method_items[] = {
505             {AXIS_SLICE_FULL, "FULL", 0, "Full", "Slice the whole domain object"},
506             {AXIS_SLICE_SINGLE, "SINGLE", 0, "Single", "Perform a single slice of the domain object"},
507             {0, NULL, 0, NULL, NULL}
508         };
509
510         static const EnumPropertyItem axis_slice_position_items[] = {
511             {SLICE_AXIS_AUTO, "AUTO", 0, "Auto", "Adjust slice direction according to the view direction"},
512             {SLICE_AXIS_X, "X", 0, "X", "Slice along the X axis"},
513             {SLICE_AXIS_Y, "Y", 0, "Y", "Slice along the Y axis"},
514             {SLICE_AXIS_Z, "Z", 0, "Z", "Slice along the Z axis"},
515             {0, NULL, 0, NULL, NULL}
516         };
517
518         static const EnumPropertyItem vector_draw_items[] = {
519             {VECTOR_DRAW_NEEDLE, "NEEDLE", 0, "Needle", "Draw vectors as needles"},
520             {VECTOR_DRAW_STREAMLINE, "STREAMLINE", 0, "Streamlines", "Draw vectors as streamlines"},
521             {0, NULL, 0, NULL, NULL}
522         };
523
524         srna = RNA_def_struct(brna, "SmokeDomainSettings", NULL);
525         RNA_def_struct_ui_text(srna, "Domain Settings", "Smoke domain settings");
526         RNA_def_struct_sdna(srna, "SmokeDomainSettings");
527         RNA_def_struct_path_func(srna, "rna_SmokeDomainSettings_path");
528
529         prop = RNA_def_property(srna, "resolution_max", PROP_INT, PROP_NONE);
530         RNA_def_property_int_sdna(prop, NULL, "maxres");
531         RNA_def_property_range(prop, 6, 512);
532         RNA_def_property_ui_range(prop, 24, 512, 2, -1);
533         RNA_def_property_ui_text(prop, "Max Res", "Maximal resolution used in the fluid domain");
534         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
535         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
536
537         prop = RNA_def_property(srna, "amplify", PROP_INT, PROP_NONE);
538         RNA_def_property_int_sdna(prop, NULL, "amplify");
539         RNA_def_property_range(prop, 1, 10);
540         RNA_def_property_ui_range(prop, 1, 10, 1, -1);
541         RNA_def_property_ui_text(prop, "Amplification", "Enhance the resolution of smoke by this factor using noise");
542         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
543         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
544
545         prop = RNA_def_property(srna, "use_high_resolution", PROP_BOOLEAN, PROP_NONE);
546         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_HIGHRES);
547         RNA_def_property_ui_text(prop, "High res", "Enable high resolution (using amplification)");
548         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
549         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
550
551         prop = RNA_def_property(srna, "show_high_resolution", PROP_BOOLEAN, PROP_NONE);
552         RNA_def_property_boolean_sdna(prop, NULL, "viewsettings", MOD_SMOKE_VIEW_SHOWBIG);
553         RNA_def_property_ui_text(prop, "Show High Resolution", "Show high resolution (using amplification)");
554         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
555
556         prop = RNA_def_property(srna, "noise_type", PROP_ENUM, PROP_NONE);
557         RNA_def_property_enum_sdna(prop, NULL, "noise");
558         RNA_def_property_enum_items(prop, prop_noise_type_items);
559         RNA_def_property_ui_text(prop, "Noise Method", "Noise method which is used for creating the high resolution");
560         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
561         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
562
563         prop = RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
564         RNA_def_property_float_sdna(prop, NULL, "alpha");
565         RNA_def_property_range(prop, -5.0, 5.0);
566         RNA_def_property_ui_range(prop, -5.0, 5.0, 0.02, 5);
567         RNA_def_property_ui_text(prop, "Density",
568                                  "How much density affects smoke motion (higher value results in faster rising smoke)");
569         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
570
571         prop = RNA_def_property(srna, "beta", PROP_FLOAT, PROP_NONE);
572         RNA_def_property_float_sdna(prop, NULL, "beta");
573         RNA_def_property_range(prop, -5.0, 5.0);
574         RNA_def_property_ui_range(prop, -5.0, 5.0, 0.02, 5);
575         RNA_def_property_ui_text(prop, "Heat",
576                                  "How much heat affects smoke motion (higher value results in faster rising smoke)");
577         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
578
579         prop = RNA_def_property(srna, "collision_group", PROP_POINTER, PROP_NONE);
580         RNA_def_property_pointer_sdna(prop, NULL, "coll_group");
581         RNA_def_property_struct_type(prop, "Group");
582         RNA_def_property_flag(prop, PROP_EDITABLE);
583         RNA_def_property_ui_text(prop, "Collision Group", "Limit collisions to this group");
584         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset_dependency");
585
586         prop = RNA_def_property(srna, "fluid_group", PROP_POINTER, PROP_NONE);
587         RNA_def_property_pointer_sdna(prop, NULL, "fluid_group");
588         RNA_def_property_struct_type(prop, "Group");
589         RNA_def_property_flag(prop, PROP_EDITABLE);
590         RNA_def_property_ui_text(prop, "Fluid Group", "Limit fluid objects to this group");
591         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset_dependency");
592
593         prop = RNA_def_property(srna, "effector_group", PROP_POINTER, PROP_NONE);
594         RNA_def_property_pointer_sdna(prop, NULL, "eff_group");
595         RNA_def_property_struct_type(prop, "Group");
596         RNA_def_property_flag(prop, PROP_EDITABLE);
597         RNA_def_property_ui_text(prop, "Effector Group", "Limit effectors to this group");
598         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset_dependency");
599
600         prop = RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
601         RNA_def_property_float_sdna(prop, NULL, "strength");
602         RNA_def_property_range(prop, 0.0, 10.0);
603         RNA_def_property_ui_range(prop, 0.0, 10.0, 1, 2);
604         RNA_def_property_ui_text(prop, "Strength", "Strength of noise");
605         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
606
607         prop = RNA_def_property(srna, "dissolve_speed", PROP_INT, PROP_NONE);
608         RNA_def_property_int_sdna(prop, NULL, "diss_speed");
609         RNA_def_property_range(prop, 1.0, 10000.0);
610         RNA_def_property_ui_range(prop, 1.0, 10000.0, 1, -1);
611         RNA_def_property_ui_text(prop, "Dissolve Speed", "Dissolve Speed");
612         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
613
614         prop = RNA_def_property(srna, "use_dissolve_smoke", PROP_BOOLEAN, PROP_NONE);
615         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_DISSOLVE);
616         RNA_def_property_ui_text(prop, "Dissolve Smoke", "Enable smoke to disappear over time");
617         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
618
619         prop = RNA_def_property(srna, "use_dissolve_smoke_log", PROP_BOOLEAN, PROP_NONE);
620         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_DISSOLVE_LOG);
621         RNA_def_property_ui_text(prop, "Logarithmic dissolve", "Using 1/x ");
622         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
623
624         prop = RNA_def_property(srna, "point_cache", PROP_POINTER, PROP_NONE);
625         RNA_def_property_flag(prop, PROP_NEVER_NULL);
626         RNA_def_property_pointer_sdna(prop, NULL, "point_cache[0]");
627         RNA_def_property_ui_text(prop, "Point Cache", "");
628
629         prop = RNA_def_property(srna, "point_cache_compress_type", PROP_ENUM, PROP_NONE);
630         RNA_def_property_enum_sdna(prop, NULL, "cache_comp");
631         RNA_def_property_enum_items(prop, smoke_cache_comp_items);
632         RNA_def_property_ui_text(prop, "Cache Compression", "Compression method to be used");
633
634         prop = RNA_def_property(srna, "openvdb_cache_compress_type", PROP_ENUM, PROP_NONE);
635         RNA_def_property_enum_sdna(prop, NULL, "openvdb_comp");
636         RNA_def_property_enum_items(prop, prop_compression_items);
637         RNA_def_property_ui_text(prop, "Compression", "Compression method to be used");
638
639         prop = RNA_def_property(srna, "data_depth", PROP_ENUM, PROP_NONE);
640         RNA_def_property_enum_bitflag_sdna(prop, NULL, "data_depth");
641         RNA_def_property_enum_items(prop, smoke_data_depth_items);
642         RNA_def_property_ui_text(prop, "Data Depth",
643                                  "Bit depth for writing all scalar (including vector) "
644                                  "lower values reduce file size");
645         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, NULL);
646
647         prop = RNA_def_property(srna, "collision_extents", PROP_ENUM, PROP_NONE);
648         RNA_def_property_enum_sdna(prop, NULL, "border_collisions");
649         RNA_def_property_enum_items(prop, smoke_domain_colli_items);
650         RNA_def_property_ui_text(prop, "Border Collisions",
651                                  "Select which domain border will be treated as collision object");
652         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
653
654         prop = RNA_def_property(srna, "effector_weights", PROP_POINTER, PROP_NONE);
655         RNA_def_property_struct_type(prop, "EffectorWeights");
656         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
657         RNA_def_property_ui_text(prop, "Effector Weights", "");
658
659         prop = RNA_def_property(srna, "highres_sampling", PROP_ENUM, PROP_NONE);
660         RNA_def_property_enum_items(prop, smoke_highres_sampling_items);
661         RNA_def_property_ui_text(prop, "Emitter", "Method for sampling the high resolution flow");
662         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
663
664         prop = RNA_def_property(srna, "time_scale", PROP_FLOAT, PROP_NONE);
665         RNA_def_property_float_sdna(prop, NULL, "time_scale");
666         RNA_def_property_range(prop, 0.2, 1.5);
667         RNA_def_property_ui_range(prop, 0.2, 1.5, 0.02, 5);
668         RNA_def_property_ui_text(prop, "Time Scale", "Adjust simulation speed");
669         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
670
671         prop = RNA_def_property(srna, "vorticity", PROP_FLOAT, PROP_NONE);
672         RNA_def_property_float_sdna(prop, NULL, "vorticity");
673         RNA_def_property_range(prop, 0.01, 4.0);
674         RNA_def_property_ui_range(prop, 0.01, 4.0, 0.02, 5);
675         RNA_def_property_ui_text(prop, "Vorticity", "Amount of turbulence/rotation in fluid");
676         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
677
678         prop = RNA_def_property(srna, "density_grid", PROP_FLOAT, PROP_NONE);
679         RNA_def_property_array(prop, 32);
680         RNA_def_property_flag(prop, PROP_DYNAMIC);
681         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
682         RNA_def_property_dynamic_array_funcs(prop, "rna_SmokeModifier_grid_get_length");
683         RNA_def_property_float_funcs(prop, "rna_SmokeModifier_density_grid_get", NULL, NULL);
684         RNA_def_property_ui_text(prop, "Density Grid", "Smoke density grid");
685
686         prop = RNA_def_property(srna, "velocity_grid", PROP_FLOAT, PROP_NONE);
687         RNA_def_property_array(prop, 32);
688         RNA_def_property_flag(prop, PROP_DYNAMIC);
689         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
690         RNA_def_property_dynamic_array_funcs(prop, "rna_SmokeModifier_velocity_grid_get_length");
691         RNA_def_property_float_funcs(prop, "rna_SmokeModifier_velocity_grid_get", NULL, NULL);
692         RNA_def_property_ui_text(prop, "Velocity Grid", "Smoke velocity grid");
693
694         prop = RNA_def_property(srna, "flame_grid", PROP_FLOAT, PROP_NONE);
695         RNA_def_property_array(prop, 32);
696         RNA_def_property_flag(prop, PROP_DYNAMIC);
697         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
698         RNA_def_property_dynamic_array_funcs(prop, "rna_SmokeModifier_grid_get_length");
699         RNA_def_property_float_funcs(prop, "rna_SmokeModifier_flame_grid_get", NULL, NULL);
700         RNA_def_property_ui_text(prop, "Flame Grid", "Smoke flame grid");
701
702         prop = RNA_def_property(srna, "color_grid", PROP_FLOAT, PROP_NONE);
703         RNA_def_property_array(prop, 32);
704         RNA_def_property_flag(prop, PROP_DYNAMIC);
705         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
706         RNA_def_property_dynamic_array_funcs(prop, "rna_SmokeModifier_color_grid_get_length");
707         RNA_def_property_float_funcs(prop, "rna_SmokeModifier_color_grid_get", NULL, NULL);
708         RNA_def_property_ui_text(prop, "Color Grid", "Smoke color grid");
709
710         prop = RNA_def_property(srna, "heat_grid", PROP_FLOAT, PROP_NONE);
711         RNA_def_property_array(prop, 32);
712         RNA_def_property_flag(prop, PROP_DYNAMIC);
713         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
714         RNA_def_property_dynamic_array_funcs(prop, "rna_SmokeModifier_heat_grid_get_length");
715         RNA_def_property_float_funcs(prop, "rna_SmokeModifier_heat_grid_get", NULL, NULL);
716         RNA_def_property_ui_text(prop, "Heat Grid", "Smoke heat grid");
717
718         prop = RNA_def_property(srna, "temperature_grid", PROP_FLOAT, PROP_NONE);
719         RNA_def_property_array(prop, 32);
720         RNA_def_property_flag(prop, PROP_DYNAMIC);
721         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
722         RNA_def_property_dynamic_array_funcs(prop, "rna_SmokeModifier_grid_get_length");
723         RNA_def_property_float_funcs(prop, "rna_SmokeModifier_temperature_grid_get", NULL, NULL);
724         RNA_def_property_ui_text(prop, "Temperature Grid", "Smoke temperature grid, range 0..1 represents 0..1000K");
725
726         prop = RNA_def_property(srna, "cell_size", PROP_FLOAT, PROP_XYZ); /* can change each frame when using adaptive domain */
727         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
728         RNA_def_property_ui_text(prop, "cell_size", "Cell Size");
729
730         prop = RNA_def_property(srna, "start_point", PROP_FLOAT, PROP_XYZ); /* can change each frame when using adaptive domain */
731         RNA_def_property_float_sdna(prop, NULL, "p0");
732         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
733         RNA_def_property_ui_text(prop, "p0", "Start point");
734
735         prop = RNA_def_property(srna, "domain_resolution", PROP_INT, PROP_XYZ); /* can change each frame when using adaptive domain */
736         RNA_def_property_int_sdna(prop, NULL, "res");
737         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
738         RNA_def_property_ui_text(prop, "res", "Smoke Grid Resolution");
739
740         prop = RNA_def_property(srna, "burning_rate", PROP_FLOAT, PROP_NONE);
741         RNA_def_property_range(prop, 0.01, 4.0);
742         RNA_def_property_ui_range(prop, 0.01, 2.0, 1.0, 5);
743         RNA_def_property_ui_text(prop, "Speed", "Speed of the burning reaction (use larger values for smaller flame)");
744         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
745
746         prop = RNA_def_property(srna, "flame_smoke", PROP_FLOAT, PROP_NONE);
747         RNA_def_property_range(prop, 0.0, 8.0);
748         RNA_def_property_ui_range(prop, 0.0, 4.0, 1.0, 5);
749         RNA_def_property_ui_text(prop, "Smoke", "Amount of smoke created by burning fuel");
750         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
751
752         prop = RNA_def_property(srna, "flame_vorticity", PROP_FLOAT, PROP_NONE);
753         RNA_def_property_range(prop, 0.0, 2.0);
754         RNA_def_property_ui_range(prop, 0.0, 1.0, 1.0, 5);
755         RNA_def_property_ui_text(prop, "Vorticity", "Additional vorticity for the flames");
756         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
757
758         prop = RNA_def_property(srna, "flame_ignition", PROP_FLOAT, PROP_NONE);
759         RNA_def_property_range(prop, 0.5, 5.0);
760         RNA_def_property_ui_range(prop, 0.5, 2.5, 1.0, 5);
761         RNA_def_property_ui_text(prop, "Ignition", "Minimum temperature of flames");
762         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
763
764         prop = RNA_def_property(srna, "flame_max_temp", PROP_FLOAT, PROP_NONE);
765         RNA_def_property_range(prop, 1.0, 10.0);
766         RNA_def_property_ui_range(prop, 1.0, 5.0, 1.0, 5);
767         RNA_def_property_ui_text(prop, "Maximum", "Maximum temperature of flames");
768         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
769
770         prop = RNA_def_property(srna, "flame_smoke_color", PROP_FLOAT, PROP_COLOR_GAMMA);
771         RNA_def_property_array(prop, 3);
772         RNA_def_property_ui_text(prop, "Smoke Color", "Color of smoke emitted from burning fuel");
773         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
774
775         prop = RNA_def_property(srna, "use_adaptive_domain", PROP_BOOLEAN, PROP_NONE);
776         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_ADAPTIVE_DOMAIN);
777         RNA_def_property_ui_text(prop, "Adaptive Domain", "Adapt simulation resolution and size to fluid");
778         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
779         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
780
781         prop = RNA_def_property(srna, "additional_res", PROP_INT, PROP_NONE);
782         RNA_def_property_int_sdna(prop, NULL, "adapt_res");
783         RNA_def_property_range(prop, 0, 512);
784         RNA_def_property_ui_range(prop, 0, 512, 2, -1);
785         RNA_def_property_ui_text(prop, "Additional", "Maximum number of additional cells");
786         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
787
788         prop = RNA_def_property(srna, "adapt_margin", PROP_INT, PROP_NONE);
789         RNA_def_property_int_sdna(prop, NULL, "adapt_margin");
790         RNA_def_property_range(prop, 2, 24);
791         RNA_def_property_ui_range(prop, 2, 24, 2, -1);
792         RNA_def_property_ui_text(prop, "Margin", "Margin added around fluid to minimize boundary interference");
793         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
794
795         prop = RNA_def_property(srna, "adapt_threshold", PROP_FLOAT, PROP_NONE);
796         RNA_def_property_range(prop, 0.01, 0.5);
797         RNA_def_property_ui_range(prop, 0.01, 0.5, 1.0, 5);
798         RNA_def_property_ui_text(prop, "Threshold",
799                                  "Maximum amount of fluid cell can contain before it is considered empty");
800         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
801
802         prop = RNA_def_property(srna, "cache_file_format", PROP_ENUM, PROP_NONE);
803         RNA_def_property_enum_sdna(prop, NULL, "cache_file_format");
804         RNA_def_property_enum_items(prop, cache_file_type_items);
805         RNA_def_property_enum_funcs(prop, NULL, "rna_Smoke_cachetype_set", NULL);
806         RNA_def_property_ui_text(prop, "File Format", "Select the file format to be used for caching");
807         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_resetCache");
808
809         /* display settings */
810
811         prop = RNA_def_property(srna, "slice_method", PROP_ENUM, PROP_NONE);
812         RNA_def_property_enum_sdna(prop, NULL, "slice_method");
813         RNA_def_property_enum_items(prop, smoke_view_items);
814         RNA_def_property_ui_text(prop, "View Method", "How to slice the volume for viewport rendering");
815         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
816
817         prop = RNA_def_property(srna, "axis_slice_method", PROP_ENUM, PROP_NONE);
818         RNA_def_property_enum_sdna(prop, NULL, "axis_slice_method");
819         RNA_def_property_enum_items(prop, axis_slice_method_items);
820         RNA_def_property_ui_text(prop, "Method", "");
821         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
822
823         prop = RNA_def_property(srna, "slice_axis", PROP_ENUM, PROP_NONE);
824         RNA_def_property_enum_sdna(prop, NULL, "slice_axis");
825         RNA_def_property_enum_items(prop, axis_slice_position_items);
826         RNA_def_property_ui_text(prop, "Axis", "");
827         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
828
829         prop = RNA_def_property(srna, "slice_per_voxel", PROP_FLOAT, PROP_NONE);
830         RNA_def_property_float_sdna(prop, NULL, "slice_per_voxel");
831         RNA_def_property_range(prop, 0.0, 100.0);
832         RNA_def_property_ui_range(prop, 0.0, 5.0, 0.1, 1);
833         RNA_def_property_ui_text(prop, "Slice Per Voxel",
834                                  "How many slices per voxel should be generated");
835         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
836
837         prop = RNA_def_property(srna, "slice_depth", PROP_FLOAT, PROP_NONE);
838         RNA_def_property_float_sdna(prop, NULL, "slice_depth");
839         RNA_def_property_range(prop, 0.0, 1.0);
840         RNA_def_property_ui_range(prop, 0.0, 1.0, 0.1, 3);
841         RNA_def_property_ui_text(prop, "Position", "Position of the slice");
842         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
843
844         prop = RNA_def_property(srna, "display_thickness", PROP_FLOAT, PROP_NONE);
845         RNA_def_property_float_sdna(prop, NULL, "display_thickness");
846         RNA_def_property_range(prop, 0.001, 1000.0);
847         RNA_def_property_ui_range(prop, 0.1, 100.0, 0.1, 3);
848         RNA_def_property_ui_text(prop, "Thickness", "Thickness of smoke drawing in the viewport");
849         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, NULL);
850
851         prop = RNA_def_property(srna, "draw_velocity", PROP_BOOLEAN, PROP_NONE);
852         RNA_def_property_boolean_sdna(prop, NULL, "draw_velocity", 0);
853         RNA_def_property_ui_text(prop, "Draw Velocity", "Toggle visualization of the velocity field as needles");
854         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
855
856         prop = RNA_def_property(srna, "vector_draw_type", PROP_ENUM, PROP_NONE);
857         RNA_def_property_enum_sdna(prop, NULL, "vector_draw_type");
858         RNA_def_property_enum_items(prop, vector_draw_items);
859         RNA_def_property_ui_text(prop, "Draw Type", "");
860         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
861
862         prop = RNA_def_property(srna, "vector_scale", PROP_FLOAT, PROP_NONE);
863         RNA_def_property_float_sdna(prop, NULL, "vector_scale");
864         RNA_def_property_range(prop, 0.0, 1000.0);
865         RNA_def_property_ui_range(prop, 0.0, 100.0, 0.1, 3);
866         RNA_def_property_ui_text(prop, "Scale", "Multiplier for scaling the vectors");
867         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
868
869         /* --------- Color mapping. --------- */
870
871         prop = RNA_def_property(srna, "use_color_ramp", PROP_BOOLEAN, PROP_NONE);
872         RNA_def_property_boolean_sdna(prop, NULL, "use_coba", 0);
873         RNA_def_property_boolean_funcs(prop, NULL, "rna_Smoke_use_color_ramp_set");
874         RNA_def_property_ui_text(prop, "Use Color Ramp",
875                                  "Render a simulation field while mapping its voxels values to the colors of a ramp");
876         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
877
878         static const EnumPropertyItem coba_field_items[] = {
879             {FLUID_FIELD_COLOR_R, "COLOR_R", 0, "Red", "Red component of the color field"},
880             {FLUID_FIELD_COLOR_G, "COLOR_G", 0, "Green", "Green component of the color field"},
881             {FLUID_FIELD_COLOR_B, "COLOR_B", 0, "Blue", "Blue component of the color field"},
882             {FLUID_FIELD_DENSITY, "DENSITY", 0, "Density", "Quantity of soot in the fluid"},
883             {FLUID_FIELD_FLAME, "FLAME", 0, "Flame", "Flame field"},
884             {FLUID_FIELD_FUEL, "FUEL", 0, "Fuel", "Fuel field"},
885             {FLUID_FIELD_HEAT, "HEAT", 0, "Heat", "Temperature of the fluid"},
886             {FLUID_FIELD_VELOCITY_X, "VELOCITY_X", 0, "X Velocity", "X component of the velocity field"},
887             {FLUID_FIELD_VELOCITY_Y, "VELOCITY_Y", 0, "Y Velocity", "Y component of the velocity field"},
888             {FLUID_FIELD_VELOCITY_Z, "VELOCITY_Z", 0, "Z Velocity", "Z component of the velocity field"},
889             {0, NULL, 0, NULL, NULL}
890         };
891
892         prop = RNA_def_property(srna, "coba_field", PROP_ENUM, PROP_NONE);
893         RNA_def_property_enum_sdna(prop, NULL, "coba_field");
894         RNA_def_property_enum_items(prop, coba_field_items);
895         RNA_def_property_ui_text(prop, "Field", "Simulation field to color map");
896         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
897
898         prop = RNA_def_property(srna, "color_ramp", PROP_POINTER, PROP_NEVER_NULL);
899         RNA_def_property_pointer_sdna(prop, NULL, "coba");
900         RNA_def_property_struct_type(prop, "ColorRamp");
901         RNA_def_property_ui_text(prop, "Color Ramp", "");
902         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
903
904         prop = RNA_def_property(srna, "clipping", PROP_FLOAT, PROP_NONE);
905         RNA_def_property_float_sdna(prop, NULL, "clipping");
906         RNA_def_property_range(prop, 0.0, 1.0);
907         RNA_def_property_ui_range(prop, 0.0, 1.0, 0.1, 3);
908         RNA_def_property_ui_text(prop, "Clipping",
909                                                          "Value under which voxels are considered empty space to optimize caching or rendering");
910         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, NULL);
911 }
912
913 static void rna_def_smoke_flow_settings(BlenderRNA *brna)
914 {
915         StructRNA *srna;
916         PropertyRNA *prop;
917
918         static const EnumPropertyItem smoke_flow_types[] = {
919                 {MOD_SMOKE_FLOW_TYPE_OUTFLOW, "OUTFLOW", 0, "Outflow", "Delete smoke from simulation"},
920                 {MOD_SMOKE_FLOW_TYPE_SMOKE, "SMOKE", 0, "Smoke", "Add smoke"},
921                 {MOD_SMOKE_FLOW_TYPE_SMOKEFIRE, "BOTH", 0, "Fire + Smoke", "Add fire and smoke"},
922                 {MOD_SMOKE_FLOW_TYPE_FIRE, "FIRE", 0, "Fire", "Add fire"},
923                 {0, NULL, 0, NULL, NULL}
924         };
925
926         static const EnumPropertyItem smoke_flow_sources[] = {
927                 {MOD_SMOKE_FLOW_SOURCE_PARTICLES, "PARTICLES", ICON_PARTICLES, "Particle System", "Emit smoke from particles"},
928                 {MOD_SMOKE_FLOW_SOURCE_MESH, "MESH", ICON_META_CUBE, "Mesh", "Emit smoke from mesh surface or volume"},
929                 {0, NULL, 0, NULL, NULL}
930         };
931
932         static const EnumPropertyItem smoke_flow_texture_types[] = {
933                 {MOD_SMOKE_FLOW_TEXTURE_MAP_AUTO, "AUTO", 0, "Generated", "Generated coordinates centered to flow object"},
934                 {MOD_SMOKE_FLOW_TEXTURE_MAP_UV, "UV", 0, "UV", "Use UV layer for texture coordinates"},
935                 {0, NULL, 0, NULL, NULL}
936         };
937
938         srna = RNA_def_struct(brna, "SmokeFlowSettings", NULL);
939         RNA_def_struct_ui_text(srna, "Flow Settings", "Smoke flow settings");
940         RNA_def_struct_sdna(srna, "SmokeFlowSettings");
941         RNA_def_struct_path_func(srna, "rna_SmokeFlowSettings_path");
942
943         prop = RNA_def_property(srna, "density", PROP_FLOAT, PROP_NONE);
944         RNA_def_property_float_sdna(prop, NULL, "density");
945         RNA_def_property_range(prop, 0.0, 1);
946         RNA_def_property_ui_range(prop, 0.0, 1.0, 1.0, 4);
947         RNA_def_property_ui_text(prop, "Density", "");
948         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
949
950         prop = RNA_def_property(srna, "smoke_color", PROP_FLOAT, PROP_COLOR_GAMMA);
951         RNA_def_property_float_sdna(prop, NULL, "color");
952         RNA_def_property_array(prop, 3);
953         RNA_def_property_ui_text(prop, "Smoke Color", "Color of smoke");
954         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
955
956         prop = RNA_def_property(srna, "fuel_amount", PROP_FLOAT, PROP_NONE);
957         RNA_def_property_range(prop, 0.0, 10);
958         RNA_def_property_ui_range(prop, 0.0, 5.0, 1.0, 4);
959         RNA_def_property_ui_text(prop, "Flame Rate", "");
960         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
961
962         prop = RNA_def_property(srna, "temperature", PROP_FLOAT, PROP_NONE);
963         RNA_def_property_float_sdna(prop, NULL, "temp");
964         RNA_def_property_range(prop, -10, 10);
965         RNA_def_property_ui_range(prop, -10, 10, 1, 1);
966         RNA_def_property_ui_text(prop, "Temp. Diff.", "Temperature difference to ambient temperature");
967         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
968         
969         prop = RNA_def_property(srna, "particle_system", PROP_POINTER, PROP_NONE);
970         RNA_def_property_pointer_sdna(prop, NULL, "psys");
971         RNA_def_property_struct_type(prop, "ParticleSystem");
972         RNA_def_property_flag(prop, PROP_EDITABLE);
973         RNA_def_property_ui_text(prop, "Particle Systems", "Particle systems emitted from the object");
974         RNA_def_property_update(prop, 0, "rna_Smoke_reset_dependency");
975
976         prop = RNA_def_property(srna, "smoke_flow_type", PROP_ENUM, PROP_NONE);
977         RNA_def_property_enum_sdna(prop, NULL, "type");
978         RNA_def_property_enum_items(prop, smoke_flow_types);
979         RNA_def_property_ui_text(prop, "Flow Type", "Change how flow affects the simulation");
980         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
981
982         prop = RNA_def_property(srna, "smoke_flow_source", PROP_ENUM, PROP_NONE);
983         RNA_def_property_enum_sdna(prop, NULL, "source");
984         RNA_def_property_enum_items(prop, smoke_flow_sources);
985         RNA_def_property_ui_text(prop, "Source", "Change how smoke is emitted");
986         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
987
988         prop = RNA_def_property(srna, "use_absolute", PROP_BOOLEAN, PROP_NONE);
989         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_FLOW_ABSOLUTE);
990         RNA_def_property_ui_text(prop, "Absolute Density", "Only allow given density value in emitter area");
991         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
992
993         prop = RNA_def_property(srna, "use_initial_velocity", PROP_BOOLEAN, PROP_NONE);
994         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_FLOW_INITVELOCITY);
995         RNA_def_property_ui_text(prop, "Initial Velocity", "Smoke has some initial velocity when it is emitted");
996         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
997
998         prop = RNA_def_property(srna, "velocity_factor", PROP_FLOAT, PROP_NONE);
999         RNA_def_property_float_sdna(prop, NULL, "vel_multi");
1000         RNA_def_property_range(prop, -100.0, 100.0);
1001         RNA_def_property_ui_range(prop, -2.0, 2.0, 0.05, 5);
1002         RNA_def_property_ui_text(prop, "Source", "Multiplier of source velocity passed to smoke");
1003         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1004
1005         prop = RNA_def_property(srna, "velocity_normal", PROP_FLOAT, PROP_NONE);
1006         RNA_def_property_float_sdna(prop, NULL, "vel_normal");
1007         RNA_def_property_range(prop, -100.0, 100.0);
1008         RNA_def_property_ui_range(prop, -2.0, 2.0, 0.05, 5);
1009         RNA_def_property_ui_text(prop, "Normal", "Amount of normal directional velocity");
1010         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1011
1012         prop = RNA_def_property(srna, "velocity_random", PROP_FLOAT, PROP_NONE);
1013         RNA_def_property_float_sdna(prop, NULL, "vel_random");
1014         RNA_def_property_range(prop, 0.0, 10.0);
1015         RNA_def_property_ui_range(prop, 0.0, 2.0, 0.05, 5);
1016         RNA_def_property_ui_text(prop, "Random", "Amount of random velocity");
1017         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1018
1019         prop = RNA_def_property(srna, "volume_density", PROP_FLOAT, PROP_NONE);
1020         RNA_def_property_range(prop, 0.0, 1.0);
1021         RNA_def_property_ui_range(prop, 0.0, 1.0, 0.05, 5);
1022         RNA_def_property_ui_text(prop, "Volume", "Factor for smoke emitted from inside the mesh volume");
1023         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1024
1025         prop = RNA_def_property(srna, "surface_distance", PROP_FLOAT, PROP_NONE);
1026         RNA_def_property_range(prop, 0.0, 10.0);
1027         RNA_def_property_ui_range(prop, 0.5, 5.0, 0.05, 5);
1028         RNA_def_property_ui_text(prop, "Surface", "Maximum distance from mesh surface to emit smoke");
1029         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1030
1031         prop = RNA_def_property(srna, "particle_size", PROP_FLOAT, PROP_NONE);
1032         RNA_def_property_range(prop, 0.1, 20.0);
1033         RNA_def_property_ui_range(prop, 0.5, 5.0, 0.05, 5);
1034         RNA_def_property_ui_text(prop, "Size", "Particle size in simulation cells");
1035         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1036
1037         prop = RNA_def_property(srna, "use_particle_size", PROP_BOOLEAN, PROP_NONE);
1038         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_FLOW_USE_PART_SIZE);
1039         RNA_def_property_ui_text(prop, "Set Size", "Set particle size in simulation cells or use nearest cell");
1040         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1041
1042         prop = RNA_def_property(srna, "subframes", PROP_INT, PROP_NONE);
1043         RNA_def_property_range(prop, 0, 50);
1044         RNA_def_property_ui_range(prop, 0, 10, 1, -1);
1045         RNA_def_property_ui_text(prop, "Subframes", "Number of additional samples to take between frames to improve quality of fast moving flows");
1046         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1047
1048         prop = RNA_def_property(srna, "density_vertex_group", PROP_STRING, PROP_NONE);
1049         RNA_def_property_string_funcs(prop, "rna_SmokeFlow_density_vgroup_get",
1050                                       "rna_SmokeFlow_density_vgroup_length",
1051                                       "rna_SmokeFlow_density_vgroup_set");
1052         RNA_def_property_ui_text(prop, "Vertex Group",
1053                                  "Name of vertex group which determines surface emission rate");
1054         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1055
1056         prop = RNA_def_property(srna, "use_texture", PROP_BOOLEAN, PROP_NONE);
1057         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_FLOW_TEXTUREEMIT);
1058         RNA_def_property_ui_text(prop, "Use Texture", "Use a texture to control emission strength");
1059         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1060
1061         prop = RNA_def_property(srna, "texture_map_type", PROP_ENUM, PROP_NONE);
1062         RNA_def_property_enum_sdna(prop, NULL, "texture_type");
1063         RNA_def_property_enum_items(prop, smoke_flow_texture_types);
1064         RNA_def_property_ui_text(prop, "Mapping", "Texture mapping type");
1065         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1066
1067         prop = RNA_def_property(srna, "uv_layer", PROP_STRING, PROP_NONE);
1068         RNA_def_property_string_sdna(prop, NULL, "uvlayer_name");
1069         RNA_def_property_ui_text(prop, "UV Map", "UV map name");
1070         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_SmokeFlow_uvlayer_set");
1071         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1072
1073         prop = RNA_def_property(srna, "noise_texture", PROP_POINTER, PROP_NONE);
1074         RNA_def_property_flag(prop, PROP_EDITABLE);
1075         RNA_def_property_ui_text(prop, "Texture", "Texture that controls emission strength");
1076         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1077
1078         prop = RNA_def_property(srna, "texture_size", PROP_FLOAT, PROP_NONE);
1079         RNA_def_property_range(prop, 0.01, 10.0);
1080         RNA_def_property_ui_range(prop, 0.1, 5.0, 0.05, 5);
1081         RNA_def_property_ui_text(prop, "Size", "Size of texture mapping");
1082         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1083
1084         prop = RNA_def_property(srna, "texture_offset", PROP_FLOAT, PROP_NONE);
1085         RNA_def_property_range(prop, 0.0, 200.0);
1086         RNA_def_property_ui_range(prop, 0.0, 100.0, 0.05, 5);
1087         RNA_def_property_ui_text(prop, "Offset", "Z-offset of texture mapping");
1088         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1089 }
1090
1091 static void rna_def_smoke_coll_settings(BlenderRNA *brna)
1092 {
1093         static const EnumPropertyItem smoke_coll_type_items[] = {
1094                 {SM_COLL_STATIC, "COLLSTATIC", 0, "Static", "Non moving obstacle"},
1095                 {SM_COLL_RIGID, "COLLRIGID", 0, "Rigid", "Rigid obstacle"},
1096                 {SM_COLL_ANIMATED, "COLLANIMATED", 0, "Animated", "Animated obstacle"},
1097                 {0, NULL, 0, NULL, NULL}
1098         };
1099
1100         StructRNA *srna;
1101         PropertyRNA *prop;
1102
1103         srna = RNA_def_struct(brna, "SmokeCollSettings", NULL);
1104         RNA_def_struct_ui_text(srna, "Collision Settings", "Smoke collision settings");
1105         RNA_def_struct_sdna(srna, "SmokeCollSettings");
1106         RNA_def_struct_path_func(srna, "rna_SmokeCollSettings_path");
1107
1108         prop = RNA_def_property(srna, "collision_type", PROP_ENUM, PROP_NONE);
1109         RNA_def_property_enum_sdna(prop, NULL, "type");
1110         RNA_def_property_enum_items(prop, smoke_coll_type_items);
1111         RNA_def_property_ui_text(prop, "Collision type", "Collision type");
1112         RNA_def_property_update(prop, NC_OBJECT | ND_MODIFIER, "rna_Smoke_reset");
1113 }
1114
1115 void RNA_def_smoke(BlenderRNA *brna)
1116 {
1117         rna_def_smoke_domain_settings(brna);
1118         rna_def_smoke_flow_settings(brna);
1119         rna_def_smoke_coll_settings(brna);
1120 }
1121
1122 #endif