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                 item.expand (0.5);
 110                 boost::optional<Rect> draw = item.intersection (area);
 111
 112                 if (draw) {
 113 #ifdef CANVAS_DEBUG
 114                         if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
 115                                 cerr << _canvas->render_indent() << " render "
 116                                      << ' '
 117                                      << (*i)->whatami()
 118                                      << ' '
 119                                      << (*i)->name
 120                                      << " item = "
 121                                      << item
 122                                      << " intersect = "
 123                                      << draw.get()
 124                                      << endl;
 125                         }
 126 #endif
 127
 128                         (*i)->render (area, context);
 129                         ++render_count;
 130
 131                 } else {
 132 #ifdef CANVAS_DEBUG
 133                         if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
 134                                 //cerr << string_compose ("%1skip render of %2 %3, no intersection\n", _canvas->render_indent(), (*i)->whatami(),
 135                                 // (*i)->name);
 136                         }
 137 #endif
 138                 }
 139         }
 140
 141         --render_depth;
 142 }
 143
 144 void
 145 Group::compute_bounding_box () const
 146 {
 147         Rect bbox;
 148         bool have_one = false;
 149
 150         for (list<Item*>::const_iterator i = _items.begin(); i != _items.end(); ++i) {
 151
 152                 boost::optional<Rect> item_bbox = (*i)->bounding_box ();
 153
 154                 if (!item_bbox) {
 155                         continue;
 156                 }
 157
 158                 Rect group_bbox = (*i)->item_to_parent (item_bbox.get ());
 159                 if (have_one) {
 160                         bbox = bbox.extend (group_bbox);
 161                 } else {
 162                         bbox = group_bbox;
 163                         have_one = true;
 164                 }
 165         }
 166
 167         if (!have_one) {
 168                 _bounding_box = boost::optional<Rect> ();
 169         } else {
 170                 _bounding_box = bbox;
 171         }
 172
 173         _bounding_box_dirty = false;
 174 }
 175
 176 void
 177 Group::add (Item* i)
 178 {
 179         /* XXX should really notify canvas about this */
 180
 181         _items.push_back (i);
 182         invalidate_lut ();
 183         _bounding_box_dirty = true;
 184
 185
 186 }
 187
 188 void
 189 Group::remove (Item* i)
 190 {
 191
 192         if (i->parent() != this) {
 193                 return;
 194         }
 195
 196         begin_change ();
 197
 198         i->unparent ();
 199         _items.remove (i);
 200         invalidate_lut ();
 201         _bounding_box_dirty = true;
 202
 203         end_change ();
 204 }
 205
 206 void
 207 Group::clear (bool with_delete)
 208 {
 209         begin_change ();
 210
 211         for (list<Item*>::iterator i = _items.begin(); i != _items.end(); ++i) {
 212                 if (with_delete) {
 213                         delete *i;
 214                 } else {
 215                         (*i)->unparent ();
 216                 }
 217         }
 218
 219         _items.clear ();
 220
 221         invalidate_lut ();
 222         _bounding_box_dirty = true;
 223
 224         end_change ();
 225 }
 226
 227 void
 228 Group::raise_child_to_top (Item* i)
 229 {
 230         _items.remove (i);
 231         _items.push_back (i);
 232         invalidate_lut ();
 233 }
 234
 235 void
 236 Group::raise_child (Item* i, int levels)
 237 {
 238         list<Item*>::iterator j = find (_items.begin(), _items.end(), i);
 239         assert (j != _items.end ());
 240
 241         ++j;
 242         _items.remove (i);
 243
 244         while (levels > 0 && j != _items.end ()) {
 245                 ++j;
 246                 --levels;
 247         }
 248
 249         _items.insert (j, i);
 250         invalidate_lut ();
 251 }
 252
 253 void
 254 Group::lower_child_to_bottom (Item* i)
 255 {
 256         _items.remove (i);
 257         _items.push_front (i);
 258         invalidate_lut ();
 259 }
 260
 261 void
 262 Group::ensure_lut () const
 263 {
 264         if (!_lut) {
 265                 _lut = new DumbLookupTable (*this);
 266         }
 267 }
 268
 269 void
 270 Group::invalidate_lut () const
 271 {
 272         delete _lut;
 273         _lut = 0;
 274 }
 275
 276 void
 277 Group::child_changed ()
 278 {
 279         invalidate_lut ();
 280         _bounding_box_dirty = true;
 281
 282         if (_parent) {
 283                 _parent->child_changed ();
 284         }
 285 }
 286
 287 void
 288 Group::add_items_at_point (Duple const point, vector<Item const *>& items) const
 289 {
 290         /* Point is in canvas coordinate system */
 291
 292         boost::optional<Rect> const bbox = bounding_box ();
 293
 294         if (!bbox || !bbox.get().contains (point)) {
 295                 return;
 296         }
 297
 298         /* this adds this group itself to the list of items at point */
 299         Item::add_items_at_point (point, items);
 300
 301
 302         /* now recurse and add any items within our group that contain point */
 303
 304         ensure_lut ();
 305         vector<Item*> our_items = _lut->items_at_point (point);
 306
 307         for (vector<Item*>::iterator i = our_items.begin(); i != our_items.end(); ++i) {
 308                 (*i)->add_items_at_point (point - (*i)->position(), items);
 309         }
 310 }
 311
 312 void
 313 Group::dump (ostream& o) const
 314 {
 315 #ifdef CANVAS_DEBUG
 316         o << _canvas->indent();
 317         o << "Group " << this << " [" << name << ']';
 318         o << " @ " << position();
 319         o << " Items: " << _items.size();
 320         o << " Visible ? " << _visible;
 321
 322         boost::optional<Rect> bb = bounding_box();
 323
 324         if (bb) {
 325                 o << endl << _canvas->indent() << "  bbox: " << bb.get();
 326                 o << endl << _canvas->indent() << "  CANVAS bbox: " << item_to_canvas (bb.get());
 327         } else {
 328                 o << "  bbox unset";
 329         }
 330
 331         o << endl;
 332 #endif
 333
 334         ArdourCanvas::dump_depth++;
 335
 336         for (list<Item*>::const_iterator i = _items.begin(); i != _items.end(); ++i) {
 337                 o << **i;
 338         }
 339
 340         ArdourCanvas::dump_depth--;
 341 }