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