Keying Sets: Export to File
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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             subcol.operator("anim.keying_set_export", text="Export to File")
109
110             if wide_ui:
111                 col = row.column()
112             col.label(text="Keyframing Settings:")
113             col.prop(ks, "insertkey_needed", text="Needed")
114             col.prop(ks, "insertkey_visual", text="Visual")
115             col.prop(ks, "insertkey_xyz_to_rgb", text="XYZ to RGB")
116
117
118 class SCENE_PT_keying_set_paths(SceneButtonsPanel):
119     bl_label = "Active Keying Set"
120
121     def poll(self, context):
122         return (context.scene.active_keying_set is not None)
123
124     def draw(self, context):
125         layout = self.layout
126
127         scene = context.scene
128         ks = scene.active_keying_set
129         wide_ui = context.region.width > narrowui
130
131         row = layout.row()
132         row.label(text="Paths:")
133
134         row = layout.row()
135
136         col = row.column()
137         col.template_list(ks, "paths", ks, "active_path_index", rows=2)
138
139         col = row.column(align=True)
140         col.operator("anim.keying_set_path_add", icon='ZOOMIN', text="")
141         col.operator("anim.keying_set_path_remove", icon='ZOOMOUT', text="")
142
143         ksp = ks.active_path
144         if ksp:
145             col = layout.column()
146             col.label(text="Target:")
147             col.template_any_ID(ksp, "id", "id_type")
148             col.template_path_builder(ksp, "data_path", ksp.id)
149
150
151             row = layout.row()
152
153             col = row.column()
154             col.label(text="Array Target:")
155             col.prop(ksp, "entire_array")
156             if ksp.entire_array is False:
157                 col.prop(ksp, "array_index")
158
159             if wide_ui:
160                 col = row.column()
161             col.label(text="F-Curve Grouping:")
162             col.prop(ksp, "grouping")
163             if ksp.grouping == 'NAMED':
164                 col.prop(ksp, "group")
165
166
167 class SCENE_PT_physics(SceneButtonsPanel):
168     bl_label = "Gravity"
169     COMPAT_ENGINES = {'BLENDER_RENDER'}
170
171     def draw_header(self, context):
172         self.layout.prop(context.scene, "use_gravity", text="")
173
174     def draw(self, context):
175         layout = self.layout
176
177         scene = context.scene
178         wide_ui = context.region.width > narrowui
179
180         layout.active = scene.use_gravity
181
182         if wide_ui:
183             layout.prop(scene, "gravity", text="")
184         else:
185             layout.column().prop(scene, "gravity", text="")
186
187
188 class SCENE_PT_simplify(SceneButtonsPanel):
189     bl_label = "Simplify"
190     COMPAT_ENGINES = {'BLENDER_RENDER'}
191
192     def draw_header(self, context):
193         scene = context.scene
194         rd = scene.render_data
195         self.layout.prop(rd, "use_simplify", text="")
196
197     def draw(self, context):
198         layout = self.layout
199         scene = context.scene
200         rd = scene.render_data
201         wide_ui = context.region.width > narrowui
202
203         layout.active = rd.use_simplify
204
205         split = layout.split()
206
207         col = split.column()
208         col.prop(rd, "simplify_subdivision", text="Subdivision")
209         col.prop(rd, "simplify_child_particles", text="Child Particles")
210
211         if wide_ui:
212             col = split.column()
213         col.prop(rd, "simplify_shadow_samples", text="Shadow Samples")
214         col.prop(rd, "simplify_ao_sss", text="AO and SSS")
215
216 bpy.types.register(SCENE_PT_scene)
217 bpy.types.register(SCENE_PT_unit)
218 bpy.types.register(SCENE_PT_keying_sets)
219 bpy.types.register(SCENE_PT_keying_set_paths)
220 bpy.types.register(SCENE_PT_physics)
221 bpy.types.register(SCENE_PT_simplify)
222
223 bpy.types.register(SCENE_PT_custom_props)
224
225 ################################
226
227 from bpy.props import *
228
229 class ANIM_OT_keying_set_export(bpy.types.Operator):
230     "Export Keying Set to a python script."
231     bl_idname = "anim.keying_set_export"
232     bl_label = "Export Keying Set..."
233
234     path = bpy.props.StringProperty(name="File Path", description="File path to write file to.")
235     filename = bpy.props.StringProperty(name="File Name", description="Name of the file.")
236     directory = bpy.props.StringProperty(name="Directory", description="Directory of the file.")
237     filter_folder = bpy.props.BoolProperty(name="Filter folders", description="", default=True, hidden=True)
238     filter_text = bpy.props.BoolProperty(name="Filter text", description="", default=True, hidden=True)
239     filter_python = bpy.props.BoolProperty(name="Filter python", description="", default=True, hidden=True)
240
241     def execute(self, context):
242         if not self.properties.path:
243             raise Exception("File path not set.")
244
245         f = open(self.properties.path, "w")
246         if not f:
247             raise Exception("Could not open file.")
248
249         scene = context.scene
250         ks = scene.active_keying_set
251         
252         # TODO:
253         #   - build a table of aliases for the ID's which
254         #     gets utilised to speed up the reloading process
255         #   - add code which sets the keyframing/relative state info
256         #     for the keyingset
257
258         f.write('# Keying Set: %s\n' % ks.name)
259         
260         f.write("import bpy\n\n")
261         f.write("scene= bpy.data.scenes[0]\n\n")
262
263         f.write("ks= scene.add_keying_set(name=\"%s\")\n" % ks.name)
264         for ksp in ks.paths:
265             f.write("ks.add_destination(")
266             
267             # id-block + RNA-path
268             if ksp.id:
269                 # idtype_list is used to get a path to the ID-datablock using bpy.data.*
270                 # but since this info isn't available, we try to construct it here
271                 #   id.bl_rna.name gives a name suitable for UI, 
272                 #   with a capitalised first letter, but we need
273                 #   the plural form that's all lower case
274                 idtype_path = ksp.id.bl_rna.name.lower() + "s"
275                 id_bpy_path = "bpy.data.%s[\"%s\"]" % (idtype_path, ksp.id.name)
276             else:
277                 id_bpy_path = "None" # XXX... 
278             f.write("%s, '%s'" % (id_bpy_path, ksp.data_path))
279             
280             # array index settings (if applicable)
281             if ksp.entire_array is False:
282                 f.write(", entire_array=False, array_index=%d" % ksp.array_index)
283             
284             # grouping settings (if applicable)
285             # NOTE: the current default is KEYINGSET, but if this changes, change this code too
286             if ksp.grouping == 'NAMED':
287                 f.write(", grouping_method='%s', group_name=\"%s\"" % (ksp.grouping, ksp.group))
288             elif ksp.grouping != 'KEYINGSET':
289                 f.write(", grouping_method='%s'" % ksp.grouping)
290             
291             # finish off
292             f.write(")\n")
293         
294         f.write("\n")
295         f.close()
296
297         return {'FINISHED'}
298
299     def invoke(self, context, event):
300         wm = context.manager
301         wm.add_fileselect(self)
302         return {'RUNNING_MODAL'}
303
304 bpy.types.register(ANIM_OT_keying_set_export)