Diagram.py: make aligning to the baseline optional in draw_centered_text()
[experiments/RadialSymmetry.git] / Diagram.py
1 #!/usr/bin/env python
2 #
3 # A Diagram abstraction based on Cairo
4 #
5 # Copyright (C) 2015  Antonio Ospite <ao2@ao2.it>
6 #
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20 import cairo
21 from math import *
22
23
24 class Diagram(object):
25
26     def __init__(self, width, height, background=[1, 1, 1]):
27         self.width = width
28         self.height = height
29         self.background = background
30
31         # TODO: use a RecordingSurface
32         self.surface = cairo.SVGSurface(None, width, height)
33         self.cr = cr = cairo.Context(self.surface)
34
35         # convert to left-bottom-origin cartesian coordinates
36         cr.translate(0, self.height)
37         cr.scale(1, -1)
38
39         cr.select_font_face("Georgia", cairo.FONT_SLANT_NORMAL,
40                             cairo.FONT_WEIGHT_NORMAL)
41         cr.set_font_size(20)
42
43         # Adjust the font matrix to left-bottom origin
44         M = cr.get_font_matrix()
45         M.scale(1, -1)
46         cr.set_font_matrix(M)
47
48     def clear(self):
49         cr = self.cr
50
51         r, g, b, a = self.color_to_rgba(self.background)
52         cr.set_source_rgba(r, g, b, a)
53         cr.paint()
54
55     def save_svg(self, filename):
56         surface = cairo.SVGSurface(filename + '.svg', self.width, self.height)
57         cr = cairo.Context(surface)
58         cr.set_source_surface(self.surface, 0, 0)
59         cr.paint()
60
61     def save_png(self, filename):
62         surface = cairo.ImageSurface(cairo.FORMAT_ARGB32, self.width, self.height)
63         cr = cairo.Context(surface)
64         cr.set_source_surface(self.surface, 0, 0)
65         cr.paint()
66         surface.write_to_png(filename + '.png')
67
68     def show(self):
69         import Image
70         import StringIO
71         f = StringIO.StringIO()
72         surface = cairo.ImageSurface(cairo.FORMAT_ARGB32, self.width, self.height)
73         cr = cairo.Context(surface)
74         cr.set_source_surface(self.surface, 0, 0)
75         cr.paint()
76         surface.write_to_png(f)
77         f.seek(0)
78         im = Image.open(f)
79         im.show()
80
81     def get_regular_polygon(self, x, y, sides, r, theta0=0.0):
82         theta = 2 * pi / sides
83
84         verts = []
85         for i in range(0, sides):
86             px = x + r * sin(theta0 + i * theta)
87             py = y + r * cos(theta0 + i * theta)
88             verts.append((px, py))
89
90         return verts
91
92     def color_to_rgba(self, color):
93         if len(color) == 3:
94             return color[0], color[1], color[2], 1.0
95         elif len(color) == 4:
96             return color[0], color[1], color[2], color[3]
97         else:
98             return None
99
100     def draw_polygon(self, verts, stroke_color=[0, 0, 0], fill_color=None):
101         cr = self.cr
102
103         if fill_color:
104             v = verts[0]
105             cr.move_to(v[0], v[1])
106             for v in verts[1:]:
107                 cr.line_to(v[0], v[1])
108                 cr.close_path()
109
110             r, g, b, a = self.color_to_rgba(fill_color)
111             cr.set_source_rgba(r, g, b, a)
112             cr.fill()
113
114         n = len(verts)
115         for i in range(0, n):
116             v1 = verts[i]
117             v2 = verts[(i + 1) % n]
118             cr.move_to(v1[0], v1[1])
119             cr.line_to(v2[0], v2[1])
120
121         r, g, b, a = self.color_to_rgba(stroke_color)
122         cr.set_source_rgba(r, g, b, a)
123         cr.stroke()
124
125     def draw_star(self, cx, cy, verts, stroke_color=[0, 0, 0]):
126         cr = self.cr
127
128         v = verts[0]
129         cr.move_to(cx, cy)
130         for v in verts:
131             cr.line_to(v[0], v[1])
132             cr.move_to(cx, cy)
133
134         r, g, b, a = self.color_to_rgba(stroke_color)
135         cr.set_source_rgba(r, g, b, a)
136         cr.stroke()
137
138     def draw_dot(self, cx, cy, size=10.0, fill_color=[0, 0, 0, 0.5]):
139         cr = self.cr
140
141         cr.save()
142         r, g, b, a = self.color_to_rgba(fill_color)
143         cr.set_source_rgba(r, g, b, a)
144         cr.arc(cx, cy, size, 0, 2 * pi)
145         cr.fill()
146         cr.restore()
147
148     def normalized_angle_01(self, theta):
149         return fmod(theta, 2 * pi) / (2 * pi)
150
151     def draw_line(self, x1, y1, x2, y2, stroke_color=[0, 0, 0, 1]):
152         cr = self.cr
153         r, g, b, a = self.color_to_rgba(stroke_color)
154         cr.set_source_rgba(r, g, b, a)
155         cr.move_to(x1, y1)
156         cr.line_to(x2, y2)
157         cr.stroke()
158
159     def draw_rect_from_center(self, cx, cy, width, height, theta=0,
160                               fill=True, fill_color=[1, 1, 1, 0.8],
161                               stroke=False, stroke_color=[0, 0, 0, 0.5]):
162         cr = self.cr
163
164         mx = width / 2.0
165         my = height / 2.0
166
167         rx = cx - (mx * cos(theta) - my * sin(theta))
168         ry = cy - (mx * sin(theta) + my * cos(theta))
169
170         cr.save()
171         cr.translate(rx, ry)
172         cr.rotate(theta)
173
174         if fill:
175             cr.rectangle(0, 0, width, height)
176             r, g, b, a = self.color_to_rgba(fill_color)
177             cr.set_source_rgba(r, g, b, a)
178             cr.fill()
179
180         if stroke:
181             cr.rectangle(0, 0, width, height)
182             r, g, b, a = self.color_to_rgba(stroke_color)
183             cr.set_source_rgba(r, g, b, a)
184             cr.stroke()
185             self.draw_dot(0, 0, 3.0, stroke_color)
186
187         cr.restore()
188
189     def draw_rect(self, x, y, width, height, fill=True, fill_color=[1, 1, 1, 0.8],
190                   stroke=False, stroke_color=[0, 0, 0, 0.5]):
191         cr = self.cr
192
193         cr.save()
194         cr.translate(x, y)
195
196         if fill:
197             cr.rectangle(0, 0, width, height)
198             r, g, b, a = self.color_to_rgba(fill_color)
199             cr.set_source_rgba(r, g, b, a)
200             cr.fill()
201
202         if stroke:
203             cr.rectangle(0, 0, width, height)
204             r, g, b, a = self.color_to_rgba(stroke_color)
205             cr.set_source_rgba(r, g, b, a)
206             cr.stroke()
207             self.draw_dot(0, 0, 3.0, stroke_color)
208
209         cr.restore()
210
211     def draw_centered_text(self, cx, cy, text, theta=0,
212                            color=[0, 0, 0],
213                            align_baseline=False,
214                            bb_fill=True, bb_fill_color=[1, 1, 1, 0.8],
215                            bb_stroke=False, bb_stroke_color=[0, 0, 0, 0.5]):
216         cr = self.cr
217
218         x_bearing, y_bearing, width, height, x_advance = cr.text_extents(text)[:5]
219         ascent, descent = cr.font_extents()[:2]
220
221         # The offset of the lower-left corner of the text.
222         tx = width / 2.0 + x_bearing
223
224         if align_baseline:
225             # When aligning to the  baseline it is convenient the make the
226             # bounding box depend on the font vertical extent and not from the
227             # text content.
228             ty = 0
229             bb = [0, -descent, width, ascent]
230         else:
231             ty = height / 2.0 + y_bearing
232             bb = [0, y_bearing, width, height]
233
234         # Angles are intended clockwise by the caller, but the trigonometric
235         # functions below consider angles counter-clockwise
236         theta = -theta
237
238         # The coordinate of the lower-left corner of the rotated rectangle
239         rx = cx - tx * cos(theta) + ty * sin(theta)
240         ry = cy - tx * sin(theta) - ty * cos(theta)
241
242         cr.save()
243         cr.translate(rx, ry)
244         cr.rotate(theta)
245
246         if bb_fill or bb_stroke:
247             self.draw_rect(bb[0], bb[1], bb[2], bb[3], bb_fill, bb_fill_color, bb_stroke, bb_stroke_color)
248
249         r, g, b, a = self.color_to_rgba(color)
250         cr.set_source_rgba(r, g, b, a)
251         cr.move_to(0, 0)
252         cr.show_text(text)
253         cr.fill()
254         cr.restore()
255
256         return x_advance
257
258
259 if __name__ == "__main__":
260     diagram = Diagram(400, 400)
261
262     diagram.clear()
263
264     x = 40
265     y = 200
266
267     x_offset = x
268
269     theta = 0
270
271     advance = diagram.draw_centered_text(x_offset, y, "Ciao", theta, align_baseline=True, bb_stroke=True)
272     x_offset += advance
273
274     advance = diagram.draw_centered_text(x_offset, y, "____", theta + pi / 4, align_baseline=True, bb_stroke=True)
275     x_offset += advance
276
277     advance = diagram.draw_centered_text(x_offset, y, "jxpqdlf", theta + pi / 2, align_baseline=True, bb_stroke=True)
278     x_offset += advance
279
280     advance = diagram.draw_centered_text(x_offset, y, "pppp", theta + 3 * pi / 4, align_baseline=True, bb_stroke=True)
281     x_offset += advance
282
283     advance = diagram.draw_centered_text(x_offset, y, "dddd", theta + pi, align_baseline=True, bb_stroke=True)
284     x_offset += advance
285
286     advance = diagram.draw_centered_text(x_offset, y, "Jjjj", theta + 5 * pi / 4, align_baseline=True, bb_stroke=True)
287     x_offset += advance
288
289     advance = diagram.draw_centered_text(x_offset, y, "1369", theta + 3 * pi / 2, align_baseline=True, bb_stroke=True)
290     x_offset += advance
291
292     advance = diagram.draw_centered_text(x_offset, y, "qqqq", theta + 7 * pi / 4, align_baseline=True, bb_stroke=True)
293     x_offset += advance
294
295     diagram.draw_line(0, y, 400, y, [0, 0, 1, 0.2])
296
297     diagram.show()