Import Export Vertex Groups rewritten
[blender-addons-contrib.git] / system_keyboard_svg.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 # this script creates Keyboard layout images of the current keyboard configuration.
22 # the result will be writen to the blender default directory.
23
24 # first implementation done by jbakker
25
26 bl_info = {
27     "name": "Keyboard Layout (svg)",
28     "author": "Jbakker",
29     "version": (0, 1),
30     "blender": (2, 60, 0),
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.6/Py/'
35         'Scripts/System/keymaps_to_svg',
36     "tracker_url": "https://developer.blender.org/T21490",
37     "category": "System"}
38
39 import bpy
40
41 keyboard = (
42     ('`', 'ONE', 'TWO', 'THREE', 'FOUR', 'FIVE', 'SIX', 'SEVEN', 'EIGHT', 'NINE', 'ZERO', 'MINUS', 'EQUAL', 'BACKSPACE'),
43     ('TAB', 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I', 'O', 'P', '(', ')', '\\'),
44     ('CAPSLOCK', 'A', 'S', 'D', 'F', 'G', 'H', 'J', 'K', 'L', ';', "'", 'ENTER'),
45     ('SHIFT', 'Z', 'X', 'C', 'V', 'B', 'N', 'M', ',', '.', '/', 'SHIFT'),
46     ('CONTROL', 'OSKEY', 'ALT', 'SPACE', 'ALT', 'OSKEY', 'MENUKEY', 'CONTROL')
47     )
48
49 # default dimension of a single key [width, heidgh]
50 DEFAULT_KEY_DIMENSION = 100, 100
51 # alternative dimensions of specufic keys [keyname,[width, height]]
52 ALTERNATIVE_KEY_DIMENSIONS = {
53     'BACKSPACE': (250, 100),
54     'TAB': (175, 100),
55     '\\': (175, 100),
56     'CAPSLOCK': (225, 100),
57     'ENTER': (240, 100),
58     'SHIFT': (290, 100),
59     'CONTROL': (225, 100),
60     'ALT': (100, 100),
61     'OSKEY': (100, 100),
62     'MENUKEY': (100, 100),
63     'SPACE': (690, 100),
64 }
65
66
67 def createKeyboard(viewtype):
68     """
69     Creates a keyboard layout (.svg) file of the current configuration for a specific viewtype.
70     example of a viewtype is "VIEW_3D".
71     """
72     for keyconfig in bpy.data.window_managers[0].keyconfigs:
73         kc_map = {}
74         for keymap in keyconfig.keymaps:
75             if keymap.space_type == viewtype:
76                 for key in keymap.keymap_items:
77                     if key.map_type == 'KEYBOARD':
78                         test = 0
79                         pre = []
80                         cont = ""
81                         if key.ctrl:
82                             test = test + 1
83                             cont = "C"
84                         if key.alt:
85                             test = test + 2
86                             cont = cont + "A"
87                         if key.shift:
88                             test = test + 4
89                             cont = cont + "S"
90                         if key.oskey:
91                             test = test + 8
92                             cont = cont + "O"
93                         if len(cont) > 0:
94                             cont = "[" + cont + "] "
95                         ktype = key.type
96                         if ktype not in kc_map:
97                             kc_map[ktype] = []
98                         kc_map[ktype].append((test, cont + key.name))
99
100         filename = "keyboard_%s.svg" % viewtype
101         print(filename)
102         svgfile = open(filename, "w")
103         svgfile.write("""<?xml version="1.0" standalone="no"?>
104     <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
105     """)
106         svgfile.write("""<svg width="2000" height="800" version="1.1" xmlns="http://www.w3.org/2000/svg">
107     """)
108         svgfile.write("""<style>
109     rect {
110         fill:rgb(192,192,192);
111         stroke-width:1;
112         stroke:rgb(0,0,0);
113     }
114     text.header {
115         font-size:xx-large;
116     }
117     text.key {
118         stroke-width:1;
119         stroke:rgb(0,0,0);
120     }
121     text.action {
122         font-size:smaller;
123     }
124     text.add0 {
125         font-size:smaller;
126         fill:rgb(0,0,0)
127     }
128     text.add1 {
129         font-size:smaller;
130         fill:rgb(255,0,0)
131     }
132     text.add2 {
133         font-size:smaller;
134         fill:rgb(0,255,0)
135     }
136     text.add3 {
137        font-size:smaller;
138        fill:rgb(128,128,0)
139     }
140     text.add4 {
141         font-size:smaller;
142         fill:rgb(0,0,255)
143     }
144     text.add5 {
145         font-size:smaller;
146         fill:rgb(128,0,128)
147     }
148     text.add6 {
149         font-size:smaller;
150         fill:rgb(0, 128, 128)
151     }
152     text.add7 {
153         font-size:smaller;
154         fill:rgb(128,128,128)
155     }
156     text.add8 {
157         font-size:smaller;
158         fill:rgb(128,128,128)
159     }
160     text.add9 {
161         font-size:smaller;
162         fill:rgb(255,128,128)
163     }
164     text.add10 {
165         font-size:smaller;
166         fill:rgb(128,255,128)
167     }
168     text.add11 {
169         font-size:smaller;
170         fill:rgb(255,255,128)
171     }
172     text.add12 {
173         font-size:smaller;
174         fill:rgb(128,128,255)
175     }
176     text.add13 {
177         font-size:smaller;
178         fill:rgb(255,128,255)
179     }
180     text.add14 {
181         font-size:smaller;
182         fill:rgb(128,255,255)
183     }
184     text.add15 {
185         font-size:smaller;
186         fill:rgb(255,255,128)
187     }
188     </style>
189     """)
190         svgfile.write("""<text class="header" x="100" y="24">keyboard layout - """ + viewtype + """</text>
191 """)
192
193         x = 0
194         xgap = 15
195         ygap = 15
196         y = 32
197         for row in keyboard:
198             x = 0
199             for key in row:
200                 width, height = ALTERNATIVE_KEY_DIMENSIONS.get(key, DEFAULT_KEY_DIMENSION)
201                 tx = 16
202                 ty = 16
203                 svgfile.write("""<rect x=\"""" + str(x) +
204                               """\" y=\"""" + str(y) +
205                               """\" width=\"""" + str(width) +
206                               """\" height=\"""" + str(height) +
207                               """\" rx="20" ry="20" />
208     """)
209                 svgfile.write("""<text class="key" x=\"""" + str(x + tx) +
210                               """\" y=\"""" + str(y + ty) +
211                               """\" width=\"""" + str(width) +
212                               """\" height=\"""" + str(height) + """\">
213     """)
214                 svgfile.write(key)
215                 svgfile.write("</text>")
216                 ty = ty + 16
217                 tx = 4
218                 if key in kc_map:
219                     for a in kc_map[key]:
220                         svgfile.write("""<text class="add""" + str(a[0]) +
221                                       """" x=\"""" + str(x + tx) +
222                                       """\" y=\"""" + str(y + ty) +
223                                       """\" width=\"""" + str(width) +
224                                       """\" height=\"""" + str(height) + """\">
225     """)
226                         svgfile.write(a[1])
227                         svgfile.write("</text>")
228                         ty = ty + 16
229                 x = x + width + xgap
230             y = y + 100 + ygap
231         svgfile.write("""</svg>""")
232         svgfile.flush()
233         svgfile.close()
234
235
236 class WM_OT_Keyboardlayout(bpy.types.Operator):
237     """
238         Windows manager operator for keyboard leyout export
239     """
240     bl_idname = "wm.keyboardlayout"
241     bl_label = "Keyboard layout (SVG)"
242
243     def execute(self, context):
244         """
245         Iterate over all viewtypes to export the keyboard layout.
246         """
247         for vt in ('VIEW_3D',
248                    'LOGIC_EDITOR',
249                    'NODE_EDITOR',
250                    'CONSOLE',
251                    'GRAPH_EDITOR',
252                    'PROPERTIES',
253                    'SEQUENCE_EDITOR',
254                    'OUTLINER',
255                    'IMAGE_EDITOR',
256                    'TEXT_EDITOR',
257                    'DOPESHEET_EDITOR',
258                    'Window'):
259
260             createKeyboard(vt)
261         return {'FINISHED'}
262
263
264 def register():
265     bpy.utils.register_module(__name__)
266
267
268 def unregister():
269     bpy.utils.unregister_module(__name__)
270
271 if __name__ == "__main__":
272     register()