libs/canvas/rectangle.cc

   1 /*
   2     Copyright (C) 2011-2013 Paul Davis
   3     Author: Carl Hetherington <cth@carlh.net>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include <iostream>
  21 #include <cairomm/context.h>
  22 #include "pbd/stacktrace.h"
  23 #include "pbd/compose.h"
  24
  25 #include "canvas/canvas.h"
  26 #include "canvas/rectangle.h"
  27 #include "canvas/debug.h"
  28 #include "canvas/utils.h"
  29
  30 using namespace std;
  31 using namespace ArdourCanvas;
  32
  33 Rectangle::Rectangle (Canvas* c)
  34         : Item (c)
  35         , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
  36 {
  37 }
  38
  39 Rectangle::Rectangle (Canvas* c, Rect const & rect)
  40         : Item (c)
  41         , _rect (rect)
  42         , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
  43 {
  44 }
  45
  46 Rectangle::Rectangle (Item* parent)
  47         : Item (parent)
  48         , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
  49 {
  50 }
  51
  52 Rectangle::Rectangle (Item* parent, Rect const & rect)
  53         : Item (parent)
  54         , _rect (rect)
  55         , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
  56 {
  57 }
  58
  59 Rect
  60 Rectangle::get_self_for_render () const
  61 {
  62         /* In general, a Rectangle will have a _position of (0,0) within its
  63            parent, and its extent is actually defined by _rect. But in the
  64            unusual case that _position is set to something other than (0,0),
  65            we should take that into account when rendering.
  66         */
  67
  68         return item_to_window (_rect.translate (_position));
  69 }
  70
  71 void
  72 Rectangle::render_self (Rect const & area, Cairo::RefPtr<Cairo::Context> context, Rect self) const
  73 {
  74         boost::optional<Rect> r = self.intersection (area);
  75
  76         if (!r) {
  77                 return;
  78         }
  79
  80         Rect draw = r.get ();
  81
  82         if (_fill && !_transparent) {
  83                 if (_stops.empty()) {
  84                         setup_fill_context (context);
  85                 } else {
  86                         setup_gradient_context (context, self, Duple (draw.x0, draw.y0));
  87                 }
  88
  89                 context->rectangle (draw.x0, draw.y0, draw.width(), draw.height());
  90                 context->fill ();
  91         }
  92
  93         if (_outline) {
  94
  95                 setup_outline_context (context);
  96
  97                 /* the goal here is that if the border is 1 pixel
  98                  * thick, it will precisely align with the corner
  99                  * coordinates of the rectangle. So if the rectangle
 100                  * has a left edge at 0 and a right edge at 10, then
 101                  * the left edge must span 0..1, the right edge
 102                  * must span 9..10 because the first and final pixels
 103                  * to be colored are actually "at" 0.5 and 9.5 (midway
 104                  * between the integer coordinates.
 105                  */
 106
 107                 self = self.shrink (0.5);
 108
 109                 if (_outline_what == What (LEFT|RIGHT|BOTTOM|TOP)) {
 110
 111                         context->rectangle (self.x0, self.y0, self.width(), self.height());
 112
 113                 } else {
 114
 115                         if (_outline_what & LEFT) {
 116                                 context->move_to (self.x0, self.y0);
 117                                 context->line_to (self.x0, self.y1);
 118                         }
 119
 120                         if (_outline_what & TOP) {
 121                                 context->move_to (self.x0, self.y0);
 122                                 context->line_to (self.x1, self.y0);
 123                         }
 124
 125                         if (_outline_what & BOTTOM) {
 126                                 context->move_to (self.x0, self.y1);
 127                                 context->line_to (self.x1, self.y1);
 128                         }
 129
 130                         if (_outline_what & RIGHT) {
 131                                 context->move_to (self.x1, self.y0);
 132                                 context->line_to (self.x1, self.y1);
 133                         }
 134                 }
 135
 136                 context->stroke ();
 137         }
 138 }
 139
 140 void
 141 Rectangle::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
 142 {
 143         render_self (area, context, get_self_for_render ());
 144 }
 145
 146 void
 147 Rectangle::compute_bounding_box () const
 148 {
 149         if (!_rect.empty()) {
 150                 Rect r = _rect.fix ();
 151                 _bounding_box = r;
 152         }
 153
 154         _bounding_box_dirty = false;
 155 }
 156
 157 void
 158 Rectangle::set (Rect const & r)
 159 {
 160         /* We don't update the bounding box here; it's just
 161            as cheap to do it when asked.
 162         */
 163
 164         if (r != _rect) {
 165
 166                 begin_change ();
 167
 168                 _rect = r;
 169
 170                 _bounding_box_dirty = true;
 171                 end_change ();
 172         }
 173 }
 174
 175 void
 176 Rectangle::set_x0 (Coord x0)
 177 {
 178         if (x0 != _rect.x0) {
 179                 begin_change ();
 180
 181                 _rect.x0 = x0;
 182
 183                 _bounding_box_dirty = true;
 184                 end_change ();
 185         }
 186 }
 187
 188 void
 189 Rectangle::set_y0 (Coord y0)
 190 {
 191         if (y0 != _rect.y0) {
 192                 begin_change ();
 193
 194                 _rect.y0 = y0;
 195
 196                 _bounding_box_dirty = true;
 197                 end_change();
 198         }
 199 }
 200
 201 void
 202 Rectangle::set_x1 (Coord x1)
 203 {
 204         if (x1 != _rect.x1) {
 205                 begin_change ();
 206
 207                 _rect.x1 = x1;
 208
 209                 _bounding_box_dirty = true;
 210                 end_change ();
 211         }
 212 }
 213
 214 void
 215 Rectangle::set_y1 (Coord y1)
 216 {
 217         if (y1 != _rect.y1) {
 218                 begin_change ();
 219
 220                 _rect.y1 = y1;
 221
 222                 _bounding_box_dirty = true;
 223                 end_change ();
 224         }
 225 }
 226
 227 void
 228 Rectangle::set_outline_what (What what)
 229 {
 230         if (what != _outline_what) {
 231                 begin_visual_change ();
 232                 _outline_what = what;
 233                 end_visual_change ();
 234         }
 235 }
 236
 237
 238 /*-------------------*/
 239
 240 void
 241 TimeRectangle::compute_bounding_box () const
 242 {
 243         Rectangle::compute_bounding_box ();
 244
 245         if (_bounding_box) {
 246                 Rect r = _bounding_box.get ();
 247
 248                 /* This is a TimeRectangle, so its right edge is drawn 1 pixel beyond
 249                  * (larger x-axis coordinates) than a normal Rectangle.
 250                  */
 251
 252                 r.x1 += 1.0; /* this should be using safe_add() */
 253
 254                 _bounding_box = r;
 255         }
 256 }
 257
 258 void
 259 TimeRectangle::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
 260 {
 261         Rect self = get_self_for_render ();
 262
 263         /* This is a TimeRectangle, so its right edge is drawn 1 pixel beyond
 264          * (larger x-axis coordinates) than a normal Rectangle.
 265          */
 266
 267         self.x1 += 1.0; /* this should be using safe_add() */
 268         render_self (area, context, self);
 269 }