c03b53231057e640805ce2300b4240616c603b8d
[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
23
24 class FLUID_MT_presets(Menu):
25     bl_label = "Fluid Presets"
26     preset_subdir = "fluid"
27     preset_operator = "script.execute_preset"
28     draw = Menu.draw_preset
29
30
31 class PhysicButtonsPanel():
32     bl_space_type = 'PROPERTIES'
33     bl_region_type = 'WINDOW'
34     bl_context = "physics"
35
36     @classmethod
37     def poll(cls, context):
38         ob = context.object
39         rd = context.scene.render
40         return (ob and ob.type == 'MESH') and (not rd.use_game_engine) and (context.fluid)
41
42
43 class PHYSICS_PT_fluid(PhysicButtonsPanel, Panel):
44     bl_label = "Fluid"
45
46     def draw(self, context):
47         layout = self.layout
48
49         md = context.fluid
50         fluid = md.settings
51
52         col = layout.column()
53         if fluid is None:
54             col.label("Built without fluids")
55             return
56
57         col.prop(fluid, "type")
58         if fluid.type not in {'NONE', 'DOMAIN', 'PARTICLE', 'FLUID', 'OBSTACLE'}:
59             col.prop(fluid, "use")
60
61         layout = layout.column()
62         if fluid.type not in {'NONE', 'DOMAIN', 'PARTICLE', 'FLUID', 'OBSTACLE'}:
63             layout.active = fluid.use
64
65         if fluid.type == 'DOMAIN':
66             # odd formatting here so translation script can extract string
67             pgettext = bpy.app.translations.pgettext
68             layout.operator("fluid.bake", text=pgettext("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             col.prop(fluid, "use_speed_vectors")
96             col.prop(fluid, "use_reverse_frames")
97             col.prop(fluid, "frame_offset", text="Offset")
98
99             layout.prop(fluid, "filepath", text="")
100
101         elif fluid.type == 'FLUID':
102             split = layout.split()
103
104             col = split.column()
105             col.label(text="Volume Initialization:")
106             col.prop(fluid, "volume_initialization", text="")
107             col.prop(fluid, "use_animated_mesh")
108
109             col = split.column()
110             col.label(text="Initial Velocity:")
111             col.prop(fluid, "initial_velocity", text="")
112
113         elif fluid.type == 'OBSTACLE':
114             split = layout.split()
115
116             col = split.column()
117             col.label(text="Volume Initialization:")
118             col.prop(fluid, "volume_initialization", text="")
119             col.prop(fluid, "use_animated_mesh")
120
121             col = split.column()
122             subsplit = col.split()
123             subcol = subsplit.column()
124             if fluid.use_animated_mesh:
125                 subcol.enabled = False
126             subcol.label(text="Slip Type:")
127             subcol.prop(fluid, "slip_type", text="")
128             if fluid.slip_type == 'PARTIALSLIP':
129                 subcol.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
130
131             col.label(text="Impact:")
132             col.prop(fluid, "impact_factor", text="Factor")
133
134         elif fluid.type == 'INFLOW':
135             split = layout.split()
136
137             col = split.column()
138             col.label(text="Volume Initialization:")
139             col.prop(fluid, "volume_initialization", text="")
140             col.prop(fluid, "use_animated_mesh")
141             row = col.row()
142             row.active = not fluid.use_animated_mesh
143             row.prop(fluid, "use_local_coords")
144
145             col = split.column()
146             col.label(text="Inflow Velocity:")
147             col.prop(fluid, "inflow_velocity", text="")
148
149         elif fluid.type == 'OUTFLOW':
150             col = layout.column()
151             col.label(text="Volume Initialization:")
152             col.prop(fluid, "volume_initialization", text="")
153             col.prop(fluid, "use_animated_mesh")
154
155         elif fluid.type == 'PARTICLE':
156             split = layout.split()
157
158             col = split.column()
159             col.label(text="Influence:")
160             col.prop(fluid, "particle_influence", text="Size")
161             col.prop(fluid, "alpha_influence", text="Alpha")
162
163             col = split.column()
164             col.label(text="Type:")
165             col.prop(fluid, "use_drops")
166             col.prop(fluid, "use_floats")
167             col.prop(fluid, "show_tracer")
168
169             layout.prop(fluid, "filepath", text="")
170
171         elif fluid.type == 'CONTROL':
172             split = layout.split()
173
174             col = split.column()
175             col.label(text="")
176             col.prop(fluid, "quality", slider=True)
177             col.prop(fluid, "use_reverse_frames")
178
179             col = split.column()
180             col.label(text="Time:")
181             sub = col.column(align=True)
182             sub.prop(fluid, "start_time", text="Start")
183             sub.prop(fluid, "end_time", text="End")
184
185             split = layout.split()
186
187             col = split.column()
188             col.label(text="Attraction Force:")
189             sub = col.column(align=True)
190             sub.prop(fluid, "attraction_strength", text="Strength")
191             sub.prop(fluid, "attraction_radius", text="Radius")
192
193             col = split.column()
194             col.label(text="Velocity Force:")
195             sub = col.column(align=True)
196             sub.prop(fluid, "velocity_strength", text="Strength")
197             sub.prop(fluid, "velocity_radius", text="Radius")
198
199
200 class PHYSICS_PT_domain_gravity(PhysicButtonsPanel, Panel):
201     bl_label = "Fluid World"
202     bl_options = {'DEFAULT_CLOSED'}
203
204     @classmethod
205     def poll(cls, context):
206         md = context.fluid
207         rd = context.scene.render
208         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
209
210     def draw(self, context):
211         layout = self.layout
212
213         fluid = context.fluid.settings
214         scene = context.scene
215
216         split = layout.split()
217
218         col = split.column()
219         if scene.use_gravity:
220             col.label(text="Use Scene Gravity", icon='SCENE_DATA')
221             sub = col.column()
222             sub.enabled = False
223             sub.prop(fluid, "gravity", text="")
224         else:
225             col.label(text="Gravity:")
226             col.prop(fluid, "gravity", text="")
227
228         if scene.unit_settings.system != 'NONE':
229             col.label(text="Use Scene Size Units", icon='SCENE_DATA')
230             sub = col.column()
231             sub.enabled = False
232             sub.prop(fluid, "simulation_scale", text="Meters")
233         else:
234             col.label(text="Real World Size:")
235             col.prop(fluid, "simulation_scale", text="Meters")
236
237         col = split.column()
238         col.label(text="Viscosity Presets:")
239         sub = col.row(align=True)
240         sub.menu("FLUID_MT_presets", text=bpy.types.FLUID_MT_presets.bl_label)
241         sub.operator("fluid.preset_add", text="", icon='ZOOMIN')
242         sub.operator("fluid.preset_add", text="", icon='ZOOMOUT').remove_active = True
243
244         subsub = col.column(align=True)
245         subsub.prop(fluid, "viscosity_base", text="Base")
246         subsub.prop(fluid, "viscosity_exponent", text="Exponent", slider=True)
247
248         col.label(text="Optimization:")
249         col.prop(fluid, "grid_levels", slider=True)
250         col.prop(fluid, "compressibility", slider=True)
251
252
253 class PHYSICS_PT_domain_boundary(PhysicButtonsPanel, Panel):
254     bl_label = "Fluid Boundary"
255     bl_options = {'DEFAULT_CLOSED'}
256
257     @classmethod
258     def poll(cls, context):
259         md = context.fluid
260         rd = context.scene.render
261         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
262
263     def draw(self, context):
264         layout = self.layout
265
266         fluid = context.fluid.settings
267
268         split = layout.split()
269
270         col = split.column()
271         col.label(text="Slip Type:")
272         col.prop(fluid, "slip_type", text="")
273         if fluid.slip_type == 'PARTIALSLIP':
274             col.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
275         col.prop(fluid, "surface_noobs")
276
277         col = split.column()
278         col.label(text="Surface:")
279         col.prop(fluid, "surface_smooth", text="Smoothing")
280         col.prop(fluid, "surface_subdivisions", text="Subdivisions")
281
282
283 class PHYSICS_PT_domain_particles(PhysicButtonsPanel, Panel):
284     bl_label = "Fluid Particles"
285     bl_options = {'DEFAULT_CLOSED'}
286
287     @classmethod
288     def poll(cls, context):
289         md = context.fluid
290         rd = context.scene.render
291         return md and md.settings and (md.settings.type == 'DOMAIN') and (not rd.use_game_engine)
292
293     def draw(self, context):
294         layout = self.layout
295
296         fluid = context.fluid.settings
297
298         col = layout.column(align=True)
299         col.prop(fluid, "tracer_particles")
300         col.prop(fluid, "generate_particles")
301
302 if __name__ == "__main__":  # only for live edit.
303     bpy.utils.register_module(__name__)