Followup to r59434 : py UI scripts edits.
[blender.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
71             if bpy.app.build_options.openmp:
72                 layout.prop(fluid, "threads", text="Simulation Threads")
73
74             split = layout.split()
75
76             col = split.column()
77             col.label(text="Resolution:")
78             col.prop(fluid, "resolution", text="Final")
79             col.label(text="Render Display:")
80             col.prop(fluid, "render_display_mode", text="")
81
82             col = split.column()
83             col.label()
84             col.prop(fluid, "preview_resolution", text="Preview")
85             col.label(text="Viewport Display:")
86             col.prop(fluid, "viewport_display_mode", text="")
87
88             split = layout.split()
89
90             col = split.column()
91             col.label(text="Time:")
92             sub = col.column(align=True)
93             sub.prop(fluid, "start_time", text="Start")
94             sub.prop(fluid, "end_time", text="End")
95             col.prop(fluid, "simulation_rate", text="Speed")
96
97             col = split.column()
98             col.label()
99             sub = col.column(align=True)
100             sub.prop(fluid, "use_speed_vectors")
101             sub.prop(fluid, "use_reverse_frames")
102             col.prop(fluid, "frame_offset", text="Offset")
103
104             layout.prop(fluid, "filepath", text="")
105
106         elif fluid.type == 'FLUID':
107             split = layout.split()
108
109             col = split.column()
110             col.label(text="Volume Initialization:")
111             col.prop(fluid, "volume_initialization", text="")
112             col.prop(fluid, "use_animated_mesh")
113
114             col = split.column()
115             col.label(text="Initial Velocity:")
116             col.prop(fluid, "initial_velocity", text="")
117
118         elif fluid.type == 'OBSTACLE':
119             split = layout.split()
120
121             col = split.column()
122             col.label(text="Volume Initialization:")
123             col.prop(fluid, "volume_initialization", text="")
124             col.prop(fluid, "use_animated_mesh")
125
126             col = split.column()
127             subsplit = col.split()
128             subcol = subsplit.column()
129             if fluid.use_animated_mesh:
130                 subcol.enabled = False
131             subcol.label(text="Slip Type:")
132             subcol.prop(fluid, "slip_type", text="")
133             if fluid.slip_type == 'PARTIALSLIP':
134                 subcol.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
135
136             col.label(text="Impact:")
137             col.prop(fluid, "impact_factor", text="Factor")
138
139         elif fluid.type == 'INFLOW':
140             split = layout.split()
141
142             col = split.column()
143             col.label(text="Volume Initialization:")
144             col.prop(fluid, "volume_initialization", text="")
145             col.prop(fluid, "use_animated_mesh")
146             row = col.row()
147             row.active = not fluid.use_animated_mesh
148             row.prop(fluid, "use_local_coords")
149
150             col = split.column()
151             col.label(text="Inflow Velocity:")
152             col.prop(fluid, "inflow_velocity", text="")
153
154         elif fluid.type == 'OUTFLOW':
155             col = layout.column()
156             col.label(text="Volume Initialization:")
157             col.prop(fluid, "volume_initialization", text="")
158             col.prop(fluid, "use_animated_mesh")
159
160         elif fluid.type == 'PARTICLE':
161             split = layout.split()
162
163             col = split.column()
164             col.label(text="Influence:")
165             col.prop(fluid, "particle_influence", text="Size")
166             col.prop(fluid, "alpha_influence", text="Alpha")
167
168             col = split.column()
169             col.label(text="Type:")
170             col.prop(fluid, "use_drops")
171             col.prop(fluid, "use_floats")
172             col.prop(fluid, "show_tracer")
173
174             layout.prop(fluid, "filepath", text="")
175
176         elif fluid.type == 'CONTROL':
177             split = layout.split()
178
179             col = split.column()
180             col.label(text="")
181             col.prop(fluid, "quality", slider=True)
182             col.prop(fluid, "use_reverse_frames")
183
184             col = split.column()
185             col.label(text="Time:")
186             sub = col.column(align=True)
187             sub.prop(fluid, "start_time", text="Start")
188             sub.prop(fluid, "end_time", text="End")
189
190             split = layout.split()
191
192             col = split.column()
193             col.label(text="Attraction Force:")
194             sub = col.column(align=True)
195             sub.prop(fluid, "attraction_strength", text="Strength")
196             sub.prop(fluid, "attraction_radius", text="Radius")
197
198             col = split.column()
199             col.label(text="Velocity Force:")
200             sub = col.column(align=True)
201             sub.prop(fluid, "velocity_strength", text="Strength")
202             sub.prop(fluid, "velocity_radius", text="Radius")
203
204
205 class PHYSICS_PT_domain_gravity(PhysicButtonsPanel, Panel):
206     bl_label = "Fluid World"
207     bl_options = {'DEFAULT_CLOSED'}
208
209     @classmethod
210     def poll(cls, context):
211         md = context.fluid
212         rd = context.scene.render
213         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
214
215     def draw(self, context):
216         layout = self.layout
217
218         fluid = context.fluid.settings
219         scene = context.scene
220
221         split = layout.split()
222
223         col = split.column()
224         if scene.use_gravity:
225             col.label(text="Use Scene Gravity", icon='SCENE_DATA')
226             sub = col.column()
227             sub.enabled = False
228             sub.prop(fluid, "gravity", text="")
229         else:
230             col.label(text="Gravity:")
231             col.prop(fluid, "gravity", text="")
232
233         if scene.unit_settings.system != 'NONE':
234             col.label(text="Use Scene Size Units", icon='SCENE_DATA')
235             sub = col.column()
236             sub.enabled = False
237             sub.prop(fluid, "simulation_scale", text="Meters")
238         else:
239             col.label(text="Real World Size:")
240             col.prop(fluid, "simulation_scale", text="Meters")
241
242         col = split.column()
243         col.label(text="Viscosity Presets:")
244         sub = col.row(align=True)
245         sub.menu("FLUID_MT_presets", text=bpy.types.FLUID_MT_presets.bl_label)
246         sub.operator("fluid.preset_add", text="", icon='ZOOMIN')
247         sub.operator("fluid.preset_add", text="", icon='ZOOMOUT').remove_active = True
248
249         sub = col.column(align=True)
250         sub.prop(fluid, "viscosity_base", text="Base")
251         sub.prop(fluid, "viscosity_exponent", text="Exponent", slider=True)
252
253         col.label(text="Optimization:")
254         col.prop(fluid, "grid_levels", slider=True)
255         col.prop(fluid, "compressibility", slider=True)
256
257
258 class PHYSICS_PT_domain_boundary(PhysicButtonsPanel, Panel):
259     bl_label = "Fluid Boundary"
260     bl_options = {'DEFAULT_CLOSED'}
261
262     @classmethod
263     def poll(cls, context):
264         md = context.fluid
265         rd = context.scene.render
266         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
267
268     def draw(self, context):
269         layout = self.layout
270
271         fluid = context.fluid.settings
272
273         split = layout.split()
274
275         col = split.column()
276         col.label(text="Slip Type:")
277         col.prop(fluid, "slip_type", text="")
278         if fluid.slip_type == 'PARTIALSLIP':
279             col.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
280         col.prop(fluid, "use_surface_noobs")
281
282         col = split.column()
283         col.label(text="Surface:")
284         col.prop(fluid, "surface_smooth", text="Smoothing")
285         col.prop(fluid, "surface_subdivisions", text="Subdivisions")
286
287
288 class PHYSICS_PT_domain_particles(PhysicButtonsPanel, Panel):
289     bl_label = "Fluid Particles"
290     bl_options = {'DEFAULT_CLOSED'}
291
292     @classmethod
293     def poll(cls, context):
294         md = context.fluid
295         rd = context.scene.render
296         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
297
298     def draw(self, context):
299         layout = self.layout
300
301         fluid = context.fluid.settings
302
303         row = layout.row()
304         row.prop(fluid, "tracer_particles", text="Tracer")
305         row.prop(fluid, "generate_particles", text="Generate")
306
307 if __name__ == "__main__":  # only for live edit.
308     bpy.utils.register_module(__name__)