Add a gui control for setting omp threads in fluids
[blender-staging.git] / source / blender / makesrna / intern / rna_fluidsim.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): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_fluidsim.c
24  *  \ingroup RNA
25  */
26
27 #include <stdlib.h>
28
29 #include "DNA_object_fluidsim.h"
30
31 #include "BLI_utildefines.h"
32 #include "BLI_path_util.h"
33
34 #include "RNA_define.h"
35
36 #include "rna_internal.h"
37
38 #include "WM_api.h"
39 #include "WM_types.h"
40
41 #ifdef RNA_RUNTIME
42
43 #include "MEM_guardedalloc.h"
44
45 #include "DNA_scene_types.h"
46 #include "DNA_particle_types.h"
47
48 #include "BKE_depsgraph.h"
49 #include "BKE_fluidsim.h"
50 #include "BKE_global.h"
51 #include "BKE_main.h"
52 #include "BKE_modifier.h"
53 #include "BKE_particle.h"
54 #include "BKE_pointcache.h"
55
56 static StructRNA *rna_FluidSettings_refine(struct PointerRNA *ptr)
57 {
58         FluidsimSettings *fss = (FluidsimSettings *)ptr->data;
59
60         switch (fss->type) {
61                 case OB_FLUIDSIM_DOMAIN:
62                         return &RNA_DomainFluidSettings;
63                 case OB_FLUIDSIM_FLUID:
64                         return &RNA_FluidFluidSettings;
65                 case OB_FLUIDSIM_OBSTACLE:
66                         return &RNA_ObstacleFluidSettings;
67                 case OB_FLUIDSIM_INFLOW:
68                         return &RNA_InflowFluidSettings;
69                 case OB_FLUIDSIM_OUTFLOW:
70                         return &RNA_OutflowFluidSettings;
71                 case OB_FLUIDSIM_PARTICLE:
72                         return &RNA_ParticleFluidSettings;
73                 case OB_FLUIDSIM_CONTROL:
74                         return &RNA_ControlFluidSettings;
75                 default:
76                         return &RNA_FluidSettings;
77         }
78 }
79
80 static void rna_fluid_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
81 {
82         Object *ob = ptr->id.data;
83
84         DAG_id_tag_update(&ob->id, OB_RECALC_DATA);
85         WM_main_add_notifier(NC_OBJECT | ND_MODIFIER, ob);
86 }
87
88 static int fluidsim_find_lastframe(Object *ob, FluidsimSettings *fss)
89 {
90         char targetFileTest[FILE_MAX];
91         char targetFile[FILE_MAX];
92         int curFrame = 1;
93
94         BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_FINAL_OBJ_FNAME);
95         BLI_path_abs(targetFile, modifier_path_relbase(ob));
96
97         do {
98                 BLI_strncpy(targetFileTest, targetFile, sizeof(targetFileTest));
99                 BLI_path_frame(targetFileTest, curFrame++, 0);
100         } while (BLI_exists(targetFileTest));
101
102         return curFrame - 1;
103 }
104
105 static void rna_fluid_find_enframe(Main *bmain, Scene *scene, PointerRNA *ptr)
106 {
107         Object *ob = ptr->id.data;
108         FluidsimModifierData *fluidmd = (FluidsimModifierData *)modifiers_findByType(ob, eModifierType_Fluidsim);
109
110         if (fluidmd->fss->flag & OB_FLUIDSIM_REVERSE) {
111                 fluidmd->fss->lastgoodframe = fluidsim_find_lastframe(ob, fluidmd->fss);
112         }
113         else {
114                 fluidmd->fss->lastgoodframe = -1;
115         }
116         rna_fluid_update(bmain, scene, ptr);
117 }
118
119 static void rna_FluidSettings_update_type(Main *bmain, Scene *scene, PointerRNA *ptr)
120 {
121         Object *ob = (Object *)ptr->id.data;
122         FluidsimModifierData *fluidmd;
123         ParticleSystemModifierData *psmd;
124         ParticleSystem *psys;
125         ParticleSettings *part;
126         
127         fluidmd = (FluidsimModifierData *)modifiers_findByType(ob, eModifierType_Fluidsim);
128         fluidmd->fss->flag &= ~OB_FLUIDSIM_REVERSE; /* clear flag */
129
130         /* remove fluidsim particle system */
131         if (fluidmd->fss->type & OB_FLUIDSIM_PARTICLE) {
132                 for (psys = ob->particlesystem.first; psys; psys = psys->next)
133                         if (psys->part->type == PART_FLUID)
134                                 break;
135
136                 if (ob->type == OB_MESH && !psys) {
137                         /* add particle system */
138                         part = psys_new_settings("ParticleSettings", bmain);
139                         psys = MEM_callocN(sizeof(ParticleSystem), "particle_system");
140
141                         part->type = PART_FLUID;
142                         psys->part = part;
143                         psys->pointcache = BKE_ptcache_add(&psys->ptcaches);
144                         psys->flag |= PSYS_ENABLED;
145                         BLI_strncpy(psys->name, "FluidParticles", sizeof(psys->name));
146                         BLI_addtail(&ob->particlesystem, psys);
147
148                         /* add modifier */
149                         psmd = (ParticleSystemModifierData *)modifier_new(eModifierType_ParticleSystem);
150                         BLI_strncpy(psmd->modifier.name, "FluidParticleSystem", sizeof(psmd->modifier.name));
151                         psmd->psys = psys;
152                         BLI_addtail(&ob->modifiers, psmd);
153                         modifier_unique_name(&ob->modifiers, (ModifierData *)psmd);
154                 }
155         }
156         else {
157                 for (psys = ob->particlesystem.first; psys; psys = psys->next) {
158                         if (psys->part->type == PART_FLUID) {
159                                 /* clear modifier */
160                                 psmd = psys_get_modifier(ob, psys);
161                                 BLI_remlink(&ob->modifiers, psmd);
162                                 modifier_free((ModifierData *)psmd);
163
164                                 /* clear particle system */
165                                 BLI_remlink(&ob->particlesystem, psys);
166                                 psys_free(ob, psys);
167                         }
168                 }
169         }
170
171         rna_fluid_update(bmain, scene, ptr);
172 }
173
174 static void rna_DomainFluidSettings_memory_estimate_get(PointerRNA *ptr, char *value)
175 {
176 #ifndef WITH_MOD_FLUID
177         (void)ptr;
178         value[0] = '\0';
179 #else
180         Object *ob = (Object *)ptr->id.data;
181         FluidsimSettings *fss = (FluidsimSettings *)ptr->data;
182
183         fluid_estimate_memory(ob, fss, value);
184 #endif
185 }
186
187 static int rna_DomainFluidSettings_memory_estimate_length(PointerRNA *UNUSED(ptr))
188 {
189 #ifndef WITH_MOD_FLUID
190         return 0;
191 #else
192         return 31;
193 #endif
194 }
195
196 static char *rna_FluidSettings_path(PointerRNA *ptr)
197 {
198         FluidsimSettings *fss = (FluidsimSettings *)ptr->data;
199         ModifierData *md = (ModifierData *)fss->fmd;
200
201         return BLI_sprintfN("modifiers[\"%s\"].settings", md->name);
202 }
203
204 static void rna_FluidMeshVertex_data_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
205 {
206         FluidsimSettings *fss = (FluidsimSettings *)ptr->data;
207         rna_iterator_array_begin(iter, fss->meshVelocities, sizeof(float) * 3, fss->totvert, 0, NULL);
208 }
209
210 static int rna_FluidMeshVertex_data_length(PointerRNA *ptr)
211 {
212         FluidsimSettings *fss = (FluidsimSettings *)ptr->data;
213         return fss->totvert;
214 }
215
216 #else
217
218 static void rna_def_fluidsim_slip(StructRNA *srna)
219 {
220         PropertyRNA *prop;
221
222         static EnumPropertyItem slip_items[] = {
223                 {OB_FSBND_NOSLIP, "NOSLIP", 0, "No Slip",
224                                   "Obstacle causes zero normal and tangential velocity (=sticky), default for all "
225                                   "(only option for moving objects)"},
226                 {OB_FSBND_PARTSLIP, "PARTIALSLIP", 0, "Partial Slip",
227                                     "Mix between no-slip and free-slip (non moving objects only!)"},
228                 {OB_FSBND_FREESLIP, "FREESLIP", 0, "Free Slip",
229                                     "Obstacle only causes zero normal velocity (=not sticky, non moving objects only!)"},
230                 {0, NULL, 0, NULL, NULL}
231         };
232
233         prop = RNA_def_property(srna, "slip_type", PROP_ENUM, PROP_NONE);
234         RNA_def_property_enum_bitflag_sdna(prop, NULL, "typeFlags");
235         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
236         RNA_def_property_enum_items(prop, slip_items);
237         RNA_def_property_ui_text(prop, "Slip Type", "");
238
239         prop = RNA_def_property(srna, "partial_slip_factor", PROP_FLOAT, PROP_NONE);
240         RNA_def_property_float_sdna(prop, NULL, "partSlipValue");
241         RNA_def_property_range(prop, 0.0f, 1.0f);
242         RNA_def_property_ui_text(prop, "Partial Slip Amount",
243                                  "Amount of mixing between no- and free-slip, 0 is no slip and 1 is free slip");
244 }
245
246 static void rna_def_fluid_mesh_vertices(BlenderRNA *brna)
247 {
248         StructRNA *srna;
249         PropertyRNA *prop;
250         
251         srna = RNA_def_struct(brna, "FluidMeshVertex", NULL);
252         RNA_def_struct_sdna(srna, "FluidVertexVelocity");
253         RNA_def_struct_ui_text(srna, "Fluid Mesh Vertex", "Vertex of a simulated fluid mesh");
254         RNA_def_struct_ui_icon(srna, ICON_VERTEXSEL);
255
256         prop = RNA_def_property(srna, "velocity", PROP_FLOAT, PROP_VELOCITY);
257         RNA_def_property_array(prop, 3);
258         RNA_def_property_float_sdna(prop, NULL, "vel");
259         RNA_def_property_ui_text(prop, "Velocity", "");
260         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
261 }
262
263
264 static void rna_def_fluidsim_domain(BlenderRNA *brna)
265 {
266         StructRNA *srna;
267         PropertyRNA *prop;
268
269         static EnumPropertyItem quality_items[] = {
270                 {OB_FSDOM_GEOM, "GEOMETRY", 0, "Geometry", "Display geometry"},
271                 {OB_FSDOM_PREVIEW, "PREVIEW", 0, "Preview", "Display preview quality results"},
272                 {OB_FSDOM_FINAL, "FINAL", 0, "Final", "Display final quality results"},
273                 {0, NULL, 0, NULL, NULL}
274         };
275
276         srna = RNA_def_struct(brna, "DomainFluidSettings", "FluidSettings");
277         RNA_def_struct_sdna(srna, "FluidsimSettings");
278         RNA_def_struct_ui_text(srna, "Domain Fluid Simulation Settings",
279                                "Fluid simulation settings for the domain of a fluid simulation");
280
281         /* standard settings */
282
283         prop = RNA_def_property(srna, "threads", PROP_INT, PROP_NONE);
284         RNA_def_property_int_sdna(prop, NULL, "threads");
285         RNA_def_property_range(prop, 1, 32);
286         RNA_def_property_ui_text(prop, "Simulation Threads", "Threads used to calculate the simulation");
287         
288         prop = RNA_def_property(srna, "resolution", PROP_INT, PROP_NONE);
289         RNA_def_property_int_sdna(prop, NULL, "resolutionxyz");
290         RNA_def_property_range(prop, 1, 1024);
291         RNA_def_property_ui_text(prop, "Resolution", "Domain resolution in X,Y and Z direction");
292         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
293
294         prop = RNA_def_property(srna, "preview_resolution", PROP_INT, PROP_NONE);
295         RNA_def_property_int_sdna(prop, NULL, "previewresxyz");
296         RNA_def_property_range(prop, 1, 100);
297         RNA_def_property_ui_text(prop, "Preview Resolution", "Preview resolution in X,Y and Z direction");
298         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
299
300         prop = RNA_def_property(srna, "viewport_display_mode", PROP_ENUM, PROP_NONE);
301         RNA_def_property_enum_sdna(prop, NULL, "guiDisplayMode");
302         RNA_def_property_enum_items(prop, quality_items);
303         RNA_def_property_ui_text(prop, "Viewport Display Mode", "How to display the mesh in the viewport");
304         RNA_def_property_update(prop, 0, "rna_fluid_update");
305
306         prop = RNA_def_property(srna, "render_display_mode", PROP_ENUM, PROP_NONE);
307         RNA_def_property_enum_sdna(prop, NULL, "renderDisplayMode");
308         RNA_def_property_enum_items(prop, quality_items);
309         RNA_def_property_ui_text(prop, "Render Display Mode", "How to display the mesh for rendering");
310
311         prop = RNA_def_property(srna, "use_reverse_frames", PROP_BOOLEAN, PROP_NONE);
312         RNA_def_property_boolean_sdna(prop, NULL, "flag", OB_FLUIDSIM_REVERSE);
313         RNA_def_property_ui_text(prop, "Reverse Frames", "Reverse fluid frames");
314         RNA_def_property_update(prop, 0, "rna_fluid_find_enframe");
315
316         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
317         RNA_def_property_string_maxlength(prop, FILE_MAX);
318         RNA_def_property_string_sdna(prop, NULL, "surfdataPath");
319         RNA_def_property_ui_text(prop, "Path",
320                                  "Directory (and/or filename prefix) to store baked fluid simulation files in");
321         RNA_def_property_update(prop, 0, "rna_fluid_update");
322
323         prop = RNA_def_property(srna, "memory_estimate", PROP_STRING, PROP_NONE);
324         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
325         RNA_def_property_string_funcs(prop, "rna_DomainFluidSettings_memory_estimate_get",
326                                       "rna_DomainFluidSettings_memory_estimate_length", NULL);
327         RNA_def_property_ui_text(prop, "Memory Estimate", "Estimated amount of memory needed for baking the domain");
328
329         /* advanced settings */
330         prop = RNA_def_property(srna, "gravity", PROP_FLOAT, PROP_ACCELERATION);
331         RNA_def_property_float_sdna(prop, NULL, "grav");
332         RNA_def_property_array(prop, 3);
333         RNA_def_property_range(prop, -1000.1, 1000.1);
334         RNA_def_property_ui_text(prop, "Gravity", "Gravity in X, Y and Z direction");
335         
336         prop = RNA_def_property(srna, "use_time_override", PROP_BOOLEAN, PROP_NONE);
337         RNA_def_property_boolean_sdna(prop, NULL, "flag", OB_FLUIDSIM_OVERRIDE_TIME);
338         RNA_def_property_ui_text(prop, "Override Time",
339                                  "Use a custom start and end time (in seconds) instead of the scene's timeline");
340         
341         prop = RNA_def_property(srna, "start_time", PROP_FLOAT, PROP_TIME);
342         RNA_def_property_float_sdna(prop, NULL, "animStart");
343         RNA_def_property_range(prop, 0, 100);
344         RNA_def_property_ui_text(prop, "Start Time", "Simulation time of the first blender frame (in seconds)");
345         
346         prop = RNA_def_property(srna, "end_time", PROP_FLOAT, PROP_TIME);
347         RNA_def_property_float_sdna(prop, NULL, "animEnd");
348         RNA_def_property_range(prop, 0, 100);
349         RNA_def_property_ui_text(prop, "End Time", "Simulation time of the last blender frame (in seconds)");
350         
351         prop = RNA_def_property(srna, "frame_offset", PROP_INT, PROP_NONE);
352         RNA_def_property_int_sdna(prop, NULL, "frameOffset");
353         RNA_def_property_ui_text(prop, "Cache Offset", "Offset when reading baked cache");
354         RNA_def_property_update(prop, NC_OBJECT, "rna_fluid_update");
355         
356         prop = RNA_def_property(srna, "simulation_scale", PROP_FLOAT, PROP_NONE);
357         RNA_def_property_float_sdna(prop, NULL, "realsize");
358         RNA_def_property_range(prop, 0.001, 10);
359         RNA_def_property_ui_text(prop, "Real World Size", "Size of the simulation domain in meters");
360         
361         prop = RNA_def_property(srna, "simulation_rate", PROP_FLOAT, PROP_NONE);
362         RNA_def_property_float_sdna(prop, NULL, "animRate");
363         RNA_def_property_range(prop, 0.0, 100.0);
364         RNA_def_property_ui_text(prop, "Simulation Speed", "Fluid motion rate (0 = stationary, 1 = normal speed)");
365
366         prop = RNA_def_property(srna, "viscosity_base", PROP_FLOAT, PROP_NONE);
367         RNA_def_property_float_sdna(prop, NULL, "viscosityValue");
368         RNA_def_property_range(prop, 0, 10);
369         RNA_def_property_ui_text(prop, "Viscosity Base",
370                                  "Viscosity setting: value that is multiplied by 10 to the power of (exponent*-1)");
371
372         prop = RNA_def_property(srna, "viscosity_exponent", PROP_INT, PROP_NONE);
373         RNA_def_property_int_sdna(prop, NULL, "viscosityExponent");
374         RNA_def_property_range(prop, 0, 10);
375         RNA_def_property_ui_text(prop, "Viscosity Exponent",
376                                  "Negative exponent for the viscosity value (to simplify entering small values "
377                                  "e.g. 5*10^-6)");
378
379         prop = RNA_def_property(srna, "grid_levels", PROP_INT, PROP_NONE);
380         RNA_def_property_int_sdna(prop, NULL, "maxRefine");
381         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
382         RNA_def_property_range(prop, -1, 4);
383         RNA_def_property_ui_text(prop, "Grid Levels", "Number of coarsened grids to use (-1 for automatic)");
384
385         prop = RNA_def_property(srna, "compressibility", PROP_FLOAT, PROP_NONE);
386         RNA_def_property_float_sdna(prop, NULL, "gstar");
387         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
388         RNA_def_property_range(prop, 0.001, 0.1);
389         RNA_def_property_ui_text(prop, "Compressibility",
390                                  "Allowed compressibility due to gravitational force for standing fluid "
391                                  "(directly affects simulation step size)");
392
393         /* domain boundary settings */
394
395         rna_def_fluidsim_slip(srna);
396
397         prop = RNA_def_property(srna, "surface_smooth", PROP_FLOAT, PROP_NONE);
398         RNA_def_property_float_sdna(prop, NULL, "surfaceSmoothing");
399         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
400         RNA_def_property_range(prop, 0.0, 5.0);
401         RNA_def_property_ui_text(prop, "Surface Smoothing",
402                                  "Amount of surface smoothing (a value of 0 is off, 1 is normal smoothing and "
403                                  "more than 1 is extra smoothing)");
404
405         prop = RNA_def_property(srna, "surface_subdivisions", PROP_INT, PROP_NONE);
406         RNA_def_property_int_sdna(prop, NULL, "surfaceSubdivs");
407         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
408         RNA_def_property_range(prop, 0, 5);
409         RNA_def_property_ui_text(prop, "Surface Subdivisions",
410                                  "Number of isosurface subdivisions (this is necessary for the inclusion of particles "
411                                  "into the surface generation - WARNING: can lead to longer computation times !)");
412
413         prop = RNA_def_property(srna, "use_speed_vectors", PROP_BOOLEAN, PROP_NONE);
414         RNA_def_property_boolean_negative_sdna(prop, NULL, "domainNovecgen", 0);
415         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
416         RNA_def_property_ui_text(prop, "Generate Speed Vectors", "Generate speed vectors for vector blur");
417
418         /* no collision object surface */
419         prop = RNA_def_property(srna, "surface_noobs", PROP_BOOLEAN, PROP_NONE);
420         RNA_def_property_boolean_sdna(prop, NULL, "typeFlags", OB_FSSG_NOOBS);
421         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
422         RNA_def_property_ui_text(prop, "Remove air bubbles",
423                                  "Removes the air gap between fluid surface and obstacles - WARNING: Can result "
424                                  "in a dissolving surface in other areas");
425
426         /* particles */
427
428         prop = RNA_def_property(srna, "tracer_particles", PROP_INT, PROP_NONE);
429         RNA_def_property_int_sdna(prop, NULL, "generateTracers");
430         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
431         RNA_def_property_range(prop, 0, 10000);
432         RNA_def_property_ui_text(prop, "Tracer Particles", "Number of tracer particles to generate");
433
434         prop = RNA_def_property(srna, "generate_particles", PROP_FLOAT, PROP_NONE);
435         RNA_def_property_float_sdna(prop, NULL, "generateParticles");
436         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
437         RNA_def_property_range(prop, 0.0, 10.0);
438         RNA_def_property_ui_text(prop, "Generate Particles", "Amount of particles to generate (0=off, 1=normal, >1=more)");
439         
440         /* simulated fluid mesh data */
441         prop = RNA_def_property(srna, "fluid_mesh_vertices", PROP_COLLECTION, PROP_NONE);
442         RNA_def_property_struct_type(prop, "FluidMeshVertex");
443         RNA_def_property_ui_text(prop, "Fluid Mesh Vertices", "Vertices of the fluid mesh generated by simulation");
444         RNA_def_property_collection_funcs(prop, "rna_FluidMeshVertex_data_begin", "rna_iterator_array_next",
445                                           "rna_iterator_array_end", "rna_iterator_array_get",
446                                           "rna_FluidMeshVertex_data_length", NULL, NULL, NULL);
447         rna_def_fluid_mesh_vertices(brna);
448 }
449
450 static void rna_def_fluidsim_volume(StructRNA *srna)
451 {
452         PropertyRNA *prop;
453
454         static EnumPropertyItem volume_type_items[] = {
455                 {1, "VOLUME", 0, "Volume", "Use only the inner volume of the mesh"},
456                 {2, "SHELL", 0, "Shell", "Use only the outer shell of the mesh"},
457                 {3, "BOTH", 0, "Both", "Use both the inner volume and the outer shell of the mesh"},
458                 {0, NULL, 0, NULL, NULL}
459         };
460
461         prop = RNA_def_property(srna, "volume_initialization", PROP_ENUM, PROP_NONE);
462         RNA_def_property_enum_bitflag_sdna(prop, NULL, "volumeInitType");
463         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
464         RNA_def_property_enum_items(prop, volume_type_items);
465         RNA_def_property_ui_text(prop, "Volume Initialization", "Volume initialization type");
466
467         prop = RNA_def_property(srna, "use_animated_mesh", PROP_BOOLEAN, PROP_NONE);
468         RNA_def_property_boolean_sdna(prop, NULL, "domainNovecgen", 0);
469         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
470         RNA_def_property_ui_text(prop, "Export Animated Mesh",
471                                  "Export this mesh as an animated one (slower and enforces No Slip, only use if really "
472                                  "necessary [e.g. armatures or parented objects], animated pos/rot/scale F-Curves "
473                                  "do not require it)");
474 }
475
476 static void rna_def_fluidsim_active(StructRNA *srna)
477 {
478         PropertyRNA *prop;
479         
480         prop = RNA_def_property(srna, "use", PROP_BOOLEAN, PROP_NONE);
481         RNA_def_property_boolean_sdna(prop, NULL, "flag", OB_FLUIDSIM_ACTIVE);
482         RNA_def_property_ui_text(prop, "Enabled", "Object contributes to the fluid simulation");
483 }
484
485 static void rna_def_fluidsim_fluid(BlenderRNA *brna)
486 {
487         StructRNA *srna;
488         PropertyRNA *prop;
489
490         srna = RNA_def_struct(brna, "FluidFluidSettings", "FluidSettings");
491         RNA_def_struct_sdna(srna, "FluidsimSettings");
492         RNA_def_struct_ui_text(srna, "Fluid Fluid Simulation Settings",
493                                "Fluid simulation settings for the fluid in the simulation");
494
495         rna_def_fluidsim_active(srna);
496         rna_def_fluidsim_volume(srna);
497         
498         prop = RNA_def_property(srna, "initial_velocity", PROP_FLOAT, PROP_VELOCITY);
499         RNA_def_property_float_sdna(prop, NULL, "iniVelx");
500         RNA_def_property_array(prop, 3);
501         RNA_def_property_range(prop, -1000.1, 1000.1);
502         RNA_def_property_ui_text(prop, "Initial Velocity", "Initial velocity of fluid");
503 }
504
505 static void rna_def_fluidsim_obstacle(BlenderRNA *brna)
506 {
507         StructRNA *srna;
508         PropertyRNA *prop;
509
510         srna = RNA_def_struct(brna, "ObstacleFluidSettings", "FluidSettings");
511         RNA_def_struct_sdna(srna, "FluidsimSettings");
512         RNA_def_struct_ui_text(srna, "Obstacle Fluid Simulation Settings",
513                                "Fluid simulation settings for obstacles in the simulation");
514
515         rna_def_fluidsim_active(srna);
516         rna_def_fluidsim_volume(srna);
517         rna_def_fluidsim_slip(srna);
518
519         prop = RNA_def_property(srna, "impact_factor", PROP_FLOAT, PROP_NONE);
520         RNA_def_property_float_sdna(prop, NULL, "surfaceSmoothing");
521         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
522         RNA_def_property_range(prop, -2.0, 10.0);
523         RNA_def_property_ui_text(prop, "Impact Factor",
524                                  "This is an unphysical value for moving objects - it controls the impact an obstacle "
525                                  "has on the fluid, =0 behaves a bit like outflow (deleting fluid), =1 is default, "
526                                  "while >1 results in high forces (can be used to tweak total mass)");
527 }
528
529 static void rna_def_fluidsim_inflow(BlenderRNA *brna)
530 {
531         StructRNA *srna;
532         PropertyRNA *prop;
533
534         srna = RNA_def_struct(brna, "InflowFluidSettings", "FluidSettings");
535         RNA_def_struct_sdna(srna, "FluidsimSettings");
536         RNA_def_struct_ui_text(srna, "Inflow Fluid Simulation Settings",
537                                "Fluid simulation settings for objects adding fluids in the simulation");
538
539         rna_def_fluidsim_active(srna);
540         rna_def_fluidsim_volume(srna);
541
542         prop = RNA_def_property(srna, "inflow_velocity", PROP_FLOAT, PROP_VELOCITY);
543         RNA_def_property_float_sdna(prop, NULL, "iniVelx");
544         RNA_def_property_array(prop, 3);
545         RNA_def_property_range(prop, -1000.1, 1000.1);
546         RNA_def_property_ui_text(prop, "Inflow Velocity", "Initial velocity of fluid");
547
548         prop = RNA_def_property(srna, "use_local_coords", PROP_BOOLEAN, PROP_NONE);
549         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
550         RNA_def_property_boolean_sdna(prop, NULL, "typeFlags", OB_FSINFLOW_LOCALCOORD);
551         RNA_def_property_ui_text(prop, "Local Coordinates",
552                                  "Use local coordinates for inflow (e.g. for rotating objects)");
553 }
554
555 static void rna_def_fluidsim_outflow(BlenderRNA *brna)
556 {
557         StructRNA *srna;
558
559         srna = RNA_def_struct(brna, "OutflowFluidSettings", "FluidSettings");
560         RNA_def_struct_sdna(srna, "FluidsimSettings");
561         RNA_def_struct_ui_text(srna, "Outflow Fluid Simulation Settings",
562                                "Fluid simulation settings for objects removing fluids from the simulation");
563
564         rna_def_fluidsim_active(srna);
565         rna_def_fluidsim_volume(srna);
566 }
567
568 static void rna_def_fluidsim_particle(BlenderRNA *brna)
569 {
570         StructRNA *srna;
571         PropertyRNA *prop;
572
573         srna = RNA_def_struct(brna, "ParticleFluidSettings", "FluidSettings");
574         RNA_def_struct_sdna(srna, "FluidsimSettings");
575         RNA_def_struct_ui_text(srna, "Particle Fluid Simulation Settings",
576                                "Fluid simulation settings for objects storing fluid particles generated"
577                                " by the simulation");
578
579         prop = RNA_def_property(srna, "use_drops", PROP_BOOLEAN, PROP_NONE);
580         RNA_def_property_boolean_sdna(prop, NULL, "typeFlags", OB_FSPART_DROP);
581         RNA_def_property_ui_text(prop, "Drops", "Show drop particles");
582
583         prop = RNA_def_property(srna, "use_floats", PROP_BOOLEAN, PROP_NONE);
584         RNA_def_property_boolean_sdna(prop, NULL, "typeFlags", OB_FSPART_FLOAT);
585         RNA_def_property_ui_text(prop, "Floats", "Show floating foam particles");
586
587         prop = RNA_def_property(srna, "show_tracer", PROP_BOOLEAN, PROP_NONE);
588         RNA_def_property_boolean_sdna(prop, NULL, "typeFlags", OB_FSPART_TRACER);
589         RNA_def_property_ui_text(prop, "Tracer", "Show tracer particles");
590
591         prop = RNA_def_property(srna, "particle_influence", PROP_FLOAT, PROP_NONE);
592         RNA_def_property_float_sdna(prop, NULL, "particleInfSize");
593         RNA_def_property_range(prop, 0.0, 2.0);
594         RNA_def_property_ui_text(prop, "Particle Influence",
595                                  "Amount of particle size scaling: 0=off (all same size), 1=full (range 0.2-2.0), "
596                                  ">1=stronger");
597
598         prop = RNA_def_property(srna, "alpha_influence", PROP_FLOAT, PROP_NONE);
599         RNA_def_property_float_sdna(prop, NULL, "particleInfAlpha");
600         RNA_def_property_range(prop, 0.0, 2.0);
601         RNA_def_property_ui_text(prop, "Alpha Influence",
602                                  "Amount of particle alpha change, inverse of size influence: 0=off (all same alpha), "
603                                  "1=full (larger particles get lower alphas, smaller ones higher values)");
604
605         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
606         RNA_def_property_string_maxlength(prop, FILE_MAX);
607         RNA_def_property_string_sdna(prop, NULL, "surfdataPath");
608         RNA_def_property_ui_text(prop, "Path", "Directory (and/or filename prefix) to store and load particles from");
609         RNA_def_property_update(prop, 0, "rna_fluid_update");
610 }
611
612 static void rna_def_fluidsim_control(BlenderRNA *brna)
613 {
614         StructRNA *srna;
615         PropertyRNA *prop;
616
617         srna = RNA_def_struct(brna, "ControlFluidSettings", "FluidSettings");
618         RNA_def_struct_sdna(srna, "FluidsimSettings");
619         RNA_def_struct_ui_text(srna, "Control Fluid Simulation Settings",
620                                "Fluid simulation settings for objects controlling the motion of fluid in the simulation");
621
622         rna_def_fluidsim_active(srna);
623         
624         prop = RNA_def_property(srna, "start_time", PROP_FLOAT, PROP_TIME);
625         RNA_def_property_float_sdna(prop, NULL, "cpsTimeStart");
626         RNA_def_property_range(prop, 0.0, 100.0);
627         RNA_def_property_ui_text(prop, "Start Time", "Time when the control particles are activated");
628         
629         prop = RNA_def_property(srna, "end_time", PROP_FLOAT, PROP_TIME);
630         RNA_def_property_float_sdna(prop, NULL, "cpsTimeEnd");
631         RNA_def_property_range(prop, 0.0, 100.0);
632         RNA_def_property_ui_text(prop, "End Time", "Time when the control particles are deactivated");
633
634         prop = RNA_def_property(srna, "attraction_strength", PROP_FLOAT, PROP_NONE);
635         RNA_def_property_float_sdna(prop, NULL, "attractforceStrength");
636         RNA_def_property_range(prop, -10.0, 10.0);
637         RNA_def_property_ui_text(prop, "Attraction Strength",
638                                  "Force strength for directional attraction towards the control object");
639
640         prop = RNA_def_property(srna, "attraction_radius", PROP_FLOAT, PROP_NONE);
641         RNA_def_property_float_sdna(prop, NULL, "attractforceRadius");
642         RNA_def_property_range(prop, 0.0, 10.0);
643         RNA_def_property_ui_text(prop, "Attraction Radius", "Force field radius around the control object");
644         
645         prop = RNA_def_property(srna, "velocity_strength", PROP_FLOAT, PROP_NONE);
646         RNA_def_property_float_sdna(prop, NULL, "velocityforceStrength");
647         RNA_def_property_range(prop, 0.0, 10.0);
648         RNA_def_property_ui_text(prop, "Velocity Strength",
649                                  "Force strength of how much of the control object's velocity is influencing the "
650                                  "fluid velocity");
651
652         prop = RNA_def_property(srna, "velocity_radius", PROP_FLOAT, PROP_NONE);
653         RNA_def_property_float_sdna(prop, NULL, "velocityforceRadius");
654         RNA_def_property_range(prop, 0.0, 10.0);
655         RNA_def_property_ui_text(prop, "Velocity Radius", "Force field radius around the control object");
656
657         prop = RNA_def_property(srna, "quality", PROP_FLOAT, PROP_NONE);
658         RNA_def_property_float_sdna(prop, NULL, "cpsQuality");
659         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
660         RNA_def_property_range(prop, 5.0, 100.0);
661         RNA_def_property_ui_text(prop, "Quality",
662                                  "Quality which is used for object sampling (higher = better but slower)");
663
664         prop = RNA_def_property(srna, "use_reverse_frames", PROP_BOOLEAN, PROP_NONE);
665         RNA_def_property_boolean_sdna(prop, NULL, "flag", OB_FLUIDSIM_REVERSE);
666         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
667         RNA_def_property_ui_text(prop, "Reverse Frames", "Reverse control object movement");
668         RNA_def_property_update(prop, 0, "rna_fluid_find_enframe");
669 }
670
671 void RNA_def_fluidsim(BlenderRNA *brna)
672 {
673         StructRNA *srna;
674         PropertyRNA *prop;
675
676         static EnumPropertyItem prop_fluid_type_items[] = {
677                 {OB_FLUIDSIM_ENABLE, "NONE", 0, "None", ""},
678                 {OB_FLUIDSIM_DOMAIN, "DOMAIN", 0, "Domain",
679                                      "Bounding box of this object represents the computational domain of the "
680                                      "fluid simulation"},
681                 {OB_FLUIDSIM_FLUID, "FLUID", 0, "Fluid", "Object represents a volume of fluid in the simulation"},
682                 {OB_FLUIDSIM_OBSTACLE, "OBSTACLE", 0, "Obstacle", "Object is a fixed obstacle"},
683                 {OB_FLUIDSIM_INFLOW, "INFLOW", 0, "Inflow", "Object adds fluid to the simulation"},
684                 {OB_FLUIDSIM_OUTFLOW, "OUTFLOW", 0, "Outflow", "Object removes fluid from the simulation"},
685                 {OB_FLUIDSIM_PARTICLE, "PARTICLE", 0, "Particle",
686                                        "Object is made a particle system to display particles generated by a "
687                                        "fluidsim domain object"},
688                 {OB_FLUIDSIM_CONTROL, "CONTROL", 0, "Control",
689                  "Object is made a fluid control mesh, which influences the fluid"},
690                 {0, NULL, 0, NULL, NULL}
691         };
692
693
694         srna = RNA_def_struct(brna, "FluidSettings", NULL);
695         RNA_def_struct_sdna(srna, "FluidsimSettings");
696         RNA_def_struct_refine_func(srna, "rna_FluidSettings_refine");
697         RNA_def_struct_path_func(srna, "rna_FluidSettings_path");
698         RNA_def_struct_ui_text(srna, "Fluid Simulation Settings",
699                                "Fluid simulation settings for an object taking part in the simulation");
700
701         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
702         RNA_def_property_enum_bitflag_sdna(prop, NULL, "type");
703         RNA_def_property_enum_items(prop, prop_fluid_type_items);
704         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
705         RNA_def_property_ui_text(prop, "Type", "Type of participation in the fluid simulation");
706         RNA_def_property_update(prop, 0, "rna_FluidSettings_update_type");
707
708         /*prop = RNA_def_property(srna, "ipo", PROP_POINTER, PROP_NONE); */
709         /*RNA_def_property_ui_text(prop, "IPO Curves", "IPO curves used by fluid simulation settings"); */
710
711         /* types */
712
713         rna_def_fluidsim_domain(brna);
714         rna_def_fluidsim_fluid(brna);
715         rna_def_fluidsim_obstacle(brna);
716         rna_def_fluidsim_inflow(brna);
717         rna_def_fluidsim_outflow(brna);
718         rna_def_fluidsim_particle(brna);
719         rna_def_fluidsim_control(brna);
720 }
721
722
723 #endif