several changes, major and minor, to improve threaded waveview rendering
[ardour.git] / libs / canvas / canvas / rectangle.h
index dd8232c4393b20d67d4fe8d488807ec1b2510af0..b979a24430bfd12e010da03ad3cc303c54a4d15b 100644 (file)
@@ -1,24 +1,42 @@
+/*
+    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.
+*/
+
 #ifndef __CANVAS_RECTANGLE_H__
 #define __CANVAS_RECTANGLE_H__
 
+#include "canvas/visibility.h"
 #include "canvas/item.h"
 #include "canvas/types.h"
-#include "canvas/outline.h"
-#include "canvas/fill.h"
 
 namespace ArdourCanvas
 {
 
-class Rectangle : virtual public Item, public Outline, public Fill
+class LIBCANVAS_API Rectangle : public Item
 {
 public:
-       Rectangle (Group *);
-       Rectangle (Group *, Rect const &);
+       Rectangle (Canvas*);
+       Rectangle (Canvas*, Rect const &);
+       Rectangle (Item*);
+       Rectangle (Item*, Rect const &);
        
        void render (Rect const &, Cairo::RefPtr<Cairo::Context>) const;
        void compute_bounding_box () const;
-       XMLNode* get_state () const;
-       void set_state (XMLNode const *);
 
        Rect const & get () const {
                return _rect;
@@ -46,17 +64,34 @@ public:
        void set_x1 (Coord);
        void set_y1 (Coord);
 
+        /** return @param y as a floating point fraction of the overall
+         *  height of the rectangle. @param y is in canvas coordinate space.
+         * 
+         *  A value of zero indicates that y is at the bottom of the
+         *  rectangle; a value of 1 indicates that y is at the top.
+         *
+         *  Will return zero if there is no bounding box or if y
+         *  is outside the bounding box.
+         */
+        double vertical_fraction (double y) const;
+
        enum What {
+               NOTHING = 0x0,
                LEFT = 0x1,
                RIGHT = 0x2,
                TOP = 0x4,
-               BOTTOM = 0x8
+               BOTTOM = 0x8,
+               ALL = LEFT|RIGHT|TOP|BOTTOM,
        };
 
        void set_outline_what (What);
-       void set_outline_what (int);
+       void set_outline_all () { set_outline_what (ArdourCanvas::Rectangle::ALL); }
+
+  protected:
+       void render_self (Rect const &, Cairo::RefPtr<Cairo::Context>, Rect) const;
+       Rect get_self_for_render () const;
 
-private:
+  private:
        /** Our rectangle; note that x0 may not always be less than x1
         *  and likewise with y0 and y1.
         */