Merged r9481:9518 on jblum/grc_reorganize into trunk. Reorganized grc source under...
[debian/gnuradio] / grc / src / platforms / gui / Connection.py
1 """
2 Copyright 2007, 2008 Free Software Foundation, Inc.
3 This file is part of GNU Radio
4
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.
9
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.
14
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
18 """
19
20 import Utils
21 from Element import Element
22 import Colors
23 from Constants import CONNECTOR_ARROW_BASE, CONNECTOR_ARROW_HEIGHT
24
25 class Connection(Element):
26         """A graphical connection for ports."""
27
28         def get_coordinate(self):
29                 """
30                 Get the 0,0 coordinate.
31                 Coordinates are irrelevant in connection.
32                 @return 0, 0
33                 """
34                 return (0, 0)
35
36         def get_rotation(self):
37                 """
38                 Get the 0 degree rotation.
39                 Rotations are irrelevant in connection.
40                 @return 0
41                 """
42                 return 0
43
44         def update(self):
45                 """Precalculate relative coordinates."""
46                 self._sink_rot = None
47                 self._source_rot = None
48                 self._sink_coor = None
49                 self._source_coor = None
50                 #get the source coordinate
51                 connector_length = self.get_source().get_connector_length()
52                 self.x1, self.y1 = Utils.get_rotated_coordinate((connector_length, 0), self.get_source().get_rotation())
53                 #get the sink coordinate
54                 connector_length = self.get_sink().get_connector_length() + CONNECTOR_ARROW_HEIGHT
55                 self.x2, self.y2 = Utils.get_rotated_coordinate((-connector_length, 0), self.get_sink().get_rotation())
56                 #build the arrow
57                 self.arrow = [(0, 0),
58                         Utils.get_rotated_coordinate((-CONNECTOR_ARROW_HEIGHT, -CONNECTOR_ARROW_BASE/2), self.get_sink().get_rotation()),
59                         Utils.get_rotated_coordinate((-CONNECTOR_ARROW_HEIGHT, CONNECTOR_ARROW_BASE/2), self.get_sink().get_rotation()),
60                 ]
61                 self._update_after_move()
62
63         def _update_after_move(self):
64                 """Calculate coordinates."""
65                 self.clear()
66                 #source connector
67                 source = self.get_source()
68                 X, Y = source.get_connector_coordinate()
69                 x1, y1 = self.x1 + X, self.y1 + Y
70                 self.add_line((x1, y1), (X, Y))
71                 #sink connector
72                 sink = self.get_sink()
73                 X, Y = sink.get_connector_coordinate()
74                 x2, y2 = self.x2 + X, self.y2 + Y
75                 self.add_line((x2, y2), (X, Y))
76                 #adjust arrow
77                 self._arrow = [(x+X, y+Y) for x,y in self.arrow]
78                 #add the horizontal and vertical lines in this connection
79                 if abs(source.get_connector_direction() - sink.get_connector_direction()) == 180:
80                         #2 possible point sets to create a 3-line connector
81                         mid_x, mid_y = (x1 + x2)/2.0, (y1 + y2)/2.0
82                         points = [((mid_x, y1), (mid_x, y2)), ((x1, mid_y), (x2, mid_y))]
83                         #source connector -> points[0][0] should be in the direction of source (if possible)
84                         if Utils.get_angle_from_coordinates((x1, y1), points[0][0]) != source.get_connector_direction(): points.reverse()
85                         #points[0][0] -> sink connector should not be in the direction of sink
86                         if Utils.get_angle_from_coordinates(points[0][0], (x2, y2)) == sink.get_connector_direction(): points.reverse()
87                         #points[0][0] -> source connector should not be in the direction of source
88                         if Utils.get_angle_from_coordinates(points[0][0], (x1, y1)) == source.get_connector_direction(): points.reverse()
89                         #create 3-line connector
90                         p1, p2 = map(int, points[0][0]), map(int, points[0][1])
91                         self.add_line((x1, y1), p1)
92                         self.add_line(p1, p2)
93                         self.add_line((x2, y2), p2)
94                 else:
95                         #2 possible points to create a right-angled connector
96                         points = [(x1, y2), (x2, y1)]
97                         #source connector -> points[0] should be in the direction of source (if possible)
98                         if Utils.get_angle_from_coordinates((x1, y1), points[0]) != source.get_connector_direction(): points.reverse()
99                         #points[0] -> sink connector should not be in the direction of sink
100                         if Utils.get_angle_from_coordinates(points[0], (x2, y2)) == sink.get_connector_direction(): points.reverse()
101                         #points[0] -> source connector should not be in the direction of source
102                         if Utils.get_angle_from_coordinates(points[0], (x1, y1)) == source.get_connector_direction(): points.reverse()
103                         #create right-angled connector
104                         self.add_line((x1, y1), points[0])
105                         self.add_line((x2, y2), points[0])
106
107         def draw(self, window):
108                 """
109                 Draw the connection.
110                 @param window the gtk window to draw on
111                 """
112                 sink = self.get_sink()
113                 source = self.get_source()
114                 #check for changes
115                 if self._sink_rot != sink.get_rotation() or self._source_rot != source.get_rotation(): self.update()
116                 elif self._sink_coor != sink.get_coordinate() or self._source_coor != source.get_coordinate(): self._update_after_move()
117                 #cache values
118                 self._sink_rot = sink.get_rotation()
119                 self._source_rot = source.get_rotation()
120                 self._sink_coor = sink.get_coordinate()
121                 self._source_coor = source.get_coordinate()
122                 #draw
123                 fg_color = self.get_enabled() and Colors.FG_COLOR or Colors.DISABLED_FG_COLOR
124                 Element.draw(self, window, FG_color=fg_color)
125                 gc = self.get_gc()
126                 if self.is_valid(): gc.foreground = Colors.FG_COLOR
127                 else: gc.foreground = Colors.ERROR_COLOR
128                 #draw arrow on sink port
129                 window.draw_polygon(gc, True, self._arrow)