BF2.5: First commit of smoke code.
[blender.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_object_flush_update(CTX_data_scene(C), 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 void rna_Smoke_redraw(bContext *C, PointerRNA *ptr)
82 {
83         SmokeDomainSettings *settings = (SmokeDomainSettings*)ptr->data;
84
85         settings->flags |= MOD_SMOKE_VIEW_REDRAWNICE;
86 }
87
88 static char *rna_SmokeDomainSettings_path(PointerRNA *ptr)
89 {
90         SmokeDomainSettings *settings = (SmokeDomainSettings*)ptr->data;
91         ModifierData *md= (ModifierData *)settings->smd;
92
93         return BLI_sprintfN("modifiers[%s].domain_settings", md->name);
94 }
95
96 static char *rna_SmokeFlowSettings_path(PointerRNA *ptr)
97 {
98         SmokeFlowSettings *settings = (SmokeFlowSettings*)ptr->data;
99         ModifierData *md= (ModifierData *)settings->smd;
100
101         return BLI_sprintfN("modifiers[%s].flow_settings", md->name);
102 }
103
104 static char *rna_SmokeCollSettings_path(PointerRNA *ptr)
105 {
106         SmokeCollSettings *settings = (SmokeCollSettings*)ptr->data;
107         ModifierData *md= (ModifierData *)settings->smd;
108
109         return BLI_sprintfN("modifiers[%s].coll_settings", md->name);
110 }
111
112 #else
113
114 static void rna_def_smoke_domain_settings(BlenderRNA *brna)
115 {
116         StructRNA *srna;
117         PropertyRNA *prop;
118
119         static EnumPropertyItem prop_noise_type_items[] = {
120                                 {MOD_SMOKE_NOISEWAVE, "NOISEWAVE", 0, "Wavelet", ""},
121                                 {MOD_SMOKE_NOISEFFT, "NOISEFFT", 0, "FFT", ""},
122                                 {MOD_SMOKE_NOISECURL, "NOISECURL", 0, "Curl", ""},
123                                 {0, NULL, 0, NULL, NULL}};
124
125         srna = RNA_def_struct(brna, "SmokeDomainSettings", NULL);
126         RNA_def_struct_ui_text(srna, "Domain Settings", "Smoke domain settings.");
127         RNA_def_struct_sdna(srna, "SmokeDomainSettings");
128         RNA_def_struct_path_func(srna, "rna_SmokeDomainSettings_path");
129
130         prop= RNA_def_property(srna, "maxres", PROP_INT, PROP_NONE);
131         RNA_def_property_int_sdna(prop, NULL, "maxres");
132         RNA_def_property_range(prop, 32, 512);
133         RNA_def_property_ui_range(prop, 32, 512, 2, 0);
134         RNA_def_property_ui_text(prop, "Max Res", "Maximal resolution used in the fluid domain.");
135         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
136
137         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_NONE);
138         RNA_def_property_float_sdna(prop, NULL, "omega");
139         RNA_def_property_range(prop, 0.02, 1.0);
140         RNA_def_property_ui_range(prop, 0.02, 1.0, 0.02, 2);
141         RNA_def_property_ui_text(prop, "Color", "Smoke color (0 = black, 1 = white).");
142         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Smoke_redraw");
143
144         prop= RNA_def_property(srna, "amplify", PROP_INT, PROP_NONE);
145         RNA_def_property_int_sdna(prop, NULL, "amplify");
146         RNA_def_property_range(prop, 1, 10);
147         RNA_def_property_ui_range(prop, 1, 10, 1, 0);
148         RNA_def_property_ui_text(prop, "Amplification", "Enhance the resolution of smoke by this factor using noise.");
149         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
150
151         prop= RNA_def_property(srna, "highres", PROP_BOOLEAN, PROP_NONE);
152         RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_HIGHRES);
153         RNA_def_property_ui_text(prop, "High res", "Show high resolution (using amplification).");
154         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
155
156         prop= RNA_def_property(srna, "noise_type", PROP_ENUM, PROP_NONE);
157         RNA_def_property_enum_sdna(prop, NULL, "noise");
158         RNA_def_property_enum_items(prop, prop_noise_type_items);
159         RNA_def_property_ui_text(prop, "Noise Method", "Noise method which is used for creating the high resolution");
160         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
161
162         prop= RNA_def_property(srna, "visibility", PROP_INT, PROP_NONE);
163         RNA_def_property_int_sdna(prop, NULL, "visibility");
164         RNA_def_property_range(prop, 1, 15);
165         RNA_def_property_ui_range(prop, 1, 15, 1, 0);
166         RNA_def_property_ui_text(prop, "Display", "How much of the resolution should be shown during preview (every 2nd, 3rd, etc).");
167         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Smoke_redraw");
168
169         prop= RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
170         RNA_def_property_float_sdna(prop, NULL, "alpha");
171         RNA_def_property_range(prop, -5.0, 5.0);
172         RNA_def_property_ui_range(prop, -5.0, 5.0, 0.02, 5);
173         RNA_def_property_ui_text(prop, "Gravity", "Higher value results in sinking smoke");
174         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, NULL);
175
176         prop= RNA_def_property(srna, "beta", PROP_FLOAT, PROP_NONE);
177         RNA_def_property_float_sdna(prop, NULL, "beta");
178         RNA_def_property_range(prop, -5.0, 5.0);
179         RNA_def_property_ui_range(prop, -5.0, 5.0, 0.02, 5);
180         RNA_def_property_ui_text(prop, "Heat", "Higher value results in faster rising smoke.");
181         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, NULL);
182
183         prop= RNA_def_property(srna, "coll_group", PROP_POINTER, PROP_NONE);
184         RNA_def_property_pointer_sdna(prop, NULL, "coll_group");
185         RNA_def_property_struct_type(prop, "Group");
186         RNA_def_property_flag(prop, PROP_EDITABLE);
187         RNA_def_property_ui_text(prop, "Collision Group", "Limit collisions to this group.");
188         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");
189
190         prop= RNA_def_property(srna, "fluid_group", PROP_POINTER, PROP_NONE);
191         RNA_def_property_pointer_sdna(prop, NULL, "fluid_group");
192         RNA_def_property_struct_type(prop, "Group");
193         RNA_def_property_flag(prop, PROP_EDITABLE);
194         RNA_def_property_ui_text(prop, "Fluid Group", "Limit fluid objects to this group.");
195         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");
196
197         prop= RNA_def_property(srna, "eff_group", PROP_POINTER, PROP_NONE);
198         RNA_def_property_pointer_sdna(prop, NULL, "eff_group");
199         RNA_def_property_struct_type(prop, "Group");
200         RNA_def_property_flag(prop, PROP_EDITABLE);
201         RNA_def_property_ui_text(prop, "Effector Group", "Limit effectors to this group.");
202         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");
203 }
204
205 static void rna_def_smoke_flow_settings(BlenderRNA *brna)
206 {
207         StructRNA *srna;
208         PropertyRNA *prop;
209
210         srna = RNA_def_struct(brna, "SmokeFlowSettings", NULL);
211         RNA_def_struct_ui_text(srna, "Flow Settings", "Smoke flow settings.");
212         RNA_def_struct_sdna(srna, "SmokeFlowSettings");
213         RNA_def_struct_path_func(srna, "rna_SmokeFlowSettings_path");
214
215         prop= RNA_def_property(srna, "density", PROP_FLOAT, PROP_NONE);
216         RNA_def_property_float_sdna(prop, NULL, "density");
217         RNA_def_property_range(prop, 0.001, 1);
218         RNA_def_property_ui_range(prop, 0.001, 1.0, 1.0, 4);
219         RNA_def_property_ui_text(prop, "Density", "");
220         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, NULL);
221
222         prop= RNA_def_property(srna, "temperature", PROP_FLOAT, PROP_NONE);
223         RNA_def_property_float_sdna(prop, NULL, "temp");
224         RNA_def_property_range(prop, -10, 10);
225         RNA_def_property_ui_range(prop, -10, 10, 1, 1);
226         RNA_def_property_ui_text(prop, "Temp. Diff.", "Temperature difference to ambientt temperature.");
227         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, NULL);
228         
229         prop= RNA_def_property(srna, "psys", PROP_POINTER, PROP_NONE);
230         RNA_def_property_pointer_sdna(prop, NULL, "psys");
231         RNA_def_property_struct_type(prop, "ParticleSystem");
232         RNA_def_property_flag(prop, PROP_EDITABLE);
233         RNA_def_property_ui_text(prop, "Particle Systems", "Particle systems emitted from the object.");
234         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");
235
236         prop= RNA_def_property(srna, "velocity", PROP_FLOAT, PROP_VECTOR);
237         RNA_def_property_float_sdna(prop, NULL, "velocity");
238         RNA_def_property_range(prop, -10, 10);
239         RNA_def_property_ui_range(prop, -10, 10, 1, 1);
240         RNA_def_property_ui_text(prop, "Velocity", "");
241         RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, NULL);
242
243 }
244
245 static void rna_def_smoke_coll_settings(BlenderRNA *brna)
246 {
247         StructRNA *srna;
248
249         srna = RNA_def_struct(brna, "SmokeCollSettings", NULL);
250         RNA_def_struct_ui_text(srna, "Collision Settings", "Smoke collision settings.");
251         RNA_def_struct_sdna(srna, "SmokeCollSettings");
252         RNA_def_struct_path_func(srna, "rna_SmokeCollSettings_path");
253 }
254
255 void RNA_def_smoke(BlenderRNA *brna)
256 {
257         rna_def_smoke_domain_settings(brna);
258         rna_def_smoke_flow_settings(brna);
259         rna_def_smoke_coll_settings(brna);
260 }
261
262 #endif
263