2 Copyright 2007, 2008, 2009 Free Software Foundation, Inc.
3 This file is part of GNU Radio
5 GNU Radio Companion is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 GNU Radio Companion is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
20 from Element import Element
23 from .. base import odict
24 from Constants import BORDER_PROXIMITY_SENSITIVITY
25 from Constants import \
26 BLOCK_LABEL_PADDING, \
27 PORT_SEPARATION, LABEL_SEPARATION, \
28 PORT_BORDER_SEPARATION, POSSIBLE_ROTATIONS
33 BLOCK_MARKUP_TMPL="""\
34 #set $foreground = $block.is_valid() and 'black' or 'red'
35 <span foreground="$foreground" font_desc="Sans 8"><b>$encode($block.get_name())</b></span>"""
38 """The graphical signal block."""
43 Add graphics related params to the block.
45 #add the position param
46 self.get_params().append(self.get_parent().get_parent().Param(
49 'name': 'GUI Coordinate',
56 self.get_params().append(self.get_parent().get_parent().Param(
59 'name': 'GUI Rotation',
66 Element.__init__(self)
68 def get_coordinate(self):
70 Get the coordinate from the position param.
71 @return the coordinate tuple (x, y) or (0, 0) if failure
73 try: #should evaluate to tuple
74 coor = eval(self.get_param('_coordinate').get_value())
76 fgW,fgH = self.get_parent().get_size()
79 elif x >= fgW - BORDER_PROXIMITY_SENSITIVITY:
80 x = fgW - BORDER_PROXIMITY_SENSITIVITY
83 elif y >= fgH - BORDER_PROXIMITY_SENSITIVITY:
84 y = fgH - BORDER_PROXIMITY_SENSITIVITY
87 self.set_coordinate((0, 0))
90 def set_coordinate(self, coor):
92 Set the coordinate into the position param.
93 @param coor the coordinate tuple (x, y)
95 self.get_param('_coordinate').set_value(str(coor))
97 def get_rotation(self):
99 Get the rotation from the position param.
100 @return the rotation in degrees or 0 if failure
102 try: #should evaluate to dict
103 rotation = eval(self.get_param('_rotation').get_value())
106 self.set_rotation(POSSIBLE_ROTATIONS[0])
107 return POSSIBLE_ROTATIONS[0]
109 def set_rotation(self, rot):
111 Set the rotation into the position param.
112 @param rot the rotation in degrees
114 self.get_param('_rotation').set_value(str(rot))
116 def create_shapes(self):
117 """Update the block, parameters, and ports when a change occurs."""
118 Element.create_shapes(self)
119 if self.is_horizontal(): self.add_area((0, 0), (self.W, self.H))
120 elif self.is_vertical(): self.add_area((0, 0), (self.H, self.W))
122 def create_labels(self):
123 """Create the labels for the signal block."""
124 Element.create_labels(self)
125 self._bg_color = self.get_enabled() and Colors.BLOCK_ENABLED_COLOR or Colors.BLOCK_DISABLED_COLOR
127 #create the main layout
128 layout = gtk.DrawingArea().create_pango_layout('')
129 layouts.append(layout)
130 layout.set_markup(Utils.parse_template(BLOCK_MARKUP_TMPL, block=self))
131 self.label_width, self.label_height = layout.get_pixel_size()
133 for param in filter(lambda p: p.get_hide() not in ('all', 'part'), self.get_params()):
134 layout = param.get_layout()
135 layouts.append(layout)
136 w,h = layout.get_pixel_size()
137 self.label_width = max(w, self.label_width)
138 self.label_height += h + LABEL_SEPARATION
139 width = self.label_width
140 height = self.label_height
142 pixmap = self.get_parent().new_pixmap(width, height)
144 gc.set_foreground(self._bg_color)
145 pixmap.draw_rectangle(gc, True, 0, 0, width, height)
148 for i,layout in enumerate(layouts):
149 w,h = layout.get_pixel_size()
150 if i == 0: w_off = (width-w)/2
152 pixmap.draw_layout(gc, w_off, h_off, layout)
153 h_off = h + h_off + LABEL_SEPARATION
154 #create vertical and horizontal images
155 self.horizontal_label = image = pixmap.get_image(0, 0, width, height)
156 if self.is_vertical():
157 self.vertical_label = vimage = gtk.gdk.Image(gtk.gdk.IMAGE_NORMAL, pixmap.get_visual(), height, width)
158 for i in range(width):
159 for j in range(height): vimage.put_pixel(j, width-i-1, image.get_pixel(i, j))
160 #calculate width and height needed
161 self.W = self.label_width + 2*BLOCK_LABEL_PADDING
163 [self.label_height+2*BLOCK_LABEL_PADDING] + [2*PORT_BORDER_SEPARATION + \
164 sum([port.H + PORT_SEPARATION for port in ports]) - PORT_SEPARATION
165 for ports in (self.get_sources(), self.get_sinks())]
168 def draw(self, gc, window):
170 Draw the signal block with label and inputs/outputs.
171 @param gc the graphics context
172 @param window the gtk window to draw on
174 x, y = self.get_coordinate()
177 self, gc, window, bg_color=self._bg_color,
178 border_color=self.is_highlighted() and Colors.HIGHLIGHT_COLOR or Colors.BORDER_COLOR,
181 if self.is_horizontal():
182 window.draw_image(gc, self.horizontal_label, 0, 0, x+BLOCK_LABEL_PADDING, y+(self.H-self.label_height)/2, -1, -1)
183 elif self.is_vertical():
184 window.draw_image(gc, self.vertical_label, 0, 0, x+(self.H-self.label_height)/2, y+BLOCK_LABEL_PADDING, -1, -1)
186 for port in self.get_ports(): port.draw(gc, window)
188 def what_is_selected(self, coor, coor_m=None):
190 Get the element that is selected.
191 @param coor the (x,y) tuple
192 @param coor_m the (x_m, y_m) tuple
193 @return this block, a port, or None
195 for port in self.get_ports():
196 port_selected = port.what_is_selected(coor, coor_m)
197 if port_selected: return port_selected
198 return Element.what_is_selected(self, coor, coor_m)