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