7bccd685c1db238fa685b8dcb659505362c6701d
[blender-staging.git] / source / blender / makesrna / intern / rna_smoke.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Daniel Genrich
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26 #include <limits.h>
27
28 #include "RNA_define.h"
29 #include "RNA_types.h"
30
31 #include "rna_internal.h"
32
33 #include "BKE_modifier.h"
34 #include "BKE_smoke.h"
35
36 #include "DNA_modifier_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_scene_types.h"
39 #include "DNA_smoke_types.h"
40
41 #include "WM_types.h"
42
43
44 #ifdef RNA_RUNTIME
45
46 #include "BKE_context.h"
47 #include "BKE_depsgraph.h"
48 #include "BKE_particle.h"
49
50 #include "ED_object.h"
51
52 static void rna_Smoke_update(bContext *C, PointerRNA *ptr)
53 {
54         DAG_id_flush_update(ptr->id.data, OB_RECALC_DATA);
55 }
56
57 static void rna_Smoke_dependency_update(bContext *C, PointerRNA *ptr)
58 {
59         rna_Smoke_update(C, ptr);
60     DAG_scene_sort(CTX_data_scene(C));
61 }
62
63 static void rna_Smoke_reset(bContext *C, PointerRNA *ptr)
64 {
65         SmokeDomainSettings *settings = (SmokeDomainSettings*)ptr->data;
66
67         smokeModifier_reset(settings->smd);
68
69         rna_Smoke_update(C, ptr);
70 }
71
72 static void rna_Smoke_reset_dependancy(bContext *C, PointerRNA *ptr)
73 {
74         SmokeDomainSettings *settings = (SmokeDomainSettings*)ptr->data;
75
76         smokeModifier_reset(settings->smd);
77
78         rna_Smoke_dependency_update(C, ptr);
79 }
80
81 static char *rna_SmokeDomainSettings_path(PointerRNA *ptr)
82 {
83         SmokeDomainSettings *settings = (SmokeDomainSettings*)ptr->data;
84         ModifierData *md= (ModifierData *)settings->smd;
85
86         return BLI_sprintfN("modifiers[%s].domain_settings", md->name);
87 }
88
89 static char *rna_SmokeFlowSettings_path(PointerRNA *ptr)
90 {
91         SmokeFlowSettings *settings = (SmokeFlowSettings*)ptr->data;
92         ModifierData *md= (ModifierData *)settings->smd;
93
94         return BLI_sprintfN("modifiers[%s].flow_settings", md->name);
95 }
96
97 static char *rna_SmokeCollSettings_path(PointerRNA *ptr)
98 {
99         SmokeCollSettings *settings = (SmokeCollSettings*)ptr->data;
100         ModifierData *md= (ModifierData *)settings->smd;
101
102         return BLI_sprintfN("modifiers[%s].coll_settings", md->name);
103 }
104
105 #else
106
107 static void rna_def_smoke_domain_settings(BlenderRNA *brna)
108 {
109         StructRNA *srna;
110         PropertyRNA *prop;
111
112         static EnumPropertyItem prop_noise_type_items[] = {
113                                 {MOD_SMOKE_NOISEWAVE, "NOISEWAVE", 0, "Wavelet", ""},
114 #if FFTW3 == 1
115                                 {MOD_SMOKE_NOISEFFT, "NOISEFFT", 0, "FFT", ""}, 
116 #endif
117                         /*      {MOD_SMOKE_NOISECURL, "NOISECURL", 0, "Curl", ""}, */
118                                 {0, NULL, 0, NULL, NULL}};
119
120         srna = RNA_def_struct(brna, "SmokeDomainSettings", NULL);
121         RNA_def_struct_ui_text(srna, "Domain Settings", "Smoke domain settings.");
122         RNA_def_struct_sdna(srna, "SmokeDomainSettings");
123         RNA_def_struct_path_func(srna, "rna_SmokeDomainSettings_path");
124
125         prop= RNA_def_property(srna, "maxres", PROP_INT, PROP_NONE);
126         RNA_def_property_int_sdna(prop, NULL, "maxres");
127         RNA_def_property_range(prop, 24, 512);
128         RNA_def_property_ui_range(prop, 24, 512, 2, 0);
129         RNA_def_property_ui_text(prop, "Max Res", "Maximal resolution used in the fluid domain.");
130         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
131
132         prop= RNA_def_property(srna, "amplify", PROP_INT, PROP_NONE);
133         RNA_def_property_int_sdna(prop, NULL, "amplify");
134         RNA_def_property_range(prop, 1, 10);
135         RNA_def_property_ui_range(prop, 1, 10, 1, 0);
136         RNA_def_property_ui_text(prop, "Amplification", "Enhance the resolution of smoke by this factor using noise.");
137         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
138
139         prop= RNA_def_property(srna, "highres", PROP_BOOLEAN, PROP_NONE);
140         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_HIGHRES);
141         RNA_def_property_ui_text(prop, "High res", "Enable high resolution (using amplification).");
142         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
143
144         prop= RNA_def_property(srna, "viewhighres", PROP_BOOLEAN, PROP_NONE);
145         RNA_def_property_boolean_sdna(prop, NULL, "viewsettings", MOD_SMOKE_VIEW_SHOWBIG);
146         RNA_def_property_ui_text(prop, "Show High Resolution", "Show high resolution (using amplification).");
147         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
148
149         prop= RNA_def_property(srna, "noise_type", PROP_ENUM, PROP_NONE);
150         RNA_def_property_enum_sdna(prop, NULL, "noise");
151         RNA_def_property_enum_items(prop, prop_noise_type_items);
152         RNA_def_property_ui_text(prop, "Noise Method", "Noise method which is used for creating the high resolution");
153         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
154
155         prop= RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
156         RNA_def_property_float_sdna(prop, NULL, "alpha");
157         RNA_def_property_range(prop, -5.0, 5.0);
158         RNA_def_property_ui_range(prop, -5.0, 5.0, 0.02, 5);
159         RNA_def_property_ui_text(prop, "Gravity", "Higher value results in sinking smoke");
160         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
161
162         prop= RNA_def_property(srna, "beta", PROP_FLOAT, PROP_NONE);
163         RNA_def_property_float_sdna(prop, NULL, "beta");
164         RNA_def_property_range(prop, -5.0, 5.0);
165         RNA_def_property_ui_range(prop, -5.0, 5.0, 0.02, 5);
166         RNA_def_property_ui_text(prop, "Heat", "Higher value results in faster rising smoke.");
167         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
168
169         prop= RNA_def_property(srna, "coll_group", PROP_POINTER, PROP_NONE);
170         RNA_def_property_pointer_sdna(prop, NULL, "coll_group");
171         RNA_def_property_struct_type(prop, "Group");
172         RNA_def_property_flag(prop, PROP_EDITABLE);
173         RNA_def_property_ui_text(prop, "Collision Group", "Limit collisions to this group.");
174         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");
175
176         prop= RNA_def_property(srna, "fluid_group", PROP_POINTER, PROP_NONE);
177         RNA_def_property_pointer_sdna(prop, NULL, "fluid_group");
178         RNA_def_property_struct_type(prop, "Group");
179         RNA_def_property_flag(prop, PROP_EDITABLE);
180         RNA_def_property_ui_text(prop, "Fluid Group", "Limit fluid objects to this group.");
181         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");
182
183         prop= RNA_def_property(srna, "eff_group", PROP_POINTER, PROP_NONE);
184         RNA_def_property_pointer_sdna(prop, NULL, "eff_group");
185         RNA_def_property_struct_type(prop, "Group");
186         RNA_def_property_flag(prop, PROP_EDITABLE);
187         RNA_def_property_ui_text(prop, "Effector Group", "Limit effectors to this group.");
188         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");
189
190         prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
191         RNA_def_property_float_sdna(prop, NULL, "strength");
192         RNA_def_property_range(prop, 1.0, 10.0);
193         RNA_def_property_ui_range(prop, 1.0, 10.0, 1, 2);
194         RNA_def_property_ui_text(prop, "Strength", "Strength of wavelet noise");
195         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
196
197         prop= RNA_def_property(srna, "dissolve_speed", PROP_INT, PROP_NONE);
198         RNA_def_property_int_sdna(prop, NULL, "diss_speed");
199         RNA_def_property_range(prop, 1.0, 100.0);
200         RNA_def_property_ui_range(prop, 1.0, 1000.0, 1, 0);
201         RNA_def_property_ui_text(prop, "Dissolve Speed", "Dissolve Speed");
202         RNA_def_property_update(prop, 0, NULL);
203
204         prop= RNA_def_property(srna, "dissolve_smoke", PROP_BOOLEAN, PROP_NONE);
205         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_DISSOLVE);
206         RNA_def_property_ui_text(prop, "Dissolve Smoke", "Enable smoke to disappear over time.");
207         RNA_def_property_update(prop, 0, NULL);
208
209         prop= RNA_def_property(srna, "dissolve_smoke_log", PROP_BOOLEAN, PROP_NONE);
210         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_DISSOLVE_LOG);
211         RNA_def_property_ui_text(prop, "Logarithmic dissolve", "Using 1/x ");
212         RNA_def_property_update(prop, 0, NULL);
213
214         prop= RNA_def_property(srna, "point_cache_low", PROP_POINTER, PROP_NONE);
215         RNA_def_property_flag(prop, PROP_NEVER_NULL);
216         RNA_def_property_pointer_sdna(prop, NULL, "point_cache[0]");
217         RNA_def_property_ui_text(prop, "Point Cache", "");
218
219         prop= RNA_def_property(srna, "point_cache_high", PROP_POINTER, PROP_NONE);
220         RNA_def_property_flag(prop, PROP_NEVER_NULL);
221         RNA_def_property_pointer_sdna(prop, NULL, "point_cache[1]");
222         RNA_def_property_ui_text(prop, "Point Cache", "");
223 }
224
225 static void rna_def_smoke_flow_settings(BlenderRNA *brna)
226 {
227         StructRNA *srna;
228         PropertyRNA *prop;
229
230         srna = RNA_def_struct(brna, "SmokeFlowSettings", NULL);
231         RNA_def_struct_ui_text(srna, "Flow Settings", "Smoke flow settings.");
232         RNA_def_struct_sdna(srna, "SmokeFlowSettings");
233         RNA_def_struct_path_func(srna, "rna_SmokeFlowSettings_path");
234
235         prop= RNA_def_property(srna, "density", PROP_FLOAT, PROP_NONE);
236         RNA_def_property_float_sdna(prop, NULL, "density");
237         RNA_def_property_range(prop, 0.001, 1);
238         RNA_def_property_ui_range(prop, 0.001, 1.0, 1.0, 4);
239         RNA_def_property_ui_text(prop, "Density", "");
240         RNA_def_property_update(prop, 0, NULL); // NC_OBJECT|ND_MODIFIER
241
242         prop= RNA_def_property(srna, "temperature", PROP_FLOAT, PROP_NONE);
243         RNA_def_property_float_sdna(prop, NULL, "temp");
244         RNA_def_property_range(prop, -10, 10);
245         RNA_def_property_ui_range(prop, -10, 10, 1, 1);
246         RNA_def_property_ui_text(prop, "Temp. Diff.", "Temperature difference to ambientt temperature.");
247         RNA_def_property_update(prop, 0, NULL);
248         
249         prop= RNA_def_property(srna, "psys", PROP_POINTER, PROP_NONE);
250         RNA_def_property_pointer_sdna(prop, NULL, "psys");
251         RNA_def_property_struct_type(prop, "ParticleSystem");
252         RNA_def_property_flag(prop, PROP_EDITABLE);
253         RNA_def_property_ui_text(prop, "Particle Systems", "Particle systems emitted from the object.");
254         RNA_def_property_update(prop, 0, "rna_Smoke_reset_dependancy");
255
256         prop= RNA_def_property(srna, "outflow", PROP_BOOLEAN, PROP_NONE);
257         RNA_def_property_boolean_sdna(prop, NULL, "type", MOD_SMOKE_FLOW_TYPE_OUTFLOW);
258         RNA_def_property_ui_text(prop, "Outflow", "Deletes smoke from simulation");
259         RNA_def_property_update(prop, 0, NULL);
260 }
261
262 static void rna_def_smoke_coll_settings(BlenderRNA *brna)
263 {
264         StructRNA *srna;
265
266         srna = RNA_def_struct(brna, "SmokeCollSettings", NULL);
267         RNA_def_struct_ui_text(srna, "Collision Settings", "Smoke collision settings.");
268         RNA_def_struct_sdna(srna, "SmokeCollSettings");
269         RNA_def_struct_path_func(srna, "rna_SmokeCollSettings_path");
270 }
271
272 void RNA_def_smoke(BlenderRNA *brna)
273 {
274         rna_def_smoke_domain_settings(brna);
275         rna_def_smoke_flow_settings(brna);
276         rna_def_smoke_coll_settings(brna);
277 }
278
279 #endif
280