Fix 0006183 (waveview crash).
[ardour.git] / libs / canvas / rectangle.cc
index 7abf13216b4e06e99f9874bfeda438852740884b..07288d5d3331acb228dba0755423b9190ce58cee 100644 (file)
 using namespace std;
 using namespace ArdourCanvas;
 
-Rectangle::Rectangle (Group* parent)
-       : Item (parent)
-       , Outline (parent)
-       , Fill (parent)
+Rectangle::Rectangle (Canvas* c)
+       : Item (c)
+       , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
+{
+}
+
+Rectangle::Rectangle (Canvas* c, Rect const & rect)
+       : Item (c)
+       , _rect (rect)
        , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
 {
+}
 
+Rectangle::Rectangle (Item* parent)
+       : Item (parent)
+       , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
+{
 }
 
-Rectangle::Rectangle (Group* parent, Rect const & rect)
+Rectangle::Rectangle (Item* parent, Rect const & rect)
        : Item (parent)
-       , Outline (parent)
-       , Fill (parent)
        , _rect (rect)
        , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
 {
-       
 }
 
-void
-Rectangle::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
+Rect
+Rectangle::get_self_for_render () const
 {
-       /* Cairo goes a little (!) wrong when asked to fill/stroke rectangles that
-        * extend way beyond the surface boundaries. To avoid this issue,
-        * clamp what we are drawing using the absolute end of the visible
-        * canvas, converting to item-space coordinates, of course.
-        */
+       /* In general, a Rectangle will have a _position of (0,0) within its
+          parent, and its extent is actually defined by _rect. But in the
+          unusual case that _position is set to something other than (0,0),
+          we should take that into account when rendering.
+       */
 
-       Rect self = item_to_window (_rect);
-       boost::optional<Rect> draw = self.intersection (area);
+       return item_to_window (_rect.translate (_position), false);
+}
 
