libs/canvas/group.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
  23 #include "pbd/stacktrace.h"
  24 #include "pbd/compose.h"
  25
  26 #include "canvas/group.h"
  27 #include "canvas/types.h"
  28 #include "canvas/debug.h"
  29 #include "canvas/item.h"
  30 #include "canvas/canvas.h"
  31
  32 using namespace std;
  33 using namespace ArdourCanvas;
  34
  35 int Group::default_items_per_cell = 64;
  36
  37
  38 Group::Group (Canvas* canvas)
  39         : Item (canvas)
  40         , _lut (0)
  41 {
  42
  43 }
  44
  45 Group::Group (Group* parent)
  46         : Item (parent)
  47         , _lut (0)
  48 {
  49
  50 }
  51
  52 Group::Group (Group* parent, Duple position)
  53         : Item (parent, position)
  54         , _lut (0)
  55 {
  56
  57 }
  58
  59 Group::~Group ()
  60 {
  61         for (list<Item*>::iterator i = _items.begin(); i != _items.end(); ++i) {
  62                 (*i)->unparent ();
  63         }
  64
  65         _items.clear ();
  66 }
  67
  68 /** @param area Area to draw in this group's coordinates.
  69  *  @param context Context, set up with its origin at this group's position.
  70  */
  71 void
  72 Group::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
  73 {
  74         ensure_lut ();
  75         vector<Item*> items = _lut->get (area);
  76
  77         ++render_depth;
  78
  79 #ifdef CANVAS_DEBUG
  80         if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
  81                 cerr << string_compose ("%1GROUP %2 render %5 %3 items out of %4\n",
  82                                         _canvas->render_indent(), (name.empty() ? string ("[unnamed]") : name), items.size(), _items.size(), area);
  83         }
  84 #endif
  85
  86         for (vector<Item*>::const_iterator i = items.begin(); i != items.end(); ++i) {
  87
  88                 if (!(*i)->visible ()) {
  89 #ifdef CANVAS_DEBUG
  90                         if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
  91                                 // cerr << _canvas->render_indent() << "Item " << (*i)->whatami() << " [" << (*i)->name << "] invisible - skipped\n";
  92                         }
  93 #endif
  94                         continue;
  95                 }
  96
  97                 boost::optional<Rect> item_bbox = (*i)->bounding_box ();
  98
  99                 if (!item_bbox) {
 100 #ifdef CANVAS_DEBUG
 101                         if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
 102                                 // cerr << _canvas->render_indent() << "Item " << (*i)->whatami() << " [" << (*i)->name << "] empty - skipped\n";
 103                         }
 104 #endif
 105                         continue;
 106                 }
 107
 108                 Rect item = (*i)->item_to_window (item_bbox.get());
 109                 boost::optional<Rect> draw = item.intersection (area);
 110
 111                 if (draw) {
 112 #ifdef CANVAS_DEBUG
 113                         if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
 114                                 cerr << string_compose ("%1render %2 %3\n", _canvas->render_indent(), (*i)->whatami(),
 115                                                         (*i)->name);
 116                         }
 117 #endif
 118
 119                         (*i)->render (area, context);
 120                         ++render_count;
 121
 122                 } else {
 123 #ifdef CANVAS_DEBUG
 124                         if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
 125                                 //cerr << string_compose ("%1skip render of %2 %3, no intersection\n", _canvas->render_indent(), (*i)->whatami(),
 126                                 // (*i)->name);
 127                         }
 128 #endif
 129                 }
 130         }
 131
 132         --render_depth;
 133 }
 134
 135 void
 136 Group::compute_bounding_box () const
 137 {
 138         Rect bbox;
 139         bool have_one = false;
 140
 141         for (list<Item*>::const_iterator i = _items.begin(); i != _items.end(); ++i) {
 142                 boost::optional<Rect> item_bbox = (*i)->bounding_box ();
 143                 if (!item_bbox) {
 144                         continue;
 145                 }
 146
 147                 Rect group_bbox = (*i)->item_to_parent (item_bbox.get ());
 148                 if (have_one) {
 149                         bbox = bbox.extend (group_bbox);
 150                 } else {
 151                         bbox = group_bbox;
 152                         have_one = true;
 153                 }
 154         }
 155
 156         if (!have_one) {
 157                 _bounding_box = boost::optional<Rect> ();
 158         } else {
 159                 _bounding_box = bbox;
 160         }
 161
 162         _bounding_box_dirty = false;
 163 }
 164
 165 void
 166 Group::add (Item* i)
 167 {
 168         /* XXX should really notify canvas about this */
 169
 170         _items.push_back (i);
 171         invalidate_lut ();
 172         _bounding_box_dirty = true;
 173
 174
 175 }
 176
 177 void
 178 Group::remove (Item* i)
 179 {
 180
 181         if (i->parent() != this) {
 182                 return;
 183         }
 184
 185         begin_change ();
 186
 187         i->unparent ();
 188         _items.remove (i);
 189         invalidate_lut ();
 190         _bounding_box_dirty = true;
 191
 192         end_change ();
 193 }
 194
 195 void
 196 Group::clear (bool with_delete)
 197 {
 198         begin_change ();
 199
 200         for (list<Item*>::iterator i = _items.begin(); i != _items.end(); ++i) {
 201                 if (with_delete) {
 202                         delete *i;
 203                 } else {
 204                         (*i)->unparent ();
 205                 }
 206         }
 207
 208         _items.clear ();
 209
 210         invalidate_lut ();
 211         _bounding_box_dirty = true;
 212
 213         end_change ();
 214 }
 215
 216 void
 217 Group::raise_child_to_top (Item* i)
 218 {
 219         _items.remove (i);
 220         _items.push_back (i);
 221         invalidate_lut ();
 222 }
 223
 224 void
 225 Group::raise_child (Item* i, int levels)
 226 {
 227         list<Item*>::iterator j = find (_items.begin(), _items.end(), i);
 228         assert (j != _items.end ());
 229
 230         ++j;
 231         _items.remove (i);
 232
 233         while (levels > 0 && j != _items.end ()) {
 234                 ++j;
 235                 --levels;
 236         }
 237
 238         _items.insert (j, i);
 239         invalidate_lut ();
 240 }
 241
 242 void
 243 Group::lower_child_to_bottom (Item* i)
 244 {
 245         _items.remove (i);
 246         _items.push_front (i);
 247         invalidate_lut ();
 248 }
 249
 250 void
 251 Group::ensure_lut () const
 252 {
 253         if (!_lut) {
 254                 _lut = new DumbLookupTable (*this);
 255         }
 256 }
 257
 258 void
 259 Group::invalidate_lut () const
 260 {
 261         delete _lut;
 262         _lut = 0;
 263 }
 264
 265 void
 266 Group::child_changed ()
 267 {
 268         invalidate_lut ();
 269         _bounding_box_dirty = true;
 270
 271         if (_parent) {
 272                 _parent->child_changed ();
 273         }
 274 }
 275
 276 void
 277 Group::add_items_at_point (Duple const point, vector<Item const *>& items) const
 278 {
 279         boost::optional<Rect> const bbox = bounding_box ();
 280
 281         if (!bbox || !bbox.get().contains (point)) {
 282                 return;
 283         }
 284
 285         Item::add_items_at_point (point, items);
 286
 287         ensure_lut ();
 288
 289         vector<Item*> our_items = _lut->items_at_point (point);
 290         for (vector<Item*>::iterator i = our_items.begin(); i != our_items.end(); ++i) {
 291                 (*i)->add_items_at_point (point - (*i)->position(), items);
 292         }
 293 }
 294
 295 void
 296 Group::dump (ostream& o) const
 297 {
 298 #ifdef CANVAS_DEBUG
 299         o << _canvas->indent();
 300         o << "Group " << this << " [" << name << ']';
 301         o << " @ " << position();
 302         o << " Items: " << _items.size();
 303         o << " Visible ? " << _visible;
 304
 305         boost::optional<Rect> bb = bounding_box();
 306
 307         if (bb) {
 308                 o << endl << _canvas->indent() << "  bbox: " << bb.get();
 309                 o << endl << _canvas->indent() << "  CANVAS bbox: " << item_to_canvas (bb.get());
 310         } else {
 311                 o << "  bbox unset";
 312         }
 313
 314         o << endl;
 315 #endif
 316
 317         ArdourCanvas::dump_depth++;
 318
 319         for (list<Item*>::const_iterator i = _items.begin(); i != _items.end(); ++i) {
 320                 o << **i;
 321         }
 322
 323         ArdourCanvas::dump_depth--;
 324 }