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
21 from Element import Element
23 from Constants import CONNECTOR_ARROW_BASE, CONNECTOR_ARROW_HEIGHT
25 class Connection(Element):
27 A graphical connection for ports.
28 The connection has 2 parts, the arrow and the wire.
29 The coloring of the arrow and wire exposes the status of 3 states:
30 enabled/disabled, valid/invalid, highlighted/non-highlighted.
31 The wire coloring exposes the enabled and highlighted states.
32 The arrow coloring exposes the enabled and valid states.
35 def __init__(self): Element.__init__(self)
37 def get_coordinate(self):
39 Get the 0,0 coordinate.
40 Coordinates are irrelevant in connection.
45 def get_rotation(self):
47 Get the 0 degree rotation.
48 Rotations are irrelevant in connection.
53 def create_shapes(self):
54 """Precalculate relative coordinates."""
55 Element.create_shapes(self)
57 self._source_rot = None
58 self._sink_coor = None
59 self._source_coor = None
60 #get the source coordinate
61 connector_length = self.get_source().get_connector_length()
62 self.x1, self.y1 = Utils.get_rotated_coordinate((connector_length, 0), self.get_source().get_rotation())
63 #get the sink coordinate
64 connector_length = self.get_sink().get_connector_length() + CONNECTOR_ARROW_HEIGHT
65 self.x2, self.y2 = Utils.get_rotated_coordinate((-connector_length, 0), self.get_sink().get_rotation())
68 Utils.get_rotated_coordinate((-CONNECTOR_ARROW_HEIGHT, -CONNECTOR_ARROW_BASE/2), self.get_sink().get_rotation()),
69 Utils.get_rotated_coordinate((-CONNECTOR_ARROW_HEIGHT, CONNECTOR_ARROW_BASE/2), self.get_sink().get_rotation()),
71 self._update_after_move()
72 if not self.get_enabled(): self._arrow_color = Colors.CONNECTION_DISABLED_COLOR
73 elif not self.is_valid(): self._arrow_color = Colors.CONNECTION_ERROR_COLOR
74 else: self._arrow_color = Colors.CONNECTION_ENABLED_COLOR
76 def _update_after_move(self):
77 """Calculate coordinates."""
78 self.clear() #FIXME do i want this here?
80 source = self.get_source()
81 X, Y = source.get_connector_coordinate()
82 x1, y1 = self.x1 + X, self.y1 + Y
83 self.add_line((x1, y1), (X, Y))
85 sink = self.get_sink()
86 X, Y = sink.get_connector_coordinate()
87 x2, y2 = self.x2 + X, self.y2 + Y
88 self.add_line((x2, y2), (X, Y))
90 self._arrow = [(x+X, y+Y) for x,y in self.arrow]
91 #add the horizontal and vertical lines in this connection
92 if abs(source.get_connector_direction() - sink.get_connector_direction()) == 180:
93 #2 possible point sets to create a 3-line connector
94 mid_x, mid_y = (x1 + x2)/2.0, (y1 + y2)/2.0
95 points = [((mid_x, y1), (mid_x, y2)), ((x1, mid_y), (x2, mid_y))]
96 #source connector -> points[0][0] should be in the direction of source (if possible)
97 if Utils.get_angle_from_coordinates((x1, y1), points[0][0]) != source.get_connector_direction(): points.reverse()
98 #points[0][0] -> sink connector should not be in the direction of sink
99 if Utils.get_angle_from_coordinates(points[0][0], (x2, y2)) == sink.get_connector_direction(): points.reverse()
100 #points[0][0] -> source connector should not be in the direction of source
101 if Utils.get_angle_from_coordinates(points[0][0], (x1, y1)) == source.get_connector_direction(): points.reverse()
102 #create 3-line connector
103 p1, p2 = map(int, points[0][0]), map(int, points[0][1])
104 self.add_line((x1, y1), p1)
105 self.add_line(p1, p2)
106 self.add_line((x2, y2), p2)
108 #2 possible points to create a right-angled connector
109 points = [(x1, y2), (x2, y1)]
110 #source connector -> points[0] should be in the direction of source (if possible)
111 if Utils.get_angle_from_coordinates((x1, y1), points[0]) != source.get_connector_direction(): points.reverse()
112 #points[0] -> sink connector should not be in the direction of sink
113 if Utils.get_angle_from_coordinates(points[0], (x2, y2)) == sink.get_connector_direction(): points.reverse()
114 #points[0] -> source connector should not be in the direction of source
115 if Utils.get_angle_from_coordinates(points[0], (x1, y1)) == source.get_connector_direction(): points.reverse()
116 #create right-angled connector
117 self.add_line((x1, y1), points[0])
118 self.add_line((x2, y2), points[0])
120 def draw(self, gc, window):
123 @param gc the graphics context
124 @param window the gtk window to draw on
126 sink = self.get_sink()
127 source = self.get_source()
129 if self._sink_rot != sink.get_rotation() or self._source_rot != source.get_rotation(): self.create_shapes()
130 elif self._sink_coor != sink.get_coordinate() or self._source_coor != source.get_coordinate(): self._update_after_move()
132 self._sink_rot = sink.get_rotation()
133 self._source_rot = source.get_rotation()
134 self._sink_coor = sink.get_coordinate()
135 self._source_coor = source.get_coordinate()
137 if self.is_highlighted(): border_color = Colors.HIGHLIGHT_COLOR
138 elif self.get_enabled(): border_color = Colors.CONNECTION_ENABLED_COLOR
139 else: border_color = Colors.CONNECTION_DISABLED_COLOR
140 Element.draw(self, gc, window, bg_color=None, border_color=border_color)
141 #draw arrow on sink port
142 gc.set_foreground(self._arrow_color)
143 window.draw_polygon(gc, True, self._arrow)