29f0df8b4c37bd9139f5278dbf57fed436405f72
[blender-addons-contrib.git] / system_keyboard_svg.py
1 # ***** BEGIN GPL LICENSE BLOCK *****
2 #
3 #
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software Foundation,
16 # Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
17 #
18 # ***** END GPL LICENCE BLOCK *****
19 # this script creates Keyboard layout images of the current keyboard configuration.
20 # the result will be writen to the blender default directory.
21
22 # first implementation done by jbakker
23 # <pep8 compliant>
24
25 bl_info = {
26     "name": "Keyboard Layout (svg)",
27     "author": "Jbakker",
28     "version": (0, 1),
29     "blender": (2, 6, 0),
30     "api": 41875,
31     "location": "",
32     "description": "Save the hotkeys as a .svg file (search: Keyboard)",
33     "warning": "may not work in recent svn",
34     "wiki_url": 'http://wiki.blender.org/index.php/Extensions:2.5/Py/' \
35         'Scripts/System/keymaps_to_svg',
36     "tracker_url": "https://projects.blender.org/tracker/index.php?" \
37         "func==detail&aid=21490",
38     "category": "System"}
39
40 import bpy
41
42 keyboard = [
43 ['`', 'ONE', 'TWO', 'THREE', 'FOUR', 'FIVE', 'SIX', 'SEVEN', 'EIGHT', 'NINE', 'ZERO', 'MINUS', 'EQUAL', 'BACKSPACE'],
44 ['TAB', 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I', 'O', 'P', '[', ']', '\\'],
45 ['CAPSLOCK', 'A', 'S', 'D', 'F', 'G', 'H', 'J', 'K', 'L', ';', "'", 'ENTER'],
46 ['SHIFT', 'Z', 'X', 'C', 'V', 'B', 'N', 'M', ',', '.', '/', 'SHIFT'],
47 ['CONTROL', 'OSKEY', 'ALT', 'SPACE', 'ALT', 'OSKEY', 'MENUKEY', 'CONTROL']
48 ]
49
50 # default dimension of a single key [width, heidgh]
51 DEFAULT_KEY_DIMENSION = [100, 100]
52 # alternative dimensions of specufic keys [keyname,[width, height]]
53 ALTERNATIVE_KEY_DIMENSIONS = {
54 'BACKSPACE': [250, 100],
55 'TAB': [175, 100],
56 '\\': [175, 100],
57 'CAPSLOCK': [225, 100],
58 'ENTER': [240, 100],
59 'SHIFT': [290, 100],
60 'CONTROL': [225, 100],
61 'ALT': [100, 100],
62 'OSKEY': [100, 100],
63 'MENUKEY': [100, 100],
64 'SPACE': [690, 100],
65 }
66
67
68 def createKeyboard(viewtype):
69     """
70     Creates a keyboard layout (.svg) file of the current configuration for a specific viewtype.
71     example of a viewtype is "VIEW_3D".
72     """
73     for keyconfig in bpy.data.window_managers[0].keyconfigs:
74         map = {}
75         for keymap in keyconfig.keymaps:
76             if keymap.space_type in [viewtype]:
77                 for key in keymap.keymap_items:
78                     if key.map_type == 'KEYBOARD':
79                         test = 0
80                         pre = []
81                         cont = ""
82                         if key.ctrl:
83                             test = test + 1
84                             cont = "C"
85                         if key.alt:
86                             test = test + 2
87                             cont = cont + "A"
88                         if key.shift:
89                             test = test + 4
90                             cont = cont + "S"
91                         if key.oskey:
92                             test = test + 8
93                             cont = cont + "O"
94                         if len(cont) > 0:
95                             cont = "[" + cont + "] "
96                         ktype = key.type
97                         if ktype not in map.keys():
98                             map[ktype] = []
99                         map[ktype].append((test, cont + key.name))
100
101         filename = "keyboard_" + viewtype + ".svg"
102         print(filename)
103         svgfile = open(filename, "w")
104         svgfile.write("""<?xml version="1.0" standalone="no"?>
105     <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
106     """)
107         svgfile.write("""<svg width="2000" height="800" version="1.1" xmlns="http://www.w3.org/2000/svg">
108     """)
109         svgfile.write("""<style>
110     rect {
111         fill:rgb(192,192,192);
112         stroke-width:1;
113         stroke:rgb(0,0,0);
114     }
115     text.header {
116         font-size:xx-large;
117     }
118     text.key {
119         stroke-width:1;
120         stroke:rgb(0,0,0);
121     }
122     text.action {
123         font-size:smaller;
124     }
125     text.add0 {
126         font-size:smaller;
127         fill:rgb(0,0,0)
128     }
129     text.add1 {
130         font-size:smaller;
131         fill:rgb(255,0,0)
132     }
133     text.add2 {
134         font-size:smaller;
135         fill:rgb(0,255,0)
136     }
137     text.add3 {
138        font-size:smaller;
139        fill:rgb(128,128,0)
140     }
141     text.add4 {
142         font-size:smaller;
143         fill:rgb(0,0,255)
144     }
145     text.add5 {
146         font-size:smaller;
147         fill:rgb(128,0,128)
148     }
149     text.add6 {
150         font-size:smaller;
151         fill:rgb(0, 128, 128)
152     }
153     text.add7 {
154         font-size:smaller;
155         fill:rgb(128,128,128)
156     }
157     text.add8 {
158         font-size:smaller;
159         fill:rgb(128,128,128)
160     }
161     text.add9 {
162         font-size:smaller;
163         fill:rgb(255,128,128)
164     }
165     text.add10 {
166         font-size:smaller;
167         fill:rgb(128,255,128)
168     }
169     text.add11 {
170         font-size:smaller;
171         fill:rgb(255,255,128)
172     }
173     text.add12 {
174         font-size:smaller;
175         fill:rgb(128,128,255)
176     }
177     text.add13 {
178         font-size:smaller;
179         fill:rgb(255,128,255)
180     }
181     text.add14 {
182         font-size:smaller;
183         fill:rgb(128,255,255)
184     }
185     text.add15 {
186         font-size:smaller;
187         fill:rgb(255,255,128)
188     }
189     </style>
190     """)
191         svgfile.write("""<text class="header" x="100" y="24">keyboard layout - """ + viewtype + """</text>
192 """)
193
194         x = 0
195         xgap = 15
196         ygap = 15
197         y = 32
198         for row in keyboard:
199             x = 0
200             for key in row:
201                 width = DEFAULT_KEY_DIMENSION[0]
202                 height = DEFAULT_KEY_DIMENSION[1]
203                 if key in ALTERNATIVE_KEY_DIMENSIONS.keys():
204                     width = ALTERNATIVE_KEY_DIMENSIONS[key][0]
205                     height = ALTERNATIVE_KEY_DIMENSIONS[key][1]
206                 tx = 16
207                 ty = 16
208                 svgfile.write("""<rect x=\"""" + str(x) + """\" y=\"""" + str(y) + """\" width=\"""" + str(width) + """\" height=\"""" + str(height) + """\" rx="20" ry="20" />
209     """)
210                 svgfile.write("""<text class="key" x=\"""" + str(x + tx) + """\" y=\"""" + str(y + ty) + """\" width=\"""" + str(width) + """\" height=\"""" + str(height) + """\">
211     """)
212                 svgfile.write(key)
213                 svgfile.write("</text>")
214                 ty = ty + 16
215                 tx = 4
216                 if key in map.keys():
217                     for a in map[key]:
218                         svgfile.write("""<text class="add""" + str(a[0]) + """" x=\"""" + str(x + tx) + """\" y=\"""" + str(y + ty) + """\" width=\"""" + str(width) + """\" height=\"""" + str(height) + """\">
219     """)
220                         svgfile.write(a[1])
221                         svgfile.write("</text>")
222                         ty = ty + 16
223                 x = x + width + xgap
224             y = y + 100 + ygap
225         svgfile.write("""</svg>""")
226         svgfile.flush()
227         svgfile.close()
228
229
230 class WM_OT_Keyboardlayout(bpy.types.Operator):
231     """
232         Windows manager operator for keyboard leyout export
233     """
234     bl_idname = "wm.keyboardlayout"
235     bl_label = "Keyboard layout (SGV)"
236
237     def execute(self, context):
238         """
239         Iterate over all viewtypes to export the keyboard layout.
240         """
241         for vt in ['VIEW_3D', 'LOGIC_EDITOR', 'NODE_EDITOR', 'CONSOLE', 'GRAPH_EDITOR', 'PROPERTIES', 'SEQUENCE_EDITOR', 'OUTLINER', 'IMAGE_EDITOR', 'TEXT_EDITOR', 'DOPESHEET_EDITOR', 'Window']:
242             createKeyboard(vt)
243         return {'FINISHED'}
244
245
246 def register():
247     bpy.utils.register_module(__name__)
248
249
250 def unregister():
251     bpy.utils.unregister_module(__name__)
252
253 if __name__ == "__main__":
254     register()