Related to #36382: for linked object point caches, show a message that disk
[blender.git] / release / scripts / startup / bl_ui / properties_physics_common.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 Panel
23 from bpy.app.translations import contexts as i18n_contexts
24
25
26 class PhysicButtonsPanel():
27     bl_space_type = 'PROPERTIES'
28     bl_region_type = 'WINDOW'
29     bl_context = "physics"
30
31     @classmethod
32     def poll(cls, context):
33         rd = context.scene.render
34         return (context.object) and (not rd.use_game_engine)
35
36
37 def physics_add(self, layout, md, name, type, typeicon, toggles):
38     row = layout.row(align=True)
39     if md:
40         row.context_pointer_set("modifier", md)
41         row.operator("object.modifier_remove", text=name, text_ctxt=i18n_contexts.default, icon='X')
42         if toggles:
43             row.prop(md, "show_render", text="")
44             row.prop(md, "show_viewport", text="")
45     else:
46         row.operator("object.modifier_add", text=name, text_ctxt=i18n_contexts.default, icon=typeicon).type = type
47
48
49 def physics_add_special(self, layout, data, name, addop, removeop, typeicon):
50     row = layout.row(align=True)
51     if data:
52         row.operator(removeop, text=name, text_ctxt=i18n_contexts.default, icon='X')
53     else:
54         row.operator(addop, text=name, text_ctxt=i18n_contexts.default, icon=typeicon)
55
56
57 class PHYSICS_PT_add(PhysicButtonsPanel, Panel):
58     bl_label = ""
59     bl_options = {'HIDE_HEADER'}
60
61     def draw(self, context):
62         obj = context.object
63
64         layout = self.layout
65         layout.label("Enable physics for:")
66         split = layout.split()
67         col = split.column()
68
69         if obj.field.type == 'NONE':
70             col.operator("object.forcefield_toggle", text="Force Field", icon='FORCE_FORCE')
71         else:
72             col.operator("object.forcefield_toggle", text="Force Field", icon='X')
73
74         if obj.type == 'MESH':
75             physics_add(self, col, context.collision, "Collision", 'COLLISION', 'MOD_PHYSICS', False)
76             physics_add(self, col, context.cloth, "Cloth", 'CLOTH', 'MOD_CLOTH', True)
77             physics_add(self, col, context.dynamic_paint, "Dynamic Paint", 'DYNAMIC_PAINT', 'MOD_DYNAMICPAINT', True)
78
79         col = split.column()
80
81         if obj.type in {'MESH', 'LATTICE', 'CURVE'}:
82             physics_add(self, col, context.soft_body, "Soft Body", 'SOFT_BODY', 'MOD_SOFT', True)
83
84         if obj.type == 'MESH':
85             physics_add(self, col, context.fluid, "Fluid", 'FLUID_SIMULATION', 'MOD_FLUIDSIM', True)
86             physics_add(self, col, context.smoke, "Smoke", 'SMOKE', 'MOD_SMOKE', True)
87
88             physics_add_special(self, col, obj.rigid_body, "Rigid Body",
89                                 "rigidbody.object_add",
90                                 "rigidbody.object_remove",
91                                 'MESH_ICOSPHERE')  # XXX: need dedicated icon
92
93         # all types of objects can have rigid body constraint
94         physics_add_special(self, col, obj.rigid_body_constraint, "Rigid Body Constraint",
95                             "rigidbody.constraint_add",
96                             "rigidbody.constraint_remove",
97                             'CONSTRAINT')  # RB_TODO needs better icon
98
99
100 # cache-type can be 'PSYS' 'HAIR' 'SMOKE' etc
101
102 def point_cache_ui(self, context, cache, enabled, cachetype):
103     layout = self.layout
104
105     layout.context_pointer_set("point_cache", cache)
106
107     if not cachetype == 'RIGID_BODY':
108         row = layout.row()
109         row.template_list("UI_UL_list", "point_caches", cache, "point_caches",
110                           cache.point_caches, "active_index", rows=2)
111         col = row.column(align=True)
112         col.operator("ptcache.add", icon='ZOOMIN', text="")
113         col.operator("ptcache.remove", icon='ZOOMOUT', text="")
114
115     row = layout.row()
116     if cachetype in {'PSYS', 'HAIR', 'SMOKE'}:
117         row.prop(cache, "use_external")
118
119         if cachetype == 'SMOKE':
120             row.prop(cache, "use_library_path", "Use Lib Path")
121
122     if cache.use_external:
123         split = layout.split(percentage=0.35)
124         col = split.column()
125         col.label(text="File Name:")
126         if cache.use_external:
127             col.label(text="File Path:")
128
129         col = split.column()
130         sub = col.split(percentage=0.70, align=True)
131         sub.prop(cache, "name", text="")
132         sub.prop(cache, "index", text="")
133         col.prop(cache, "filepath", text="")
134
135         cache_info = cache.info
136         if cache_info:
137             layout.label(text=cache_info)
138     else:
139         if cachetype in {'SMOKE', 'DYNAMIC_PAINT'}:
140             if not bpy.data.is_saved:
141                 layout.label(text="Cache is disabled until the file is saved")
142                 layout.enabled = False
143
144         if cache.use_disk_cache:
145             layout.prop(cache, "name", text="File Name")
146         else:
147             layout.prop(cache, "name", text="Cache Name")
148
149     if not cache.use_external or cachetype == 'SMOKE':
150         row = layout.row(align=True)
151
152         if cachetype not in {'PSYS', 'DYNAMIC_PAINT'}:
153             row.enabled = enabled
154             row.prop(cache, "frame_start")
155             row.prop(cache, "frame_end")
156         if cachetype not in {'SMOKE', 'CLOTH', 'DYNAMIC_PAINT', 'RIGID_BODY'}:
157             row.prop(cache, "frame_step")
158
159         if cachetype != 'SMOKE':
160             layout.label(text=cache.info)
161
162         can_bake = True
163
164         if cachetype not in {'SMOKE', 'DYNAMIC_PAINT', 'RIGID_BODY'}:
165             split = layout.split()
166             split.enabled = enabled and bpy.data.is_saved
167
168             col = split.column()
169             col.prop(cache, "use_disk_cache")
170
171             col = split.column()
172             col.active = cache.use_disk_cache
173             col.prop(cache, "use_library_path", "Use Lib Path")
174
175             row = layout.row()
176             row.enabled = enabled and bpy.data.is_saved
177             row.active = cache.use_disk_cache
178             row.label(text="Compression:")
179             row.prop(cache, "compression", expand=True)
180
181             layout.separator()
182
183             if cache.id_data.library:
184                 can_bake = False
185
186                 col = layout.column(align=True)
187                 col.label(text="Linked object baking requires Disk Cache to be enabled", icon='INFO')
188         else:
189             layout.separator()
190
191         split = layout.split()
192         split.active = can_bake
193
194         col = split.column()
195
196         if cache.is_baked is True:
197             col.operator("ptcache.free_bake", text="Free Bake")
198         else:
199             col.operator("ptcache.bake", text="Bake").bake = True
200
201         sub = col.row()
202         sub.enabled = (cache.frames_skipped or cache.is_outdated) and enabled
203         sub.operator("ptcache.bake", text="Calculate To Frame").bake = False
204
205         sub = col.column()
206         sub.enabled = enabled
207         sub.operator("ptcache.bake_from_cache", text="Current Cache to Bake")
208
209         col = split.column()
210         col.operator("ptcache.bake_all", text="Bake All Dynamics").bake = True
211         col.operator("ptcache.free_bake_all", text="Free All Bakes")
212         col.operator("ptcache.bake_all", text="Update All To Frame").bake = False
213
214
215 def effector_weights_ui(self, context, weights, weight_type):
216     layout = self.layout
217
218     layout.prop(weights, "group")
219
220     split = layout.split()
221
222     split.prop(weights, "gravity", slider=True)
223     split.prop(weights, "all", slider=True)
224
225     layout.separator()
226
227     split = layout.split()
228
229     col = split.column()
230     col.prop(weights, "force", slider=True)
231     col.prop(weights, "vortex", slider=True)
232     col.prop(weights, "magnetic", slider=True)
233     col.prop(weights, "wind", slider=True)
234     col.prop(weights, "curve_guide", slider=True)
235     col.prop(weights, "texture", slider=True)
236     if weight_type != 'SMOKE':
237         col.prop(weights, "smokeflow", slider=True)
238
239     col = split.column()
240     col.prop(weights, "harmonic", slider=True)
241     col.prop(weights, "charge", slider=True)
242     col.prop(weights, "lennardjones", slider=True)
243     col.prop(weights, "turbulence", slider=True)
244     col.prop(weights, "drag", slider=True)
245     col.prop(weights, "boid", slider=True)
246
247
248 def basic_force_field_settings_ui(self, context, field):
249     layout = self.layout
250
251     split = layout.split()
252
253     if not field or field.type == 'NONE':
254         return
255
256     col = split.column()
257
258     if field.type == 'DRAG':
259         col.prop(field, "linear_drag", text="Linear")
260     else:
261         col.prop(field, "strength")
262
263     if field.type == 'TURBULENCE':
264         col.prop(field, "size")
265         col.prop(field, "flow")
266     elif field.type == 'HARMONIC':
267         col.prop(field, "harmonic_damping", text="Damping")
268         col.prop(field, "rest_length")
269     elif field.type == 'VORTEX' and field.shape != 'POINT':
270         col.prop(field, "inflow")
271     elif field.type == 'DRAG':
272         col.prop(field, "quadratic_drag", text="Quadratic")
273     else:
274         col.prop(field, "flow")
275
276     col = split.column()
277     sub = col.column(align=True)
278     sub.prop(field, "noise")
279     sub.prop(field, "seed")
280     if field.type == 'TURBULENCE':
281         col.prop(field, "use_global_coords", text="Global")
282     elif field.type == 'HARMONIC':
283         col.prop(field, "use_multiple_springs")
284
285     split = layout.split()
286
287     col = split.column()
288     col.label(text="Effect point:")
289     col.prop(field, "apply_to_location")
290     col.prop(field, "apply_to_rotation")
291
292     col = split.column()
293     col.label(text="Collision:")
294     col.prop(field, "use_absorption")
295
296
297 def basic_force_field_falloff_ui(self, context, field):
298     layout = self.layout
299
300     split = layout.split(percentage=0.35)
301
302     if not field or field.type == 'NONE':
303         return
304
305     col = split.column()
306     col.prop(field, "z_direction", text="")
307
308     col = split.column()
309     col.prop(field, "falloff_power", text="Power")
310
311     split = layout.split()
312     col = split.column()
313     row = col.row(align=True)
314     row.prop(field, "use_min_distance", text="")
315     sub = row.row(align=True)
316     sub.active = field.use_min_distance
317     sub.prop(field, "distance_min", text="Minimum")
318
319     col = split.column()
320     row = col.row(align=True)
321     row.prop(field, "use_max_distance", text="")
322     sub = row.row(align=True)
323     sub.active = field.use_max_distance
324     sub.prop(field, "distance_max", text="Maximum")
325
326 if __name__ == "__main__":  # only for live edit.
327     bpy.utils.register_module(__name__)