libs/canvas/canvas/canvas.h

   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 /** @file  canvas/canvas.h
  21  *  @brief Declaration of the main canvas classes.
  22  */
  23
  24 #ifndef __CANVAS_CANVAS_H__
  25 #define __CANVAS_CANVAS_H__
  26
  27 #include <gdkmm/window.h>
  28 #include <gtkmm/eventbox.h>
  29 #include <gtkmm/viewport.h>
  30 #include <cairomm/surface.h>
  31 #include <cairomm/context.h>
  32 #include "pbd/signals.h"
  33 #include "canvas/root_group.h"
  34
  35 class XMLTree;
  36
  37 namespace ArdourCanvas
  38 {
  39
  40 class Rect;
  41 class Group;
  42
  43 /** The base class for our different types of canvas.
  44  *
  45  *  A canvas is an area which holds a collection of canvas items, which in
  46  *  turn represent shapes, text, etc.
  47  *
  48  *  The canvas has an arbitrarily large area, and is addressed in coordinates
  49  *  of screen pixels, with an origin of (0, 0) at the top left.  x increases
  50  *  rightwards and y increases downwards.
  51  */
  52
  53 class Canvas
  54 {
  55 public:
  56         Canvas ();
  57         Canvas (XMLTree const *);
  58         virtual ~Canvas () {}
  59
  60         /** called to request a redraw of an area of the canvas */
  61         virtual void request_redraw (Rect const &) = 0;
  62         /** called to ask the canvas to request a particular size from its host */
  63         virtual void request_size (Duple) = 0;
  64         /** called to ask the canvas' host to `grab' an item */
  65         virtual void grab (Item *) = 0;
  66         /** called to ask the canvas' host to `ungrab' any grabbed item */
  67         virtual void ungrab () = 0;
  68
  69         void render (Rect const &, Cairo::RefPtr<Cairo::Context> const &) const;
  70
  71         /** @return root group */
  72         Group* root () {
  73                 return &_root;
  74         }
  75
  76         /** Called when an item is being destroyed */
  77         virtual void item_going_away (Item *, boost::optional<Rect>) {}
  78         void item_shown_or_hidden (Item *);
  79         void item_changed (Item *, boost::optional<Rect>);
  80         void item_moved (Item *, boost::optional<Rect>);
  81
  82         XMLTree* get_state () const;
  83
  84         virtual Cairo::RefPtr<Cairo::Context> context () = 0;
  85
  86         std::list<Rect> const & renders () const {
  87                 return _renders;
  88         }
  89
  90         void set_log_renders (bool log) {
  91                 _log_renders = log;
  92         }
  93
  94         std::string indent() const;
  95         void dump (std::ostream&) const;
  96
  97 protected:
  98         void queue_draw_item_area (Item *, Rect);
  99
 100         /** our root group */
 101         RootGroup _root;
 102
 103         mutable std::list<Rect> _renders;
 104         bool _log_renders;
 105 };
 106
 107 /** A Canvas which renders onto an in-memory pixbuf.  In Ardour's context,
 108  *  this is most useful for testing.
 109  */
 110 class ImageCanvas : public Canvas
 111 {
 112 public:
 113         ImageCanvas (Duple size = Duple (1024, 1024));
 114         ImageCanvas (XMLTree const *, Duple size = Duple (1024, 1024));
 115
 116         void request_redraw (Rect const &) {
 117                 /* XXX */
 118         }
 119
 120         void request_size (Duple) {
 121                 /* XXX */
 122         }
 123
 124         void grab (Item *) {}
 125         void ungrab () {}
 126
 127         void render_to_image (Rect const &) const;
 128         void clear ();
 129         void write_to_png (std::string const &);
 130
 131         Cairo::RefPtr<Cairo::Context> context ();
 132
 133 private:
 134         /** our Cairo surface */
 135         Cairo::RefPtr<Cairo::Surface> _surface;
 136         /** our Cairo context */
 137         Cairo::RefPtr<Cairo::Context> _context;
 138 };
 139
 140 /** A canvas which renders onto a GTK EventBox */
 141 class GtkCanvas : public Canvas, public Gtk::EventBox
 142 {
 143 public:
 144         GtkCanvas ();
 145         GtkCanvas (XMLTree const *);
 146
 147         void request_redraw (Rect const &);
 148         void request_size (Duple);
 149         void grab (Item *);
 150         void ungrab ();
 151
 152         Cairo::RefPtr<Cairo::Context> context ();
 153
 154 protected:
 155         bool on_expose_event (GdkEventExpose *);
 156         bool on_button_press_event (GdkEventButton *);
 157         bool on_button_release_event (GdkEventButton* event);
 158         bool on_motion_notify_event (GdkEventMotion *);
 159
 160         bool button_handler (GdkEventButton *);
 161         bool motion_notify_handler (GdkEventMotion *);
 162         bool deliver_event (Duple, GdkEvent *);
 163
 164 private:
 165         void item_going_away (Item *, boost::optional<Rect>);
 166         bool send_leave_event (Item const *, double, double) const;
 167
 168         /** the item that the mouse is currently over, or 0 */
 169         Item const * _current_item;
 170         /** the item that is currently grabbed, or 0 */
 171         Item const * _grabbed_item;
 172 };
 173
 174 /** A GTK::Viewport with a GtkCanvas inside it.  This provides a GtkCanvas
 175  *  that can be scrolled.
 176  */
 177 class GtkCanvasViewport : public Gtk::Viewport
 178 {
 179 public:
 180         GtkCanvasViewport (Gtk::Adjustment &, Gtk::Adjustment &);
 181
 182         /** @return our GtkCanvas */
 183         GtkCanvas* canvas () {
 184                 return &_canvas;
 185         }
 186
 187         void window_to_canvas (int, int, Coord &, Coord &) const;
 188         Rect visible_area () const;
 189
 190 protected:
 191         void on_size_request (Gtk::Requisition *);
 192
 193 private:
 194         /** our GtkCanvas */
 195         GtkCanvas _canvas;
 196 };
 197
 198 }
 199
 200 std::ostream& operator<< (std::ostream&, const ArdourCanvas::Canvas&);
 201
 202 #endif