change python scripts so modules which register with blender have a register() functi...
[blender.git] / release / scripts / ui / properties_scene.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 rna_prop_ui import PropertyPanel
22
23 narrowui = 180
24
25
26 class SceneButtonsPanel(bpy.types.Panel):
27     bl_space_type = 'PROPERTIES'
28     bl_region_type = 'WINDOW'
29     bl_context = "scene"
30
31     def poll(self, context):
32         return context.scene
33
34
35 class SCENE_PT_scene(SceneButtonsPanel):
36     bl_label = "Scene"
37     COMPAT_ENGINES = {'BLENDER_RENDER'}
38
39     def draw(self, context):
40         layout = self.layout
41         wide_ui = context.region.width > narrowui
42         scene = context.scene
43
44         if wide_ui:
45             layout.prop(scene, "camera")
46             layout.prop(scene, "set", text="Background")
47         else:
48             layout.prop(scene, "camera", text="")
49             layout.prop(scene, "set", text="")
50
51
52 class SCENE_PT_custom_props(SceneButtonsPanel, PropertyPanel):
53     _context_path = "scene"
54
55
56 class SCENE_PT_unit(SceneButtonsPanel):
57     bl_label = "Units"
58     COMPAT_ENGINES = {'BLENDER_RENDER'}
59
60     def draw(self, context):
61         layout = self.layout
62         wide_ui = context.region.width > narrowui
63         unit = context.scene.unit_settings
64
65         col = layout.column()
66         col.row().prop(unit, "system", expand=True)
67
68         split = layout.split()
69         split.active = (unit.system != 'NONE')
70
71         col = split.column()
72         col.prop(unit, "scale_length", text="Scale")
73
74         if wide_ui:
75             col = split.column()
76         col.prop(unit, "use_separate")
77
78         layout.column().prop(unit, "rotation_units")
79
80
81 class SCENE_PT_keying_sets(SceneButtonsPanel):
82     bl_label = "Keying Sets"
83
84     def draw(self, context):
85         layout = self.layout
86
87         scene = context.scene
88         wide_ui = context.region.width > narrowui
89         row = layout.row()
90
91         col = row.column()
92         col.template_list(scene, "keying_sets", scene, "active_keying_set_index", rows=2)
93
94         col = row.column(align=True)
95         col.operator("anim.keying_set_add", icon='ZOOMIN', text="")
96         col.operator("anim.keying_set_remove", icon='ZOOMOUT', text="")
97
98         ks = scene.active_keying_set
99         if ks:
100             row = layout.row()
101
102             col = row.column()
103             col.prop(ks, "name")
104             col.prop(ks, "absolute")
105             
106             subcol = col.column()
107             subcol.operator_context = 'INVOKE_DEFAULT'
108             op = subcol.operator("anim.keying_set_export", text="Export to File")
109             op.path = "keyingset.py"
110
111             if wide_ui:
112                 col = row.column()
113             col.label(text="Keyframing Settings:")
114             col.prop(ks, "insertkey_needed", text="Needed")
115             col.prop(ks, "insertkey_visual", text="Visual")
116             col.prop(ks, "insertkey_xyz_to_rgb", text="XYZ to RGB")
117
118
119 class SCENE_PT_keying_set_paths(SceneButtonsPanel):
120     bl_label = "Active Keying Set"
121
122     def poll(self, context):
123         return (context.scene.active_keying_set is not None)
124
125     def draw(self, context):
126         layout = self.layout
127
128         scene = context.scene
129         ks = scene.active_keying_set
130         wide_ui = context.region.width > narrowui
131
132         row = layout.row()
133         row.label(text="Paths:")
134
135         row = layout.row()
136
137         col = row.column()
138         col.template_list(ks, "paths", ks, "active_path_index", rows=2)
139
140         col = row.column(align=True)
141         col.operator("anim.keying_set_path_add", icon='ZOOMIN', text="")
142         col.operator("anim.keying_set_path_remove", icon='ZOOMOUT', text="")
143
144         ksp = ks.active_path
145         if ksp:
146             col = layout.column()
147             col.label(text="Target:")
148             col.template_any_ID(ksp, "id", "id_type")
149             col.template_path_builder(ksp, "data_path", ksp.id)
150
151
152             row = layout.row()
153
154             col = row.column()
155             col.label(text="Array Target:")
156             col.prop(ksp, "entire_array")
157             if ksp.entire_array is False:
158                 col.prop(ksp, "array_index")
159
160             if wide_ui:
161                 col = row.column()
162             col.label(text="F-Curve Grouping:")
163             col.prop(ksp, "grouping")
164             if ksp.grouping == 'NAMED':
165                 col.prop(ksp, "group")
166
167
168 class SCENE_PT_physics(SceneButtonsPanel):
169     bl_label = "Gravity"
170     COMPAT_ENGINES = {'BLENDER_RENDER'}
171
172     def draw_header(self, context):
173         self.layout.prop(context.scene, "use_gravity", text="")
174
175     def draw(self, context):
176         layout = self.layout
177
178         scene = context.scene
179         wide_ui = context.region.width > narrowui
180
181         layout.active = scene.use_gravity
182
183         if wide_ui:
184             layout.prop(scene, "gravity", text="")
185         else:
186             layout.column().prop(scene, "gravity", text="")
187
188
189 class SCENE_PT_simplify(SceneButtonsPanel):
190     bl_label = "Simplify"
191     COMPAT_ENGINES = {'BLENDER_RENDER'}
192
193     def draw_header(self, context):
194         scene = context.scene
195         rd = scene.render_data
196         self.layout.prop(rd, "use_simplify", text="")
197
198     def draw(self, context):
199         layout = self.layout
200         scene = context.scene
201         rd = scene.render_data
202         wide_ui = context.region.width > narrowui
203
204         layout.active = rd.use_simplify
205
206         split = layout.split()
207
208         col = split.column()
209         col.prop(rd, "simplify_subdivision", text="Subdivision")
210         col.prop(rd, "simplify_child_particles", text="Child Particles")
211         
212         col.prop(rd, "simplify_triangulate")
213
214         if wide_ui:
215             col = split.column()
216         col.prop(rd, "simplify_shadow_samples", text="Shadow Samples")
217         col.prop(rd, "simplify_ao_sss", text="AO and SSS")
218
219
220 from bpy.props import *
221
222
223 class ANIM_OT_keying_set_export(bpy.types.Operator):
224     "Export Keying Set to a python script."
225     bl_idname = "anim.keying_set_export"
226     bl_label = "Export Keying Set..."
227
228     path = bpy.props.StringProperty(name="File Path", description="File path to write file to.")
229     filename = bpy.props.StringProperty(name="File Name", description="Name of the file.")
230     directory = bpy.props.StringProperty(name="Directory", description="Directory of the file.")
231     filter_folder = bpy.props.BoolProperty(name="Filter folders", description="", default=True, options={'HIDDEN'})
232     filter_text = bpy.props.BoolProperty(name="Filter text", description="", default=True, options={'HIDDEN'})
233     filter_python = bpy.props.BoolProperty(name="Filter python", description="", default=True, options={'HIDDEN'})
234
235     def execute(self, context):
236         if not self.properties.path:
237             raise Exception("File path not set.")
238
239         f = open(self.properties.path, "w")
240         if not f:
241             raise Exception("Could not open file.")
242
243         scene = context.scene
244         ks = scene.active_keying_set
245         
246         
247         f.write("# Keying Set: %s\n" % ks.name)
248         
249         f.write("import bpy\n\n")
250         f.write("scene= bpy.data.scenes[0]\n\n")
251
252         # Add KeyingSet and set general settings 
253         f.write("# Keying Set Level declarations\n")
254         f.write("ks= scene.add_keying_set(name=\"%s\")\n" % ks.name)
255         
256         if ks.absolute is False:
257             f.write("ks.absolute = False\n")
258         f.write("\n")
259         
260         f.write("ks.insertkey_needed = %s\n" % ks.insertkey_needed)
261         f.write("ks.insertkey_visual = %s\n" % ks.insertkey_visual)
262         f.write("ks.insertkey_xyz_to_rgb = %s\n" % ks.insertkey_xyz_to_rgb)
263         f.write("\n")
264         
265         
266         # generate and write set of lookups for id's used in paths
267         id_to_paths_cache = {} # cache for syncing ID-blocks to bpy paths + shorthands
268         
269         for ksp in ks.paths:
270             if ksp.id is None:
271                 continue;
272             if ksp.id in id_to_paths_cache:
273                 continue;
274                 
275             # - idtype_list is used to get the list of id-datablocks from bpy.data.*
276             #   since this info isn't available elsewhere
277             # - id.bl_rna.name gives a name suitable for UI, 
278             #   with a capitalised first letter, but we need
279             #   the plural form that's all lower case
280             idtype_list = ksp.id.bl_rna.name.lower() + "s"
281             id_bpy_path = "bpy.data.%s[\"%s\"]" % (idtype_list, ksp.id.name)
282             
283             # shorthand ID for the ID-block (as used in the script)
284             short_id = "id_%d" % len(id_to_paths_cache)
285             
286             # store this in the cache now
287             id_to_paths_cache[ksp.id] = [short_id, id_bpy_path]
288             
289         f.write("# ID's that are commonly used\n")
290         for id_pair in id_to_paths_cache.values():
291             f.write("%s = %s\n" % (id_pair[0], id_pair[1]))
292         f.write("\n")
293         
294         
295         # write paths
296         f.write("# Path Definitions\n") 
297         for ksp in ks.paths:
298             f.write("ksp = ks.add_destination(")
299             
300             # id-block + RNA-path
301             if ksp.id:
302                 # find the relevant shorthand from the cache
303                 id_bpy_path = id_to_paths_cache[ksp.id][0]
304             else:
305                 id_bpy_path = "None" # XXX... 
306             f.write("%s, '%s'" % (id_bpy_path, ksp.data_path))
307             
308             # array index settings (if applicable)
309             if ksp.entire_array is False:
310                 f.write(", entire_array=False, array_index=%d" % ksp.array_index)
311             
312             # grouping settings (if applicable)
313             # NOTE: the current default is KEYINGSET, but if this changes, change this code too
314             if ksp.grouping == 'NAMED':
315                 f.write(", grouping_method='%s', group_name=\"%s\"" % (ksp.grouping, ksp.group))
316             elif ksp.grouping != 'KEYINGSET':
317                 f.write(", grouping_method='%s'" % ksp.grouping)
318             
319             # finish off
320             f.write(")\n")
321         
322         f.write("\n")
323         f.close()
324
325         return {'FINISHED'}
326
327     def invoke(self, context, event):
328         wm = context.manager
329         wm.add_fileselect(self)
330         return {'RUNNING_MODAL'}
331
332
333 classes = [
334     ANIM_OT_keying_set_export]
335
336
337 def register():
338     register = bpy.types.register
339     for cls in classes:
340         register(cls)
341
342 def unregister():
343     unregister = bpy.types.unregister
344     for cls in classes:
345         unregister(cls)