-
Notifications
You must be signed in to change notification settings - Fork 0
/
bingo.py
366 lines (313 loc) · 15.5 KB
/
bingo.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
#!/usr/bin/env python
# coding=utf-8
#
# Copyright (C) 2022 Kaalleen
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
"""
This extension generates bingo cards.
If used with a template open it will insert itself into the correct positions.
The template can force parameters through a rectangle with a special id starting with 'bingo-area'
or a label starting with "Bingo Area".
"""
from random import shuffle
from inkex import (NSS, Boolean, GenerateExtension, Group, Line, Rectangle,
TextElement, Transform, Tspan, colors, errormsg)
from inkex.localization import inkex_gettext as _
class BingoCardCreator(GenerateExtension):
"""Outputs bingo cards as a svg fragment"""
container_layer = True
def container_transform(self):
return Transform(translate=(0, 0))
def add_arguments(self, pars):
# tabs
self.arg_parser.add_argument("--tabs", type=str, default=None, dest="tabs")
self.arg_parser.add_argument("--content-tab", type=str, default=None, dest="content_tab")
self.arg_parser.add_argument("--layout-tab", type=str, default=None, dest="layout_tab")
self.arg_parser.add_argument("--template-tab", type=str, default=None, dest="template_tab")
# headline, font size and colors
pars.add_argument("--card_header", type=str, default="", dest="card_header")
pars.add_argument("--font_size", type=float, default=10, dest="font_size")
pars.add_argument("--header_color", type=colors.Color, default=colors.Color('#e01b24'),
dest="header_color")
pars.add_argument("--num_color", type=colors.Color, default=colors.Color('#000000'),
dest="num_color")
# grid
pars.add_argument("--rows", type=int, default=5, dest="rows")
pars.add_argument("--columns", type=int, default=5, dest="columns")
pars.add_argument("--grid_size", type=float, default=20, dest="grid_size")
pars.add_argument("--render_grid", type=Boolean, default=True, dest="render_grid")
pars.add_argument("--stroke_width", type=float, default=1, dest="stroke_width")
pars.add_argument("--num_range", type=int, default=15, dest="num_range")
# free spaces
pars.add_argument("--free_center", type=Boolean, default=True, dest="free_center")
pars.add_argument("--free_rows", type=int, default=0, dest="free_rows")
# template
pars.add_argument("--create_area", type=Boolean, default=False, dest="create_area")
def generate(self):
self.options.grid_height = self.options.grid_size
self.options.grid_width = self.options.grid_size
self.options.free_spaces = None
if self.options.rows < 1 or self.options.columns < 1:
return
if self.options.create_area:
bingo_area = self._generate_bingo_area()
yield bingo_area
# set a label to the automatically generated layer
self._set_layer_label(bingo_area.getparent())
return
template_bingo_fields = self._get_template_fields()
if not any(field.tag_name == 'rect' for field in template_bingo_fields):
numbers = self._get_numbers()
number_group = self._render_numbers(numbers)
grid_group = self._render_grid()
yield number_group
yield grid_group
else:
for bingo_field in template_bingo_fields:
# reset clone and bingo_group_transform
bingo_clone = None
bingo_group_transform = None
if bingo_field.tag_name == "use":
bingo_clone = bingo_field
bingo_field, bingo_group_transform = self._get_clone_origin(bingo_field)
if bingo_field is None:
continue
# template parameters (will be inherited to subsequent bingo_fields)
self._load_area_params(bingo_field)
# set grid size
self.options.grid_height = float(bingo_field.get('height')) / self.options.rows
self.options.grid_width = float(bingo_field.get('width')) / self.options.columns
# generate numbers and grid
numbers = self._get_numbers()
number_group = self._render_numbers(numbers)
grid_group = self._render_grid()
transform = self._get_transform(bingo_field, bingo_clone, bingo_group_transform)
number_group.set('transform', transform)
if grid_group is not None:
grid_group.set('transform', transform)
yield number_group
yield grid_group
# set a label to the automatically generated layer
self._set_layer_label(number_group.getparent())
def _generate_bingo_area(self):
width = self.options.grid_size * self.options.columns
height = self.options.grid_size * self.options.rows
args = {'style': "fill:#cceeff;",
'bingo-headline': self.options.card_header,
'bingo-font-size': self.options.font_size,
'bingo-headline-color': self.options.header_color,
'bingo-column-range': self.options.num_range,
'bingo-color': self.options.num_color,
'bingo-columns': self.options.columns,
'bingo-rows': self.options.rows,
'bingo-render-grid': str(self.options.render_grid),
'bingo-stroke-width': self.options.stroke_width,
'bingo-star': str(self.options.free_center),
'bingo-free-rows': self.options.free_rows}
bingo_area = Rectangle().new(0, 0, width, height, **args)
bingo_area.label = "Bingo Area"
bingo_area.set_id(self.svg.get_unique_id("bingo-area_"))
return bingo_area
def _load_area_params(self, bingo_field):
# load template "bingo area" params
try:
self.options.card_header = bingo_field.get('bingo-headline', self.options.card_header)
self.options.font_size = float(bingo_field.get(
'bingo-font-size',
self.options.font_size
))
self.options.header_color = colors.Color(bingo_field.get(
'bingo-headline-color',
self.options.header_color
))
self.options.num_color = colors.Color(bingo_field.get(
'bingo-color',
self.options.num_color
))
self.options.num_range = int(bingo_field.get(
'bingo-column-range',
self.options.num_range
))
self.options.columns = int(bingo_field.get('bingo-columns', self.options.columns))
self.options.rows = int(bingo_field.get('bingo-rows', self.options.rows))
self.options.render_grid = Boolean(bingo_field.get(
'bingo-render-grid',
str(self.options.render_grid)
))
self.options.stroke_width = float(bingo_field.get(
'bingo-stroke-width',
self.options.stroke_width
))
self.options.free_spaces = bingo_field.get('bingo-free', None)
self.options.free_center = Boolean(bingo_field.get(
'bingo-star',
str(self.options.free_center)
))
self.options.free_rows = int(bingo_field.get('bingo-free-rows', self.options.free_rows))
if self.options.card_header == "none":
self.options.card_header = ""
except (TypeError, ValueError, colors.ColorError):
label = bingo_field.label
el_id = bingo_field.get('id')
errormsg(_(f'Please verify bingo attributes for {label}: {el_id}'))
def _get_template_fields(self):
# check if a bingo template is used
xpath = ".//svg:rect[starts-with(@id,'bingo-area') or\
starts-with(@inkscape:label, 'Bingo Area')]|\
.//svg:use[starts-with(@id,'bingo-area') or\
starts-with(@inkscape:label, 'Bingo Area')]"
return self.document.xpath(xpath, namespaces=NSS)
def _get_transform(self, bingo_field, bingo_clone, bingo_group_transform):
# get correct positioning
transform_x = bingo_field.get('x', 0)
transform_y = bingo_field.get('y', 0)
transform = Transform('')
if bingo_group_transform is not None:
transform = bingo_group_transform
bingo_field_transform = transform @ Transform(translate=(transform_x, transform_y))
transform = bingo_field.composed_transform() @ bingo_field_transform
# clone positioning
if bingo_clone is not None:
transform_x = int(bingo_clone.get('x', 0))
transform_y = int(bingo_clone.get('y', 0))
transform = Transform(bingo_field.get('transform', '')) @ bingo_field_transform
transform = Transform(translate=(transform_x, transform_y)) @ transform
transform = bingo_clone.composed_transform() @ transform
return transform
def _set_layer_label(self, layer):
bingo_layers = self.document.xpath(".//svg:g[starts-with(@inkscape:label, 'Bingo #')]\
/@inkscape:label", namespaces=NSS)
if bingo_layers:
bingo_layers = [int(layer[7:]) for layer in bingo_layers]
bingo_layers.sort(reverse=True)
num_layer = bingo_layers[0] + 1
else:
num_layer = 1
label = f'Bingo #{num_layer}'
layer.set("inkscape:label", label)
def _get_clone_origin(self, clone):
# returns the origin of the clone and transform information for grouped clones
bingo_group_transform = None
bingo_field = clone.href
source_id = bingo_field.get_id()
if bingo_field.tag_name == "g":
xpath = ".//svg:rect[starts-with(@id,'bingo-area') or\
starts-with(@inkscape:label, 'Bingo Area')]"
bingo_field = bingo_field.xpath(xpath, namespaces=NSS)
if not bingo_field:
return None, None
bingo_field = bingo_field[0]
group_transforms = Transform('')
for ancestor in bingo_field.iterancestors():
group_transforms = Transform(ancestor.get('transform', '')) @ group_transforms
if ancestor.get('id', str()) == source_id:
break
bingo_group_transform = group_transforms
if bingo_field.tag_name != "rect":
return None, None
return bingo_field, bingo_group_transform
def _get_numbers(self):
numbers = []
for i in range(self.options.columns):
num_start = i * self.options.num_range + 1
num_end = (i + 1) * self.options.num_range + 1
num_range = list(range(num_start, num_end))
shuffle(num_range)
num_range = num_range[:self.options.rows]
numbers.append(num_range)
numbers = self._apply_free_spaces(numbers)
# insert card header
if self.options.columns == len(self.options.card_header):
for i in range(self.options.columns):
numbers[i].insert(0, self.options.card_header[i])
return numbers
def _apply_free_spaces(self, numbers):
# apply free spaces from template
if self.options.free_spaces:
spaces = self.options.free_spaces.split(';')
for space in spaces:
position = space.split('.')
try:
numbers[int(position[0]) - 1][int(position[1]) - 1] = ""
except (IndexError, ValueError):
pass
# apply free spaces per rows
if self.options.free_rows > 0:
for i in range(self.options.rows):
free = list(range(1, self.options.columns + 1))
shuffle(free)
free = free[:self.options.free_rows]
for free_space in free:
numbers[free_space - 1][i] = ""
# apply star at center
if self.options.free_center:
numbers[int(self.options.columns / 2)][int(self.options.rows / 2)] = "★"
return numbers
def _render_numbers(self, numbers):
header_style = f'fill:{self.options.header_color};font-size:{self.options.font_size};\
text-anchor:middle;'
element_style = f'fill:{self.options.num_color};font-size:{self.options.font_size};\
text-anchor:middle;'
text_element = TextElement(style=element_style)
x_start = self.options.grid_width / 2
y_coord = (self.options.font_size / 2) - (self.options.grid_height / 2)
if not self.options.card_header:
y_coord += self.options.grid_height
# if the headline has a different length from "columns" use headline without grid spacings
if self.options.columns != len(self.options.card_header) and self.options.card_header:
header = Tspan(self.options.card_header,
style=header_style,
x=str((self.options.columns * self.options.grid_width) / 2),
y=str(y_coord))
text_element.insert(0, header)
y_coord += self.options.grid_height
# insert number grid
for i in range(len(numbers[0])):
x_coord = x_start
for k in range(self.options.columns):
text = str(numbers[k][i])
element = Tspan(str(text), style=element_style, x=str(x_coord), y=str(y_coord))
if not text.isdigit() and text != "★":
element.style = header_style
text_element.insert(len(text_element), element)
x_coord += self.options.grid_width
y_coord += self.options.grid_height
return text_element
def _render_grid(self):
if not self.options.render_grid:
return None
group = Group.new("Grid")
x_coord = 0
y_coord = 0
rows = self.options.rows
style = f'stroke:#000000;fill:none;stroke-linecap:square;\
stroke-width:{self.options.stroke_width}'
for _i in range(self.options.columns + 1):
element = Line().new((x_coord, y_coord),
(x_coord, rows * self.options.grid_height),
style=style)
group.insert(0, element)
x_coord += self.options.grid_width
for _i in range(self.options.rows + 1):
element = Line().new((0, y_coord),
(self.options.columns * self.options.grid_width, y_coord),
style=style)
group.insert(0, element)
y_coord += self.options.grid_height
return group
if __name__ == '__main__':
BingoCardCreator().run()