kworship/display/KwAbstractDisplay.cpp

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship 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  *   KWorship 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 KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 /**
  21  * @file KwAbstractDisplay.cpp
  22  * @brief Display interface class.
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "KwAbstractDisplay.h"
  27
  28 #include <cassert>
  29
  30 /*
  31  * Constructors + destructors
  32  */
  33
  34 /// Default constructor.
  35 KwAbstractDisplay::KwAbstractDisplay()
  36 : m_parent(0)
  37 , m_children()
  38 , m_displayResolution(800,600)
  39 , m_layers()
  40 {
  41 }
  42
  43 /// Destructor.
  44 KwAbstractDisplay::~KwAbstractDisplay()
  45 {
  46   /// Disconnect each of the children.
  47   DisplayList::iterator it;
  48   for (it = m_children.begin(); it != m_children.end(); ++it)
  49   {
  50     childDetachedEvent(*it);
  51     assert((*it)->m_parent == this &&"Child not correctly parented");
  52     (*it)->m_parent = 0;
  53     (*it)->disconnectedEvent();
  54   }
  55
  56   /// Disconnect from parent.
  57   if (0 != m_parent)
  58   {
  59     m_parent->detachChild(this);
  60   }
  61 }
  62
  63 /*
  64  * Heirarchy management
  65  */
  66
  67 /// Attach a child to this object.
  68 void KwAbstractDisplay::attachChild(KwAbstractDisplay* child)
  69 {
  70   /// @note Potential MT/Callback issue. child is attached before it is brought up to date so it may need locking.
  71
  72   // Attach
  73   assert(0 == child->m_parent);
  74   child->m_parent = this;
  75   m_children.push_back(child);
  76
  77   // Callbacks
  78   childAttachedEvent(child);
  79
  80   // Bring child up to date
  81   child->clearLayers();
  82   child->setDisplayResolution(m_displayResolution);
  83   LayerList::iterator it;
  84   unsigned int counter = 0;
  85   for (it = m_layers.begin(); it != m_layers.end(); ++it)
  86   {
  87     child->setLayer(counter, *it, true);
  88     ++counter;
  89   }
  90 }
  91
  92 /// Detach a child from this object.
  93 void KwAbstractDisplay::detachChild(KwAbstractDisplay* child)
  94 {
  95   DisplayList::iterator it;
  96   it = m_children.begin();
  97   while (it != m_children.end() && (*it) != child)
  98   {
  99     ++it;
 100   }
 101   assert(it != m_children.end());
 102   m_children.erase(it);
 103
 104   childDetachedEvent(child);
 105   assert((*it)->m_parent == this &&"Child not correctly parented");
 106   child->m_parent = 0;
 107   child->disconnectedEvent();
 108 }
 109
 110 /*
 111  * Main interface
 112  *
 113  * These pretty much just call the equivalent event and pass the command on to
 114  * the display's children.
 115  */
 116
 117 /// Set the display resolution.
 118 void KwAbstractDisplay::setDisplayResolution(QSize size)
 119 {
 120   // Callbacks
 121   setDisplayResolutionEvent(size);
 122
 123   // Keep a record
 124   m_displayResolution = size;
 125
 126   // Callbacks
 127   DisplayList::iterator it;
 128   for (it = m_children.begin(); it != m_children.end(); ++it)
 129   {
 130     (*it)->setDisplayResolution(size);
 131   }
 132 }
 133
 134 /// Clear the layers.
 135 void KwAbstractDisplay::clearLayers()
 136 {
 137   // Callbacks
 138   clearLayersEvent();
 139
 140   // Keep a record
 141   m_layers.clear();
 142
 143   // Callbacks
 144   DisplayList::iterator it;
 145   for (it = m_children.begin(); it != m_children.end(); ++it)
 146   {
 147     (*it)->clearLayers();
 148   }
 149 }
 150
 151 /// Set the contents of a layer.
 152 void KwAbstractDisplay::setLayer(unsigned int index, const KwAbstractLayer* layer, bool insert)
 153 {
 154   // Callbacks
 155   setLayerEvent(index, layer, insert);
 156
 157   // Keep a record
 158   m_layers.set(index, layer, insert);
 159
 160   // Callbacks
 161   DisplayList::iterator displayIt;
 162   for (displayIt = m_children.begin(); displayIt != m_children.end(); ++displayIt)
 163   {
 164     (*displayIt)->setLayer(index, layer, insert);
 165   }
 166 }
 167
 168 /// Remove a layer.
 169 void KwAbstractDisplay::KwAbstractDisplay::removeLayer(unsigned int index)
 170 {
 171   // Callbacks
 172   removeLayerEvent(index);
 173
 174   // Keep a record
 175   m_layers.erase(index);
 176
 177   // Callbacks
 178   DisplayList::iterator displayIt;
 179   for (displayIt = m_children.begin(); displayIt != m_children.end(); ++displayIt)
 180   {
 181     (*displayIt)->removeLayer(index);
 182   }
 183 }
 184
 185 /*
 186  * Accessors
 187  */
 188
 189 /// Get the cached display resolution.
 190 QSize KwAbstractDisplay::getDisplayResolution() const
 191 {
 192   return m_displayResolution;
 193 }
 194
 195 /// Get the highest level parent display.
 196 KwAbstractDisplay* KwAbstractDisplay::getHighestParent()
 197 {
 198   if (m_parent)
 199   {
 200     return m_parent->getHighestParent();
 201   }
 202   else
 203   {
 204     return this;
 205   }
 206 }
 207
 208 /*
 209  * Access to layer data.
 210  */
 211
 212 /// Get the number of cached layers.
 213 unsigned int KwAbstractDisplay::getCachedLayerCount() const
 214 {
 215   return m_layers.size();
 216 }
 217
 218 /// Get cached layer.
 219 const KwAbstractLayer* KwAbstractDisplay::getCachedLayer(unsigned int index) const
 220 {
 221   LayerList::const_iterator it = m_layers.getLayerConstIterator(index);
 222   assert(it != m_layers.end());
 223   return *it;
 224 }
 225