-       if (_fill && draw) {
-               setup_fill_context (context);
+void
+Rectangle::render_self (Rect const & area, Cairo::RefPtr<Cairo::Context> context, Rect self) const
+{
+       boost::optional<Rect> r = self.intersection (area);
+       
+       if (!r) {
+               return;
+       }
 
-               context->rectangle (draw->x0, draw->y0, draw->width(), draw->height());
-               
-               if (!_outline) {
-                       context->fill ();
+       Rect draw = r.get ();
+
+       if (_fill && !_transparent) {
+               if (_stops.empty()) {
+                       setup_fill_context (context);
                } else {
-                       
-                       /* special/common case: outline the entire rectangle is
-                        * requested, so just use the same path for the fill
-                        * and stroke.
-                        */
-
-                       if (_outline_what == What (LEFT|RIGHT|BOTTOM|TOP)) {
-                               context->fill_preserve();
-                               setup_outline_context (context);
-                               context->stroke ();
-                       } else {
-                               context->fill ();
-                       }
+                       setup_gradient_context (context, self, Duple (draw.x0, draw.y0));
                }
+
+               context->rectangle (draw.x0, draw.y0, draw.width(), draw.height());
+               context->fill ();
        } 
        
        if (_outline) {
-               
-               setup_outline_context (context);
 
+               setup_outline_context (context);
+               
+               /* the goal here is that if the border is 1 pixel
+                * thick, it will precisely align with the corner
+                * coordinates of the rectangle. So if the rectangle
+                * has a left edge at 0 and a right edge at 10, then
+                * the left edge must span 0..1, the right edge
+                * must span 10..11 because the first and final pixels
+                * to be colored are actually "at" 0.5 and 10.5 (midway
+                * between the integer coordinates).
+                *
+                * See the Cairo FAQ on single pixel lines for more 
+                * detail.
+                */
+
+               if (fmod (_outline_width, 2.0)  != 0.0) {
+                       const double shift = _outline_width * 0.5;
+                       self = self.translate (Duple (shift, shift));
+               }
+               
                if (_outline_what == What (LEFT|RIGHT|BOTTOM|TOP)) {
-
-                       /* if we filled and use full outline, we are already
-                        * done. otherwise, draw the frame here.
-                        */
-
-                       if (!_fill) { 
-                               context->rectangle (draw->x0, draw->y0, draw->width(), draw->height());
-                               context->stroke ();
-                       }
                        
+                       context->rectangle (self.x0, self.y0, self.width(), self.height());
+
                } else {
-                       
+
                        if (_outline_what & LEFT) {
-                               context->move_to (draw->x0, draw->y0);
-                               context->line_to (draw->x0, draw->y1);
+                               context->move_to (self.x0, self.y0);
+                               context->line_to (self.x0, self.y1);
                        }
                        
+                       if (_outline_what & TOP) {
+                               context->move_to (self.x0, self.y0);
+                               context->line_to (self.x1, self.y0);
+                       }
+
                        if (_outline_what & BOTTOM) {
-                               context->move_to (draw->x0, draw->y1);
-                               context->line_to (draw->x1, draw->y1);
+                               context->move_to (self.x0, self.y1);
+                               context->line_to (self.x1, self.y1);
                        }
                        
                        if (_outline_what & RIGHT) {
-                               context->move_to (draw->x1, draw->y0);
-                               context->line_to (draw->x1, draw->y1);
+                               context->move_to (self.x1, self.y0);
+                               context->line_to (self.x1, self.y1);
                        }
-                       
-                       if (_outline_what & TOP) {
-                               context->move_to (draw->x0, draw->y0);
-                               context->line_to (draw->x1, draw->y0);
-                       }
-                       
-                       context->stroke ();
                }
+               
+               context->stroke ();
        }
 }
 
+void
+Rectangle::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
+{
+       render_self (area, context, get_self_for_render ());
+}
+
 void
 Rectangle::compute_bounding_box () const
 {
-       Rect r = _rect.fix ();
-       _bounding_box = boost::optional<Rect> (r.expand (_outline_width / 2));
-       
+       if (!_rect.empty()) {
+               Rect r = _rect.fix ();
+
+               /* if the outline is 1 pixel, then the actual
+                  bounding box is 0.5 pixels outside the stated
+                  corners of the rectangle.
+
+                  if the outline is 2 pixels, then the actual
+                  bounding box is 1.0 pixels outside the stated
+                  corners of the rectangle (so that the middle
+                  of the 2 pixel wide border passes through
+                  the corners, alternatively described as 1 row 
+                  of pixels outside of the corners, and 1 row
+                  inside).
+
+                  if the outline is 3 pixels, then the actual
+                  bounding box is 1.5 outside the stated corners
+                  of the rectangle (so that the middle row of
+                  pixels of the border passes through the corners).
+
+                  if the outline is 4 pixels, then the actual bounding
+                  box is 2.0 pixels outside the stated corners
+                  of the rectangle, so that the border consists
+                  of 2 pixels outside the corners and 2 pixels inside.
+
+                  hence ... the bounding box is width * 0.5 larger
+                  than the rectangle itself.
+               */
+
+               _bounding_box = r.expand (1.0 + _outline_width * 0.5);
+       }
+
        _bounding_box_dirty = false;
 }
 
@@ -142,82 +193,76 @@ Rectangle::set (Rect const & r)
        /* We don't update the bounding box here; it's just
           as cheap to do it when asked.
        */
-       
-       begin_change ();
-       
-       _rect = r;
-       
-       _bounding_box_dirty = true;
-       end_change ();
 
-       DEBUG_TRACE (PBD::DEBUG::CanvasItemsDirtied, "canvas item dirty: rectangle change (set)\n");
+       if (r != _rect) {
+               
+               begin_change ();
+               
+               _rect = r;
+               
+               _bounding_box_dirty = true;
+               end_change ();
+       }
 }
 
 void
 Rectangle::set_x0 (Coord x0)
 {
-       begin_change ();
-
-       _rect.x0 = x0;
-
-       _bounding_box_dirty = true;
-       end_change ();
-
-       DEBUG_TRACE (PBD::DEBUG::CanvasItemsDirtied, "canvas item dirty: rectangle change (x0)\n");
+       if (x0 != _rect.x0) {
+               begin_change ();
+               
+               _rect.x0 = x0;
+               
+               _bounding_box_dirty = true;
+               end_change ();
+       }
 }
 
 void
 Rectangle::set_y0 (Coord y0)
 {
-       begin_change ();
-       
-       _rect.y0 = y0;
-
-       _bounding_box_dirty = true;
-       end_change();
-
-       DEBUG_TRACE (PBD::DEBUG::CanvasItemsDirtied, "canvas item dirty: rectangle change (y0)\n");
+       if (y0 != _rect.y0) {
+               begin_change ();
+               
+               _rect.y0 = y0;
+               
+               _bounding_box_dirty = true;
+               end_change();
+       }
 }
 
 void
 Rectangle::set_x1 (Coord x1)
 {
-       begin_change ();
-       
-       _rect.x1 = x1;
-
-       _bounding_box_dirty = true;
-       end_change ();
-
-       DEBUG_TRACE (PBD::DEBUG::CanvasItemsDirtied, "canvas item dirty: rectangle change (x1)\n");
+       if (x1 != _rect.x1) {
+               begin_change ();
+               
+               _rect.x1 = x1;
+               
+               _bounding_box_dirty = true;
+               end_change ();
+       }
 }
 
 void
 Rectangle::set_y1 (Coord y1)
 {
-       begin_change ();
-
-       _rect.y1 = y1;
-
-       _bounding_box_dirty = true;
-       end_change ();
-
-       DEBUG_TRACE (PBD::DEBUG::CanvasItemsDirtied, "canvas item dirty: rectangle change (y1)\n");
+       if (y1 != _rect.y1) {
+               begin_change ();
+               
+               _rect.y1 = y1;
+               
+               _bounding_box_dirty = true;
+               end_change ();
+       }
 }
 
 void
 Rectangle::set_outline_what (What what)
 {
-       begin_change ();
-       
-       _outline_what = what;
-
-       end_change ();
-}
-
-void
-Rectangle::set_outline_what (int what)
-{
-       set_outline_what ((What) what);
+       if (what != _outline_what) {
+               begin_visual_change ();
+               _outline_what = what;
+               end_visual_change ();
+       }
 }
-