dac8fe9195f13800dae95c59d8b7ee7e9b9e1e77
[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
22
23 class PhysicButtonsPanel():
24     bl_space_type = 'PROPERTIES'
25     bl_region_type = 'WINDOW'
26     bl_context = "physics"
27
28     @classmethod
29     def poll(cls, context):
30         ob = context.object
31         rd = context.scene.render
32         return (ob and ob.type == 'MESH') and (not rd.use_game_engine) and (context.fluid)
33
34
35 class PHYSICS_PT_fluid(PhysicButtonsPanel, bpy.types.Panel):
36     bl_label = "Fluid"
37
38     def draw(self, context):
39         layout = self.layout
40
41         md = context.fluid
42
43         if md:
44             fluid = md.settings
45
46             row = layout.row()
47             if fluid is None:
48                 row.label("built without fluids")
49                 return
50
51             row.prop(fluid, "type")
52             if fluid.type not in {'NONE', 'DOMAIN', 'PARTICLE', 'FLUID'}:
53                 row.prop(fluid, "use", text="")
54
55             layout = layout.column()
56             if fluid.type not in {'NONE', 'DOMAIN', 'PARTICLE', 'FLUID'}:
57                 layout.active = fluid.use
58
59             if fluid.type == 'DOMAIN':
60                 layout.operator("fluid.bake", text="Bake (Req. Memory: %s)" % fluid.memory_estimate, icon='MOD_FLUIDSIM')
61                 split = layout.split()
62
63                 col = split.column()
64                 col.label(text="Resolution:")
65                 col.prop(fluid, "resolution", text="Final")
66                 col.label(text="Render Display:")
67                 col.prop(fluid, "render_display_mode", text="")
68
69                 col = split.column()
70                 col.label()
71                 col.prop(fluid, "preview_resolution", text="Preview")
72                 col.label(text="Viewport Display:")
73                 col.prop(fluid, "viewport_display_mode", text="")
74
75                 split = layout.split()
76
77                 col = split.column()
78                 col.label(text="Time:")
79                 sub = col.column(align=True)
80                 sub.prop(fluid, "start_time", text="Start")
81                 sub.prop(fluid, "end_time", text="End")
82
83                 col = split.column()
84                 col.label()
85                 col.prop(fluid, "use_speed_vectors")
86                 col.prop(fluid, "use_reverse_frames")
87
88                 layout.prop(fluid, "filepath", text="")
89
90             elif fluid.type == 'FLUID':
91                 split = layout.split()
92
93                 col = split.column()
94                 col.label(text="Volume Initialization:")
95                 col.prop(fluid, "volume_initialization", text="")
96                 col.prop(fluid, "use_animated_mesh")
97
98                 col = split.column()
99                 col.label(text="Initial Velocity:")
100                 col.prop(fluid, "initial_velocity", text="")
101
102             elif fluid.type == 'OBSTACLE':
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="Slip Type:")
112                 col.prop(fluid, "slip_type", text="")
113                 if fluid.slip_type == 'PARTIALSLIP':
114                     col.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
115
116                 col.label(text="Impact:")
117                 col.prop(fluid, "impact_factor", text="Factor")
118
119             elif fluid.type == 'INFLOW':
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                 row = col.row()
127                 row.active = not fluid.use_animated_mesh
128                 row.prop(fluid, "use_local_coords")
129
130                 col = split.column()
131                 col.label(text="Inflow Velocity:")
132                 col.prop(fluid, "inflow_velocity", text="")
133
134             elif fluid.type == 'OUTFLOW':
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
142                 split.column()
143
144             elif fluid.type == 'PARTICLE':
145                 split = layout.split()
146
147                 col = split.column()
148                 col.label(text="Influence:")
149                 col.prop(fluid, "particle_influence", text="Size")
150                 col.prop(fluid, "alpha_influence", text="Alpha")
151
152                 col = split.column()
153                 col.label(text="Type:")
154                 col.prop(fluid, "use_drops")
155                 col.prop(fluid, "use_floats")
156                 col.prop(fluid, "show_tracer")
157
158                 layout.prop(fluid, "filepath", text="")
159
160             elif fluid.type == 'CONTROL':
161                 split = layout.split()
162
163                 col = split.column()
164                 col.label(text="")
165                 col.prop(fluid, "quality", slider=True)
166                 col.prop(fluid, "use_reverse_frames")
167
168                 col = split.column()
169                 col.label(text="Time:")
170                 sub = col.column(align=True)
171                 sub.prop(fluid, "start_time", text="Start")
172                 sub.prop(fluid, "end_time", text="End")
173
174                 split = layout.split()
175
176                 col = split.column()
177                 col.label(text="Attraction Force:")
178                 sub = col.column(align=True)
179                 sub.prop(fluid, "attraction_strength", text="Strength")
180                 sub.prop(fluid, "attraction_radius", text="Radius")
181
182                 col = split.column()
183                 col.label(text="Velocity Force:")
184                 sub = col.column(align=True)
185                 sub.prop(fluid, "velocity_strength", text="Strength")
186                 sub.prop(fluid, "velocity_radius", text="Radius")
187
188
189 class PHYSICS_PT_domain_gravity(PhysicButtonsPanel, bpy.types.Panel):
190     bl_label = "Domain World"
191     bl_options = {'DEFAULT_CLOSED'}
192
193     @classmethod
194     def poll(cls, context):
195         md = context.fluid
196         return md and md.settings and (md.settings.type == 'DOMAIN')
197
198     def draw(self, context):
199         layout = self.layout
200
201         fluid = context.fluid.settings
202         scene = context.scene
203
204         split = layout.split()
205
206         col = split.column()
207         if scene.use_gravity:
208             col.label(text="Using Scene Gravity", icon="SCENE_DATA")
209             sub = col.column()
210             sub.enabled = False
211             sub.prop(fluid, "gravity", text="")
212         else:
213             col.label(text="Gravity:")
214             col.prop(fluid, "gravity", text="")
215
216         if scene.unit_settings.system != 'NONE':
217             col.label(text="Using Scene Size Units", icon="SCENE_DATA")
218             sub = col.column()
219             sub.enabled = False
220             sub.prop(fluid, "simulation_scale", text="Metres")
221         else:
222             col.label(text="Real World Size:")
223             col.prop(fluid, "simulation_scale", text="Metres")
224
225         col = split.column()
226         col.label(text="Viscosity Presets:")
227         sub = col.column(align=True)
228         sub.prop(fluid, "viscosity_preset", text="")
229
230         if fluid.viscosity_preset == 'MANUAL':
231             sub.prop(fluid, "viscosity_base", text="Base")
232             sub.prop(fluid, "viscosity_exponent", text="Exponent", slider=True)
233
234         col.label(text="Optimization:")
235         col.prop(fluid, "grid_levels", slider=True)
236         col.prop(fluid, "compressibility", slider=True)
237
238
239 class PHYSICS_PT_domain_boundary(PhysicButtonsPanel, bpy.types.Panel):
240     bl_label = "Domain Boundary"
241     bl_options = {'DEFAULT_CLOSED'}
242
243     @classmethod
244     def poll(cls, context):
245         md = context.fluid
246         return md and md.settings and (md.settings.type == 'DOMAIN')
247
248     def draw(self, context):
249         layout = self.layout
250
251         fluid = context.fluid.settings
252
253         split = layout.split()
254
255         col = split.column()
256         col.label(text="Slip Type:")
257         col.prop(fluid, "slip_type", text="")
258         if fluid.slip_type == 'PARTIALSLIP':
259             col.prop(fluid, "partial_slip_factor", slider=True, text="Amount")
260
261         col = split.column()
262         col.label(text="Surface:")
263         col.prop(fluid, "surface_smooth", text="Smoothing")
264         col.prop(fluid, "surface_subdivisions", text="Subdivisions")
265
266
267 class PHYSICS_PT_domain_particles(PhysicButtonsPanel, bpy.types.Panel):
268     bl_label = "Domain Particles"
269     bl_options = {'DEFAULT_CLOSED'}
270
271     @classmethod
272     def poll(cls, context):
273         md = context.fluid
274         return md and md.settings and (md.settings.type == 'DOMAIN')
275
276     def draw(self, context):
277         layout = self.layout
278
279         fluid = context.fluid.settings
280
281         col = layout.column(align=True)
282         col.prop(fluid, "tracer_particles")
283         col.prop(fluid, "generate_particles")