Fix some capitalisation in the preferences dialog.
[ardour.git] / libs / canvas / rectangle.cc
index cff7beffd47974be342c545f34b802e77335ef2e..57c26874c454de36fb256c46f3b3f75cd7bc751b 100644 (file)
@@ -1,8 +1,28 @@
+/*
+    Copyright (C) 2011-2013 Paul Davis
+    Author: Carl Hetherington <cth@carlh.net>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
 #include <iostream>
 #include <cairomm/context.h>
 #include "pbd/stacktrace.h"
-#include "pbd/xml++.h"
 #include "pbd/compose.h"
+
+#include "canvas/canvas.h"
 #include "canvas/rectangle.h"
 #include "canvas/debug.h"
 #include "canvas/utils.h"
@@ -16,7 +36,6 @@ Rectangle::Rectangle (Group* parent)
        , Fill (parent)
        , _outline_what ((What) (LEFT | RIGHT | TOP | BOTTOM))
 {
-
 }
 
 Rectangle::Rectangle (Group* parent, Rect const & rect)
@@ -30,77 +49,87 @@ Rectangle::Rectangle (Group* parent, Rect const & rect)
 }
 
 void
-Rectangle::render (Rect const & /*area*/, Cairo::RefPtr<Cairo::Context> context) const
+Rectangle::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
 {
-       Rect plot = _rect;
+       Rect self = item_to_window (_rect);
+       boost::optional<Rect> r = self.intersection (area);
 
-       plot.x1 = min (plot.x1, CAIRO_MAX);
-       plot.y1 = min (plot.y1, CAIRO_MAX);
+       if (!r) {
+               return;
+       }
 
-       if (_fill) {
-               setup_fill_context (context);
-               context->rectangle (plot.x0, plot.y0, plot.width(), plot.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);
                
+               /* see the cairo FAQ on single pixel lines to see why we do
+                * the 0.5 pixel additions.
+                */
+
                if (_outline_what == What (LEFT|RIGHT|BOTTOM|TOP)) {
-                       context->rectangle (plot.x0, plot.y0, plot.width(), plot.height());
-                       setup_outline_context (context);
-                       context->stroke ();
                        
+                       context->rectangle (self.x0 + 0.5, self.y0 + 0.5, self.width() - 1.0, self.height() - 1.0);
+
                } else {
-                       
+
                        if (_outline_what & LEFT) {
-                               context->move_to (plot.x0, plot.y0);
-                               context->line_to (plot.x0, plot.y1);
+                               /* vertical line: move x-coordinate by 0.5 pixels */
+                               context->move_to (self.x0 + 0.5, self.y0);
+                               context->line_to (self.x0 + 0.5, self.y1);
                        }
                        
+                       if (_outline_what & TOP) {
+                               /* horizontal line: move y-coordinate by 0.5 pixels */
+                               context->move_to (self.x0, self.y0 + 0.5);
+                               context->line_to (self.x1, self.y0 + 0.5);
+                       }
+
                        if (_outline_what & BOTTOM) {
-                               context->move_to (plot.x0, plot.y1);
-                               context->line_to (plot.x1, plot.y1);
+                               /* horizontal line: move y-coordinate by 0.5 pixels */
+                               context->move_to (self.x0, self.y1 - 0.5);
+                               context->line_to (self.x1, self.y1 - 0.5);
                        }
                        
                        if (_outline_what & RIGHT) {
-                               context->move_to (plot.x1, plot.y0);
-                               context->line_to (plot.x1, plot.y1);
+                               /* vertical line: move x-coordinate by 0.5 pixels */
+                               context->move_to (self.x1 + 0.5, self.y0);
+                               context->line_to (self.x1 + 0.5, self.y1);
                        }
                        
-                       if (_outline_what & TOP) {
-                               context->move_to (plot.x0, plot.y0);
-                               context->line_to (plot.x1, plot.y0);
-                       }
-                       
-                       setup_outline_context (context);
-                       context->stroke ();
                }
+               
+               context->stroke ();
        }
 }
 
 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 ();
+               /* take into acount the 0.5 addition to the bounding
+                  box for the right and bottom edges, see ::render() above
+               */
+
+               r.x1 += 1.0; // XXX this makes no sense but is necessary
+               r.y1 += 0.5;
+
+               _bounding_box = r;
+       }
+
        _bounding_box_dirty = false;
 }
 
@@ -110,118 +139,77 @@ 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);
-}
-
-XMLNode *
-Rectangle::get_state () const
-{
-       XMLNode* node = new XMLNode ("Rectangle");
-#ifdef CANVAS_DEBUG
-       if (!name.empty ()) {
-               node->add_property ("name", name);
+       if (what != _outline_what) {
+               begin_visual_change ();
+               _outline_what = what;
+               end_visual_change ();
        }
-#endif 
-       node->add_property ("x0", string_compose ("%1", _rect.x0));
-       node->add_property ("y0", string_compose ("%1", _rect.y0));
-       node->add_property ("x1", string_compose ("%1", _rect.x1));
-       node->add_property ("y1", string_compose ("%1", _rect.y1));
-       node->add_property ("outline-what", string_compose ("%1", _outline_what));
-
-       add_item_state (node);
-       add_outline_state (node);
-       add_fill_state (node);
-       return node;
 }
 
-void
-Rectangle::set_state (XMLNode const * node)
-{
-       _rect.x0 = atof (node->property("x0")->value().c_str());
-       _rect.y0 = atof (node->property("y0")->value().c_str());
-       _rect.x1 = atof (node->property("x1")->value().c_str());
-       _rect.y1 = atof (node->property("y1")->value().c_str());
-       _outline_what = (What) atoi (node->property("outline-what")->value().c_str());
-
-       set_item_state (node);
-       set_outline_state (node);
-       set_fill_state (node);
-
-       _bounding_box_dirty = true;
-}