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