b3cd5dc5464196c3b6248392372ca8af6e6cb679
[blender-staging.git] / release / scripts / startup / bl_ui / properties_physics_fluid.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20 import bpy
21 from bpy.types import Panel, Menu
22 from bpy.app.translations import pgettext_iface as iface_
23
24
25 class FLUID_MT_presets(Menu):
26     bl_label = "Fluid Presets"
27     preset_subdir = "fluid"
28     preset_operator = "script.execute_preset"
29     draw = Menu.draw_preset
30
31
32 class PhysicButtonsPanel():
33     bl_space_type = 'PROPERTIES'
34     bl_region_type = 'WINDOW'
35     bl_context = "physics"
36
37     @classmethod
38     def poll(cls, context):
39         ob = context.object
40         rd = context.scene.render
41         return (ob and ob.type == 'MESH') and (not rd.use_game_engine) and (context.fluid)
42
43
44 class PHYSICS_PT_fluid(PhysicButtonsPanel, Panel):
45     bl_label = "Fluid"
46
47     def draw(self, context):
48         layout = self.layout
49
50         md = context.fluid
51         fluid = md.settings
52
53         col = layout.column()
54         if not bpy.app.build_options.mod_fluid:
55             col.label("Built without fluids")
56             return
57
58         col.prop(fluid, "type")
59         if fluid.type not in {'NONE', 'DOMAIN', 'PARTICLE', 'FLUID', 'OBSTACLE'}:
60             col.prop(fluid, "use")
61
62         layout = layout.column()
63         if fluid.type not in {'NONE', 'DOMAIN', 'PARTICLE', 'FLUID', 'OBSTACLE'}:
64             layout.active = fluid.use
65
66         if fluid.type == 'DOMAIN':
67             # odd formatting here so translation script can extract string
68             layout.operator("fluid.bake", text=iface_("Bake (Req. Memory: %s)") % fluid.memory_estimate,
69                             translate=False, icon='MOD_FLUIDSIM')
70             split = layout.split()
71
72             col = split.column()
73             col.label(text="Resolution:")
74             col.prop(fluid, "resolution", text="Final")
75             col.label(text="Render Display:")
76             col.prop(fluid, "render_display_mode", text="")
77
78             col = split.column()
79             col.label()
80             col.prop(fluid, "preview_resolution", text="Preview")
81             col.label(text="Viewport Display:")
82             col.prop(fluid, "viewport_display_mode", text="")
83
84             split = layout.split()
85
86             col = split.column()
87             col.label(text="Time:")
88             sub = col.column(align=True)
89             sub.prop(fluid, "start_time", text="Start")
90             sub.prop(fluid, "end_time", text="End")
91             col.prop(fluid, "simulation_rate", text="Speed")
92
93             col = split.column()
94             col.label()
95             sub = col.column(align=True)
96             sub.prop(fluid, "use_speed_vectors")
97             sub.prop(fluid, "use_reverse_frames")
98             col.prop(fluid, "frame_offset", text="Offset")
99
100             layout.prop(fluid, "filepath", text="")
101
102         elif fluid.type == 'FLUID':
103             split = layout.split()
104
105             col = split.column()
106             col.label(text="Volume Initialization:")
107             col.prop(fluid, "volume_initialization", text="")
108             col.prop(fluid, "use_animated_mesh")
109
110             col = split.column()
111             col.label(text="Initial Velocity:")
112             col.prop(fluid, "initial_velocity", text="")
113
114         elif fluid.type == 'OBSTACLE':
115             split = layout.split()
116
117             col = split.column()
118             col.label(text="Volume Initialization:")
119             col.prop(fluid, "volume_initialization", text="")
120             col.prop(fluid, "use_animated_mesh")
121
122             col = split.column()
123             subsplit = col.split()
124             subcol = subsplit.column()
125             if fluid.use_animated_mesh:
126                 subcol.enabled = False
127             subcol.label(text="Slip Type:")
128             subcol.prop(fluid, "slip_type", text="")
129             if fluid.slip_type == 'PARTIALSLIP':
130                 subcol.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
131
132             col.label(text="Impact:")
133             col.prop(fluid, "impact_factor", text="Factor")
134
135         elif fluid.type == 'INFLOW':
136             split = layout.split()
137
138             col = split.column()
139             col.label(text="Volume Initialization:")
140             col.prop(fluid, "volume_initialization", text="")
141             col.prop(fluid, "use_animated_mesh")
142             row = col.row()
143             row.active = not fluid.use_animated_mesh
144             row.prop(fluid, "use_local_coords")
145
146             col = split.column()
147             col.label(text="Inflow Velocity:")
148             col.prop(fluid, "inflow_velocity", text="")
149
150         elif fluid.type == 'OUTFLOW':
151             col = layout.column()
152             col.label(text="Volume Initialization:")
153             col.prop(fluid, "volume_initialization", text="")
154             col.prop(fluid, "use_animated_mesh")
155
156         elif fluid.type == 'PARTICLE':
157             split = layout.split()
158
159             col = split.column()
160             col.label(text="Influence:")
161             col.prop(fluid, "particle_influence", text="Size")
162             col.prop(fluid, "alpha_influence", text="Alpha")
163
164             col = split.column()
165             col.label(text="Type:")
166             col.prop(fluid, "use_drops")
167             col.prop(fluid, "use_floats")
168             col.prop(fluid, "show_tracer")
169
170             layout.prop(fluid, "filepath", text="")
171
172         elif fluid.type == 'CONTROL':
173             split = layout.split()
174
175             col = split.column()
176             col.label(text="")
177             col.prop(fluid, "quality", slider=True)
178             col.prop(fluid, "use_reverse_frames")
179
180             col = split.column()
181             col.label(text="Time:")
182             sub = col.column(align=True)
183             sub.prop(fluid, "start_time", text="Start")
184             sub.prop(fluid, "end_time", text="End")
185
186             split = layout.split()
187
188             col = split.column()
189             col.label(text="Attraction Force:")
190             sub = col.column(align=True)
191             sub.prop(fluid, "attraction_strength", text="Strength")
192             sub.prop(fluid, "attraction_radius", text="Radius")
193
194             col = split.column()
195             col.label(text="Velocity Force:")
196             sub = col.column(align=True)
197             sub.prop(fluid, "velocity_strength", text="Strength")
198             sub.prop(fluid, "velocity_radius", text="Radius")
199
200
201 class PHYSICS_PT_domain_gravity(PhysicButtonsPanel, Panel):
202     bl_label = "Fluid World"
203     bl_options = {'DEFAULT_CLOSED'}
204
205     @classmethod
206     def poll(cls, context):
207         md = context.fluid
208         rd = context.scene.render
209         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
210
211     def draw(self, context):
212         layout = self.layout
213
214         fluid = context.fluid.settings
215         scene = context.scene
216
217         split = layout.split()
218
219         col = split.column()
220         if scene.use_gravity:
221             col.label(text="Use Scene Gravity", icon='SCENE_DATA')
222             sub = col.column()
223             sub.enabled = False
224             sub.prop(fluid, "gravity", text="")
225         else:
226             col.label(text="Gravity:")
227             col.prop(fluid, "gravity", text="")
228
229         if scene.unit_settings.system != 'NONE':
230             col.label(text="Use Scene Size Units", icon='SCENE_DATA')
231             sub = col.column()
232             sub.enabled = False
233             sub.prop(fluid, "simulation_scale", text="Meters")
234         else:
235             col.label(text="Real World Size:")
236             col.prop(fluid, "simulation_scale", text="Meters")
237
238         col = split.column()
239         col.label(text="Viscosity Presets:")
240         sub = col.row(align=True)
241         sub.menu("FLUID_MT_presets", text=bpy.types.FLUID_MT_presets.bl_label)
242         sub.operator("fluid.preset_add", text="", icon='ZOOMIN')
243         sub.operator("fluid.preset_add", text="", icon='ZOOMOUT').remove_active = True
244
245         subsub = col.column(align=True)
246         subsub.prop(fluid, "viscosity_base", text="Base")
247         subsub.prop(fluid, "viscosity_exponent", text="Exponent", slider=True)
248
249         col.label(text="Optimization:")
250         col.prop(fluid, "grid_levels", slider=True)
251         col.prop(fluid, "compressibility", slider=True)
252
253
254 class PHYSICS_PT_domain_boundary(PhysicButtonsPanel, Panel):
255     bl_label = "Fluid Boundary"
256     bl_options = {'DEFAULT_CLOSED'}
257
258     @classmethod
259     def poll(cls, context):
260         md = context.fluid
261         rd = context.scene.render
262         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
263
264     def draw(self, context):
265         layout = self.layout
266
267         fluid = context.fluid.settings
268
269         split = layout.split()
270
271         col = split.column()
272         col.label(text="Slip Type:")
273         col.prop(fluid, "slip_type", text="")
274         if fluid.slip_type == 'PARTIALSLIP':
275             col.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
276         col.prop(fluid, "surface_noobs")
277
278         col = split.column()
279         col.label(text="Surface:")
280         col.prop(fluid, "surface_smooth", text="Smoothing")
281         col.prop(fluid, "surface_subdivisions", text="Subdivisions")
282
283
284 class PHYSICS_PT_domain_particles(PhysicButtonsPanel, Panel):
285     bl_label = "Fluid Particles"
286     bl_options = {'DEFAULT_CLOSED'}
287
288     @classmethod
289     def poll(cls, context):
290         md = context.fluid
291         rd = context.scene.render
292         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
293
294     def draw(self, context):
295         layout = self.layout
296
297         fluid = context.fluid.settings
298
299         row = layout.row()
300         row.prop(fluid, "tracer_particles", text="Tracer")
301         row.prop(fluid, "generate_particles", text="Generate")
302
303 if __name__ == "__main__":  # only for live edit.
304     bpy.utils.register_module(__name__)