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 void
  60 Rectangle::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) 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         Rect self = item_to_window (_rect.translate (_position));
  68         boost::optional<Rect> r = self.intersection (area);
  69
  70         if (!r) {
  71                 return;
  72         }
  73
  74         Rect draw = r.get ();
  75
  76         if (_fill && !_transparent) {
  77                 if (_stops.empty()) {
  78                         setup_fill_context (context);
  79                 } else {
  80                         setup_gradient_context (context, self, Duple (draw.x0, draw.y0));
  81                 }
  82
  83                 context->rectangle (draw.x0, draw.y0, draw.width(), draw.height());
  84                 context->fill ();
  85         }
  86
  87         if (_outline) {
  88
  89                 setup_outline_context (context);
  90
  91                 /* see the cairo FAQ on single pixel lines to see why we do
  92                  * the 0.5 pixel additions.
  93                  */
  94
  95                 if (_outline_what == What (LEFT|RIGHT|BOTTOM|TOP)) {
  96
  97                         context->rectangle (self.x0 + 0.5, self.y0 + 0.5, self.width() - 1.0, self.height() - 1.0);
  98
  99                 } else {
 100
 101                         if (_outline_what & LEFT) {
 102                                 /* vertical line: move x-coordinate by 0.5 pixels */
 103                                 context->move_to (self.x0 + 0.5, self.y0);
 104                                 context->line_to (self.x0 + 0.5, self.y1);
 105                         }
 106
 107                         if (_outline_what & TOP) {
 108                                 /* horizontal line: move y-coordinate by 0.5 pixels */
 109                                 context->move_to (self.x0, self.y0 + 0.5);
 110                                 context->line_to (self.x1, self.y0 + 0.5);
 111                         }
 112
 113                         if (_outline_what & BOTTOM) {
 114                                 /* horizontal line: move y-coordinate by 0.5 pixels */
 115                                 context->move_to (self.x0, self.y1 - 0.5);
 116                                 context->line_to (self.x1, self.y1 - 0.5);
 117                         }
 118
 119                         if (_outline_what & RIGHT) {
 120                                 /* vertical line: move x-coordinate by 0.5 pixels */
 121                                 context->move_to (self.x1 + 0.5, self.y0);
 122                                 context->line_to (self.x1 + 0.5, self.y1);
 123                         }
 124
 125                 }
 126
 127                 context->stroke ();
 128         }
 129 }
 130
 131 void
 132 Rectangle::compute_bounding_box () const
 133 {
 134         if (!_rect.empty()) {
 135                 Rect r = _rect.fix ();
 136                 /* take into acount the 0.5 addition to the bounding
 137                    box for the right and bottom edges, see ::render() above
 138                 */
 139
 140                 r.x1 += 1.0; // XXX this makes no sense but is necessary
 141                 r.y1 += 0.5;
 142
 143                 _bounding_box = r;
 144         }
 145
 146         _bounding_box_dirty = false;
 147 }
 148
 149 void
 150 Rectangle::set (Rect const & r)
 151 {
 152         /* We don't update the bounding box here; it's just
 153            as cheap to do it when asked.
 154         */
 155
 156         if (r != _rect) {
 157
 158                 begin_change ();
 159
 160                 _rect = r;
 161
 162                 _bounding_box_dirty = true;
 163                 end_change ();
 164         }
 165 }
 166
 167 void
 168 Rectangle::set_x0 (Coord x0)
 169 {
 170         if (x0 != _rect.x0) {
 171                 begin_change ();
 172
 173                 _rect.x0 = x0;
 174
 175                 _bounding_box_dirty = true;
 176                 end_change ();
 177         }
 178 }
 179
 180 void
 181 Rectangle::set_y0 (Coord y0)
 182 {
 183         if (y0 != _rect.y0) {
 184                 begin_change ();
 185
 186                 _rect.y0 = y0;
 187
 188                 _bounding_box_dirty = true;
 189                 end_change();
 190         }
 191 }
 192
 193 void
 194 Rectangle::set_x1 (Coord x1)
 195 {
 196         if (x1 != _rect.x1) {
 197                 begin_change ();
 198
 199                 _rect.x1 = x1;
 200
 201                 _bounding_box_dirty = true;
 202                 end_change ();
 203         }
 204 }
 205
 206 void
 207 Rectangle::set_y1 (Coord y1)
 208 {
 209         if (y1 != _rect.y1) {
 210                 begin_change ();
 211
 212                 _rect.y1 = y1;
 213
 214                 _bounding_box_dirty = true;
 215                 end_change ();
 216         }
 217 }
 218
 219 void
 220 Rectangle::set_outline_what (What what)
 221 {
 222         if (what != _outline_what) {
 223                 begin_visual_change ();
 224                 _outline_what = what;
 225                 end_visual_change ();
 226         }
 227 }
 228