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