git.gag.com Git - debian/gnuradio/blob - grc/gui/Element.py

   1 """
   2 Copyright 2007, 2008, 2009 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 from Constants import LINE_SELECT_SENSITIVITY
  21 from Constants import POSSIBLE_ROTATIONS
  22
  23 class Element(object):
  24         """
  25         GraphicalElement is the base class for all graphical elements.
  26         It contains an X,Y coordinate, a list of rectangular areas that the element occupies,
  27         and methods to detect selection of those areas.
  28         """
  29
  30         def __init__(self):
  31                 """
  32                 Make a new list of rectangular areas and lines, and set the coordinate and the rotation.
  33                 """
  34                 self.set_rotation(POSSIBLE_ROTATIONS[0])
  35                 self.set_coordinate((0, 0))
  36                 self.clear()
  37                 self.set_highlighted(False)
  38
  39         def is_horizontal(self, rotation=None):
  40                 """
  41                 Is this element horizontal?
  42                 If rotation is None, use this element's rotation.
  43                 @param rotation the optional rotation
  44                 @return true if rotation is horizontal
  45                 """
  46                 rotation = rotation or self.get_rotation()
  47                 return rotation in (0, 180)
  48
  49         def is_vertical(self, rotation=None):
  50                 """
  51                 Is this element vertical?
  52                 If rotation is None, use this element's rotation.
  53                 @param rotation the optional rotation
  54                 @return true if rotation is vertical
  55                 """
  56                 rotation = rotation or self.get_rotation()
  57                 return rotation in (90, 270)
  58
  59         def create_labels(self):
  60                 """
  61                 Create labels (if applicable) and call on all children.
  62                 Call this base method before creating labels in the element.
  63                 """
  64                 for child in self.get_children(): child.create_labels()
  65
  66         def create_shapes(self):
  67                 """
  68                 Create shapes (if applicable) and call on all children.
  69                 Call this base method before creating shapes in the element.
  70                 """
  71                 self.clear()
  72                 for child in self.get_children(): child.create_shapes()
  73
  74         def draw(self, gc, window, border_color, bg_color):
  75                 """
  76                 Draw in the given window.
  77                 @param gc the graphics context
  78                 @param window the gtk window to draw on
  79                 @param border_color the color for lines and rectangle borders
  80                 @param bg_color the color for the inside of the rectangle
  81                 """
  82                 X,Y = self.get_coordinate()
  83                 for (rX,rY),(W,H) in self._areas_list:
  84                         aX = X + rX
  85                         aY = Y + rY
  86                         gc.set_foreground(bg_color)
  87                         window.draw_rectangle(gc, True, aX, aY, W, H)
  88                         gc.set_foreground(border_color)
  89                         window.draw_rectangle(gc, False, aX, aY, W, H)
  90                 for (x1, y1),(x2, y2) in self._lines_list:
  91                         gc.set_foreground(border_color)
  92                         window.draw_line(gc, X+x1, Y+y1, X+x2, Y+y2)
  93
  94         def rotate(self, rotation):
  95                 """
  96                 Rotate all of the areas by 90 degrees.
  97                 @param rotation multiple of 90 degrees
  98                 """
  99                 self.set_rotation((self.get_rotation() + rotation)%360)
 100
 101         def clear(self):
 102                 """Empty the lines and areas."""
 103                 self._areas_list = list()
 104                 self._lines_list = list()
 105
 106         def set_coordinate(self, coor):
 107                 """
 108                 Set the reference coordinate.
 109                 @param coor the coordinate tuple (x,y)
 110                 """
 111                 self.coor = coor
 112
 113         def get_parent(self):
 114                 """
 115                 Get the parent of this element.
 116                 @return the parent
 117                 """
 118                 return self.parent
 119
 120         def set_highlighted(self, highlighted):
 121                 """
 122                 Set the highlight status.
 123                 @param highlighted true to enable highlighting
 124                 """
 125                 self.highlighted = highlighted
 126
 127         def is_highlighted(self):
 128                 """
 129                 Get the highlight status.
 130                 @return true if highlighted
 131                 """
 132                 return self.highlighted
 133
 134         def get_coordinate(self):
 135                 """Get the coordinate.
 136                 @return the coordinate tuple (x,y)
 137                 """
 138                 return self.coor
 139
 140         def move(self, delta_coor):
 141                 """
 142                 Move the element by adding the delta_coor to the current coordinate.
 143                 @param delta_coor (delta_x,delta_y) tuple
 144                 """
 145                 deltaX, deltaY = delta_coor
 146                 X, Y = self.get_coordinate()
 147                 self.set_coordinate((X+deltaX, Y+deltaY))
 148
 149         def add_area(self, rel_coor, area):
 150                 """
 151                 Add an area to the area list.
 152                 An area is actually a coordinate relative to the main coordinate
 153                 with a width/height pair relative to the area coordinate.
 154                 A positive width is to the right of the coordinate.
 155                 A positive height is above the coordinate.
 156                 The area is associated with a rotation.
 157                 @param rel_coor (x,y) offset from this element's coordinate
 158                 @param area (width,height) tuple
 159                 """
 160                 self._areas_list.append((rel_coor, area))
 161
 162         def add_line(self, rel_coor1, rel_coor2):
 163                 """
 164                 Add a line to the line list.
 165                 A line is defined by 2 relative coordinates.
 166                 Lines must be horizontal or vertical.
 167                 The line is associated with a rotation.
 168                 @param rel_coor1 relative (x1,y1) tuple
 169                 @param rel_coor2 relative (x2,y2) tuple
 170                 """
 171                 self._lines_list.append((rel_coor1, rel_coor2))
 172
 173         def what_is_selected(self, coor, coor_m=None):
 174                 """
 175                 One coordinate specified:
 176                         Is this element selected at given coordinate?
 177                         ie: is the coordinate encompassed by one of the areas or lines?
 178                 Both coordinates specified:
 179                         Is this element within the rectangular region defined by both coordinates?
 180                         ie: do any area corners or line endpoints fall within the region?
 181                 @param coor the selection coordinate, tuple x, y
 182                 @param coor_m an additional selection coordinate.
 183                 @return self if one of the areas/lines encompasses coor, else None.
 184                 """
 185                 #function to test if p is between a and b (inclusive)
 186                 in_between = lambda p, a, b: p >= min(a, b) and p <= max(a, b)
 187                 #relative coordinate
 188                 x, y = [a-b for a,b in zip(coor, self.get_coordinate())]
 189                 if coor_m:
 190                         x_m, y_m = [a-b for a,b in zip(coor_m, self.get_coordinate())]
 191                         #handle rectangular areas
 192                         for (x1,y1), (w,h) in self._areas_list:
 193                                 if in_between(x1, x, x_m) and in_between(y1, y, y_m) or \
 194                                         in_between(x1+w, x, x_m) and in_between(y1, y, y_m) or \
 195                                         in_between(x1, x, x_m) and in_between(y1+h, y, y_m) or \
 196                                         in_between(x1+w, x, x_m) and in_between(y1+h, y, y_m):
 197                                         return self
 198                         #handle horizontal or vertical lines
 199                         for (x1, y1), (x2, y2) in self._lines_list:
 200                                 if in_between(x1, x, x_m) and in_between(y1, y, y_m) or \
 201                                         in_between(x2, x, x_m) and in_between(y2, y, y_m):
 202                                         return self
 203                         return None
 204                 else:
 205                         #handle rectangular areas
 206                         for (x1,y1), (w,h) in self._areas_list:
 207                                 if in_between(x, x1, x1+w) and in_between(y, y1, y1+h): return self
 208                         #handle horizontal or vertical lines
 209                         for (x1, y1), (x2, y2) in self._lines_list:
 210                                 if x1 == x2: x1, x2 = x1-LINE_SELECT_SENSITIVITY, x2+LINE_SELECT_SENSITIVITY
 211                                 if y1 == y2: y1, y2 = y1-LINE_SELECT_SENSITIVITY, y2+LINE_SELECT_SENSITIVITY
 212                                 if in_between(x, x1, x2) and in_between(y, y1, y2): return self
 213                         return None
 214
 215         def get_rotation(self):
 216                 """
 217                 Get the rotation in degrees.
 218                 @return the rotation
 219                 """
 220                 return self.rotation
 221
 222         def set_rotation(self, rotation):
 223                 """
 224                 Set the rotation in degrees.
 225                 @param rotation the rotation"""
 226                 if rotation not in POSSIBLE_ROTATIONS:
 227                         raise Exception('"%s" is not one of the possible rotations: (%s)'%(rotation, POSSIBLE_ROTATIONS))
 228                 self.rotation = rotation