git.gag.com Git - debian/gnuradio/blob - grc/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         """
  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.
  33         """
  34
  35         def get_coordinate(self):
  36                 """
  37                 Get the 0,0 coordinate.
  38                 Coordinates are irrelevant in connection.
  39                 @return 0, 0
  40                 """
  41                 return (0, 0)
  42
  43         def get_rotation(self):
  44                 """
  45                 Get the 0 degree rotation.
  46                 Rotations are irrelevant in connection.
  47                 @return 0
  48                 """
  49                 return 0
  50
  51         def update(self):
  52                 """Precalculate relative coordinates."""
  53                 self._sink_rot = None
  54                 self._source_rot = None
  55                 self._sink_coor = None
  56                 self._source_coor = None
  57                 #get the source coordinate
  58                 connector_length = self.get_source().get_connector_length()
  59                 self.x1, self.y1 = Utils.get_rotated_coordinate((connector_length, 0), self.get_source().get_rotation())
  60                 #get the sink coordinate
  61                 connector_length = self.get_sink().get_connector_length() + CONNECTOR_ARROW_HEIGHT
  62                 self.x2, self.y2 = Utils.get_rotated_coordinate((-connector_length, 0), self.get_sink().get_rotation())
  63                 #build the arrow
  64                 self.arrow = [(0, 0),
  65                         Utils.get_rotated_coordinate((-CONNECTOR_ARROW_HEIGHT, -CONNECTOR_ARROW_BASE/2), self.get_sink().get_rotation()),
  66                         Utils.get_rotated_coordinate((-CONNECTOR_ARROW_HEIGHT, CONNECTOR_ARROW_BASE/2), self.get_sink().get_rotation()),
  67                 ]
  68                 self._update_after_move()
  69                 if not self.get_enabled(): self._arrow_color = Colors.CONNECTION_DISABLED_COLOR
  70                 elif not self.is_valid(): self._arrow_color = Colors.CONNECTION_ERROR_COLOR
  71                 else: self._arrow_color = Colors.CONNECTION_ENABLED_COLOR
  72
  73         def _update_after_move(self):
  74                 """Calculate coordinates."""
  75                 self.clear()
  76                 #source connector
  77                 source = self.get_source()
  78                 X, Y = source.get_connector_coordinate()
  79                 x1, y1 = self.x1 + X, self.y1 + Y
  80                 self.add_line((x1, y1), (X, Y))
  81                 #sink connector
  82                 sink = self.get_sink()
  83                 X, Y = sink.get_connector_coordinate()
  84                 x2, y2 = self.x2 + X, self.y2 + Y
  85                 self.add_line((x2, y2), (X, Y))
  86                 #adjust arrow
  87                 self._arrow = [(x+X, y+Y) for x,y in self.arrow]
  88                 #add the horizontal and vertical lines in this connection
  89                 if abs(source.get_connector_direction() - sink.get_connector_direction()) == 180:
  90                         #2 possible point sets to create a 3-line connector
  91                         mid_x, mid_y = (x1 + x2)/2.0, (y1 + y2)/2.0
  92                         points = [((mid_x, y1), (mid_x, y2)), ((x1, mid_y), (x2, mid_y))]
  93                         #source connector -> points[0][0] should be in the direction of source (if possible)
  94                         if Utils.get_angle_from_coordinates((x1, y1), points[0][0]) != source.get_connector_direction(): points.reverse()
  95                         #points[0][0] -> sink connector should not be in the direction of sink
  96                         if Utils.get_angle_from_coordinates(points[0][0], (x2, y2)) == sink.get_connector_direction(): points.reverse()
  97                         #points[0][0] -> source connector should not be in the direction of source
  98                         if Utils.get_angle_from_coordinates(points[0][0], (x1, y1)) == source.get_connector_direction(): points.reverse()
  99                         #create 3-line connector
 100                         p1, p2 = map(int, points[0][0]), map(int, points[0][1])
 101                         self.add_line((x1, y1), p1)
 102                         self.add_line(p1, p2)
 103                         self.add_line((x2, y2), p2)
 104                 else:
 105                         #2 possible points to create a right-angled connector
 106                         points = [(x1, y2), (x2, y1)]
 107                         #source connector -> points[0] should be in the direction of source (if possible)
 108                         if Utils.get_angle_from_coordinates((x1, y1), points[0]) != source.get_connector_direction(): points.reverse()
 109                         #points[0] -> sink connector should not be in the direction of sink
 110                         if Utils.get_angle_from_coordinates(points[0], (x2, y2)) == sink.get_connector_direction(): points.reverse()
 111                         #points[0] -> source connector should not be in the direction of source
 112                         if Utils.get_angle_from_coordinates(points[0], (x1, y1)) == source.get_connector_direction(): points.reverse()
 113                         #create right-angled connector
 114                         self.add_line((x1, y1), points[0])
 115                         self.add_line((x2, y2), points[0])
 116
 117         def draw(self, gc, window):
 118                 """
 119                 Draw the connection.
 120                 @param gc the graphics context
 121                 @param window the gtk window to draw on
 122                 """
 123                 sink = self.get_sink()
 124                 source = self.get_source()
 125                 #check for changes
 126                 if self._sink_rot != sink.get_rotation() or self._source_rot != source.get_rotation(): self.update()
 127                 elif self._sink_coor != sink.get_coordinate() or self._source_coor != source.get_coordinate(): self._update_after_move()
 128                 #cache values
 129                 self._sink_rot = sink.get_rotation()
 130                 self._source_rot = source.get_rotation()
 131                 self._sink_coor = sink.get_coordinate()
 132                 self._source_coor = source.get_coordinate()
 133                 #draw
 134                 if self.is_highlighted(): border_color = Colors.HIGHLIGHT_COLOR
 135                 elif self.get_enabled(): border_color = Colors.CONNECTION_ENABLED_COLOR
 136                 else: border_color = Colors.CONNECTION_DISABLED_COLOR
 137                 Element.draw(self, gc, window, bg_color=None, border_color=border_color)
 138                 #draw arrow on sink port
 139                 gc.set_foreground(self._arrow_color)
 140                 window.draw_polygon(gc, True, self._arrow)