Cleanup: use staticmethod where appropriate
[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
21 import bpy
22 from bpy.types import (
23     Panel,
24 )
25 from bpy.app.translations import pgettext_iface as iface_
26 from bl_ui.utils import PresetPanel
27
28
29 class FLUID_PT_presets(PresetPanel, Panel):
30     bl_label = "Fluid Presets"
31     preset_subdir = "fluid"
32     preset_operator = "script.execute_preset"
33     preset_add_operator = "fluid.preset_add"
34
35
36 class PhysicButtonsPanel:
37     bl_space_type = 'PROPERTIES'
38     bl_region_type = 'WINDOW'
39     bl_context = "physics"
40
41     @staticmethod
42     def poll_fluid(context):
43         ob = context.object
44         if not ((ob and ob.type == 'MESH') and (context.fluid)):
45             return False
46
47         return (bpy.app.build_options.mod_fluid)
48
49     @staticmethod
50     def poll_fluid_settings(context):
51         if not (PhysicButtonsPanel.poll_fluid(context)):
52             return False
53
54         md = context.fluid
55         return md and md.settings and (md.settings.type != 'NONE')
56
57     @staticmethod
58     def poll_fluid_domain(context):
59         if not PhysicButtonsPanel.poll_fluid(context):
60             return False
61
62         md = context.fluid
63         return md and md.settings and (md.settings.type == 'DOMAIN')
64
65
66 class PHYSICS_PT_fluid(PhysicButtonsPanel, Panel):
67     bl_label = "Fluid"
68     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
69
70     @classmethod
71     def poll(cls, context):
72         ob = context.object
73         return (ob and ob.type == 'MESH') and context.engine in cls.COMPAT_ENGINES and (context.fluid)
74
75     def draw(self, context):
76         layout = self.layout
77         layout.use_property_split = True
78
79         if not bpy.app.build_options.mod_fluid:
80             col = layout.column()
81             col.alignment = 'RIGHT'
82             col.label(text="Built without fluids")
83             return
84
85         md = context.fluid
86         fluid = md.settings
87
88         col = layout.column()
89         col.prop(fluid, "type")
90
91
92 class PHYSICS_PT_fluid_flow(PhysicButtonsPanel, Panel):
93     bl_label = "Flow"
94     bl_parent_id = "PHYSICS_PT_fluid"
95     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
96
97     @classmethod
98     def poll(cls, context):
99         md = context.fluid
100         fluid = md.settings
101
102         if not PhysicButtonsPanel.poll_fluid_settings(context):
103             return False
104         return fluid.type in {'INFLOW', 'OUTFLOW', 'CONTROL'} and (context.engine in cls.COMPAT_ENGINES)
105
106     def draw_header(self, context):
107         md = context.fluid
108         fluid = md.settings
109
110         self.layout.prop(fluid, "use", text="")
111
112     def draw(self, context):
113         layout = self.layout
114         layout.use_property_split = True
115
116         md = context.fluid
117         fluid = md.settings
118
119         flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=True)
120
121         flow.active = fluid.use
122
123         if fluid.type == 'INFLOW':
124             col = flow.column()
125             col.prop(fluid, "volume_initialization", text="Volume Initialization")
126             col.prop(fluid, "use_animated_mesh")
127
128             row = col.row()
129             row.active = not fluid.use_animated_mesh
130             row.prop(fluid, "use_local_coords")
131
132             col = flow.column()
133             col.prop(fluid, "inflow_velocity", text="Inflow Velocity")
134
135         elif fluid.type == 'OUTFLOW':
136             col = flow.column()
137             col.prop(fluid, "volume_initialization", text="Volume Initialization")
138
139             col = flow.column()
140             col.prop(fluid, "use_animated_mesh")
141
142         elif fluid.type == 'CONTROL':
143             col = flow.column()
144             col.prop(fluid, "quality", slider=True)
145             col.prop(fluid, "use_reverse_frames")
146
147             col = flow.column()
148             col.prop(fluid, "start_time", text="Time Start")
149             col.prop(fluid, "end_time", text="End")
150
151             col.separator()
152
153             col = flow.column()
154             col.prop(fluid, "attraction_strength", text="Attraction Strength")
155             col.prop(fluid, "attraction_radius", text="Radius")
156
157             col.separator()
158
159             col = flow.column(align=True)
160             col.prop(fluid, "velocity_strength", text="Velocity Strength")
161             col.prop(fluid, "velocity_radius", text="Radius")
162
163
164 class PHYSICS_PT_fluid_settings(PhysicButtonsPanel, Panel):
165     bl_label = "Settings"
166     bl_parent_id = "PHYSICS_PT_fluid"
167     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
168
169     @classmethod
170     def poll(cls, context):
171         md = context.fluid
172         fluid = md.settings
173
174         if not PhysicButtonsPanel.poll_fluid_settings(context):
175             return False
176         return fluid.type in {'DOMAIN', 'FLUID', 'OBSTACLE', 'PARTICLE'} and (context.engine in cls.COMPAT_ENGINES)
177
178     def draw(self, context):
179         layout = self.layout
180         layout.use_property_split = True
181
182         md = context.fluid
183         fluid = md.settings
184
185         flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=True)
186
187         if fluid.type not in {'NONE', 'DOMAIN', 'PARTICLE', 'FLUID', 'OBSTACLE'}:
188             flow.active = fluid.use
189
190         if fluid.type == 'DOMAIN':
191             col = flow.column()
192
193             if bpy.app.build_options.openmp:
194                 col.prop(fluid, "threads", text="Simulation Threads")
195                 col.separator()
196
197             col.prop(fluid, "resolution", text="Final Resolution")
198             col.prop(fluid, "preview_resolution", text="Preview")
199
200             col.separator()
201
202             col = flow.column()
203             col.prop(fluid, "render_display_mode", text="Render Display")
204             col.prop(fluid, "viewport_display_mode", text="Viewport")
205
206             col.separator()
207
208             col = flow.column()
209             sub = col.column(align=True)
210             sub.prop(fluid, "start_time", text="Time Start")
211             sub.prop(fluid, "end_time", text="End")
212             col.prop(fluid, "simulation_rate", text="Speed")
213
214             col = flow.column()
215             col.prop(fluid, "use_speed_vectors")
216             col.prop(fluid, "use_reverse_frames")
217             col.prop(fluid, "frame_offset", text="Offset")
218
219         elif fluid.type == 'FLUID':
220             col = flow.column()
221             col.prop(fluid, "volume_initialization", text="Volume Initialization")
222             col.prop(fluid, "use_animated_mesh")
223
224             col = flow.column()
225             col.prop(fluid, "initial_velocity", text="Initial Velocity")
226
227         elif fluid.type == 'OBSTACLE':
228             col = flow.column()
229             col.prop(fluid, "volume_initialization", text="Volume Initialization")
230             col.prop(fluid, "use_animated_mesh")
231
232             col = flow.column()
233             subcol = col.column()
234             subcol.enabled = not fluid.use_animated_mesh
235             subcol.prop(fluid, "slip_type", text="Slip Type")
236
237             if fluid.slip_type == 'PARTIALSLIP':
238                 subcol.prop(fluid, "partial_slip_factor", text="Amount", slider=True)
239
240             col.prop(fluid, "impact_factor", text="Impact Factor")
241
242         elif fluid.type == 'PARTICLE':
243             col = flow.column()
244             col.prop(fluid, "particle_influence", text="Influence Size")
245             col.prop(fluid, "alpha_influence", text="Alpha")
246
247             col = flow.column()
248             col.prop(fluid, "use_drops")
249             col.prop(fluid, "use_floats")
250             col.prop(fluid, "show_tracer")
251
252
253 class PHYSICS_PT_fluid_particle_cache(PhysicButtonsPanel, Panel):
254     bl_label = "Cache"
255     bl_parent_id = "PHYSICS_PT_fluid"
256     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
257
258     @classmethod
259     def poll(cls, context):
260         if not PhysicButtonsPanel.poll_fluid_settings(context):
261             return False
262
263         md = context.fluid
264         return md and md.settings and (md.settings.type == 'PARTICLE') and (context.engine in cls.COMPAT_ENGINES)
265
266     def draw(self, context):
267         layout = self.layout
268
269         md = context.fluid
270         fluid = md.settings
271
272         layout.prop(fluid, "filepath", text="")
273
274
275 class PHYSICS_PT_domain_bake(PhysicButtonsPanel, Panel):
276     bl_label = "Bake"
277     bl_parent_id = 'PHYSICS_PT_fluid'
278     bl_options = {'DEFAULT_CLOSED'}
279     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
280
281     @classmethod
282     def poll(cls, context):
283         if not PhysicButtonsPanel.poll_fluid_domain(context):
284             return False
285
286         return (context.engine in cls.COMPAT_ENGINES)
287
288     def draw(self, context):
289         layout = self.layout
290
291         md = context.fluid
292         fluid = md.settings
293
294         row = layout.row(align=True)
295         row.alignment = 'RIGHT'
296         row.label(text="Cache Path")
297
298         layout.prop(fluid, "filepath", text="")
299
300         # odd formatting here so translation script can extract string
301         layout.operator(
302             "fluid.bake", text=iface_("Bake (Req. Memory: %s)") % fluid.memory_estimate,
303             translate=False, icon='MOD_FLUIDSIM'
304         )
305
306
307 class PHYSICS_PT_domain_gravity(PhysicButtonsPanel, Panel):
308     bl_label = "World"
309     bl_parent_id = 'PHYSICS_PT_fluid'
310     bl_options = {'DEFAULT_CLOSED'}
311     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
312
313     @classmethod
314     def poll(cls, context):
315         if not PhysicButtonsPanel.poll_fluid_domain(context):
316             return False
317
318         return (context.engine in cls.COMPAT_ENGINES)
319
320     def draw(self, context):
321         layout = self.layout
322         layout.use_property_split = True
323
324         fluid = context.fluid.settings
325         scene = context.scene
326
327         col = layout.column()
328
329         use_gravity = scene.use_gravity
330         use_units = scene.unit_settings.system != 'NONE'
331
332         if use_gravity or use_units:
333             s_gravity = " Gravity" if use_gravity else ""
334             s_units = " Units" if use_units else ""
335             s_and = " and " if use_gravity and use_units else ""
336             warn = f"Using {s_gravity}{s_and}{s_units} from Scene"
337
338             sub = col.column()
339             sub.alignment = 'RIGHT'
340             sub.label(text=warn)
341
342         flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=True)
343
344         col = flow.column()
345         sub = col.column()
346         sub.enabled = not use_gravity
347         sub.prop(fluid, "gravity", text="Gravity")
348
349         sub = col.column()
350         sub.enabled = not use_units
351         sub.prop(fluid, "simulation_scale", text="Scene Size Meters" if use_units else "World Size Meters")
352
353         col.separator()
354
355         col = flow.column()
356         col.prop(fluid, "grid_levels", text="Optimization", slider=True)
357         col.prop(fluid, "compressibility", slider=True)
358
359
360 class PHYSICS_PT_domain_viscosity(PhysicButtonsPanel, Panel):
361     bl_label = "Viscosity"
362     bl_parent_id = 'PHYSICS_PT_fluid'
363     bl_options = {'DEFAULT_CLOSED'}
364     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
365
366     @classmethod
367     def poll(cls, context):
368         if not PhysicButtonsPanel.poll_fluid_domain(context):
369             return False
370
371         return (context.engine in cls.COMPAT_ENGINES)
372
373     def draw_header_preset(self, _context):
374         FLUID_PT_presets.draw_panel_header(self.layout)
375
376     def draw(self, context):
377         layout = self.layout
378         layout.use_property_split = True
379         flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=True)
380
381         fluid = context.fluid.settings
382
383         col = flow.column()
384         col.prop(fluid, "viscosity_base", text="Base")
385
386         col = flow.column()
387         col.prop(fluid, "viscosity_exponent", text="Exponent", slider=True)
388
389
390 class PHYSICS_PT_domain_boundary(PhysicButtonsPanel, Panel):
391     bl_label = "Boundary"
392     bl_parent_id = 'PHYSICS_PT_fluid'
393     bl_options = {'DEFAULT_CLOSED'}
394     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
395
396     @classmethod
397     def poll(cls, context):
398         if not PhysicButtonsPanel.poll_fluid_domain(context):
399             return False
400
401         return (context.engine in cls.COMPAT_ENGINES)
402
403     def draw(self, context):
404         layout = self.layout
405         layout.use_property_split = True
406         flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=True)
407
408         fluid = context.fluid.settings
409
410         col = flow.column()
411         col.prop(fluid, "slip_type", text="Type")
412
413         col.separator()
414
415         if fluid.slip_type == 'PARTIALSLIP':
416             col.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
417
418         col = flow.column()
419         col.prop(fluid, "surface_smooth", text="Surface Smoothing")
420         col.prop(fluid, "surface_subdivisions", text="Subdivisions")
421         col.prop(fluid, "use_surface_noobs")
422
423
424 class PHYSICS_PT_domain_particles(PhysicButtonsPanel, Panel):
425     bl_label = "Particles"
426     bl_parent_id = 'PHYSICS_PT_fluid'
427     bl_options = {'DEFAULT_CLOSED'}
428     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE'}
429
430     @classmethod
431     def poll(cls, context):
432         if not PhysicButtonsPanel.poll_fluid_domain(context):
433             return False
434
435         return (context.engine in cls.COMPAT_ENGINES)
436
437     def draw(self, context):
438         layout = self.layout
439         layout.use_property_split = True
440         flow = layout.grid_flow(row_major=True, columns=0, even_columns=True, even_rows=False, align=True)
441
442         fluid = context.fluid.settings
443
444         col = flow.column()
445         col.prop(fluid, "tracer_particles", text="Tracer")
446
447         col = flow.column()
448         col.prop(fluid, "generate_particles", text="Generate")
449
450
451 classes = (
452     FLUID_PT_presets,
453     PHYSICS_PT_fluid,
454     PHYSICS_PT_fluid_settings,
455     PHYSICS_PT_fluid_flow,
456     PHYSICS_PT_fluid_particle_cache,
457     PHYSICS_PT_domain_bake,
458     PHYSICS_PT_domain_boundary,
459     PHYSICS_PT_domain_particles,
460     PHYSICS_PT_domain_gravity,
461     PHYSICS_PT_domain_viscosity,
462 )
463
464 if __name__ == "__main__":  # only for live edit.
465     from bpy.utils import register_class
466     for cls in classes:
467         register_class(cls)