simgear/canvas/layout/Layout.cxx

   1 // Basic class for canvas layouts
   2 //
   3 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Library General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2 of the License, or (at your option) any later version.
   9 //
  10 // This library 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 GNU
  13 // Library General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Library General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  18
  19 #include "Layout.hxx"
  20 #include <simgear/debug/logstream.hxx>
  21
  22 namespace simgear
  23 {
  24 namespace canvas
  25 {
  26
  27   //----------------------------------------------------------------------------
  28   void Layout::update()
  29   {
  30     if( !(_flags & (LAYOUT_DIRTY | SIZE_INFO_DIRTY)) )
  31       return;
  32
  33     doLayout(_geometry);
  34
  35     _flags &= ~LAYOUT_DIRTY;
  36   }
  37
  38   //----------------------------------------------------------------------------
  39   void Layout::invalidate()
  40   {
  41     LayoutItem::invalidate();
  42     _flags |= LAYOUT_DIRTY;
  43   }
  44
  45   //----------------------------------------------------------------------------
  46   void Layout::setGeometry(const SGRecti& geom)
  47   {
  48     if( geom != _geometry )
  49     {
  50       _geometry = geom;
  51       _flags |= LAYOUT_DIRTY;
  52     }
  53
  54     update();
  55   }
  56
  57   //----------------------------------------------------------------------------
  58   void Layout::removeItem(const LayoutItemRef& item)
  59   {
  60     size_t i = 0;
  61     while( LayoutItemRef child = itemAt(i) )
  62     {
  63       if( item == child )
  64         return (void)takeAt(i);
  65
  66       ++i;
  67     }
  68   }
  69
  70   //----------------------------------------------------------------------------
  71   void Layout::clear()
  72   {
  73     while( itemAt(0) )
  74       takeAt(0);
  75   }
  76
  77   //----------------------------------------------------------------------------
  78   void Layout::ItemData::reset()
  79   {
  80     layout_item = 0;
  81     size_hint   = 0;
  82     min_size    = 0;
  83     max_size    = 0;
  84     padding_orig= 0;
  85     padding     = 0;
  86     size        = 0;
  87     stretch     = 0;
  88     has_hfw     = false;
  89     done        = false;
  90   }
  91
  92   //----------------------------------------------------------------------------
  93   int Layout::ItemData::hfw(int w) const
  94   {
  95     if( has_hfw )
  96       return layout_item->heightForWidth(w);
  97     else
  98       return layout_item->sizeHint().y();
  99   }
 100
 101   //----------------------------------------------------------------------------
 102   int Layout::ItemData::mhfw(int w) const
 103   {
 104     if( has_hfw )
 105       return layout_item->minimumHeightForWidth(w);
 106     else
 107       return layout_item->minimumSize().y();
 108   }
 109
 110   //----------------------------------------------------------------------------
 111   void Layout::safeAdd(int& a, int b)
 112   {
 113     if( SGLimits<int>::max() - b < a )
 114       a = SGLimits<int>::max();
 115     else
 116       a += b;
 117   }
 118
 119   //----------------------------------------------------------------------------
 120   void Layout::distribute(std::vector<ItemData>& items, const ItemData& space)
 121   {
 122     const int num_children = static_cast<int>(items.size());
 123     _num_not_done = num_children;
 124
 125     SG_LOG( SG_GUI,
 126             SG_DEBUG,
 127             "Layout::distribute(" << space.size << "px for "
 128                                   << num_children << " items, s.t."
 129                                   << " min=" << space.min_size
 130                                   << ", hint=" << space.size_hint
 131                                   << ", max=" << space.max_size << ")" );
 132
 133     if( space.size < space.min_size )
 134     {
 135       // TODO
 136       SG_LOG( SG_GUI, SG_WARN, "Layout: not enough size (not implemented)");
 137     }
 138     else if( space.size < space.max_size )
 139     {
 140       _sum_stretch = 0;
 141       _space_stretch = 0;
 142
 143       bool less_then_hint = space.size < space.size_hint;
 144
 145       // Give min_size/size_hint to all items
 146       _space_left = space.size
 147                   - (less_then_hint ? space.min_size : space.size_hint);
 148       for(int i = 0; i < num_children; ++i)
 149       {
 150         ItemData& d = items[i];
 151         d.size = less_then_hint ? d.min_size : d.size_hint;
 152         d.padding = d.padding_orig;
 153         d.done = d.size >= (less_then_hint ? d.size_hint : d.max_size);
 154
 155         SG_LOG(
 156           SG_GUI,
 157           SG_DEBUG,
 158           i << ") initial=" << d.size
 159             << ", min=" << d.min_size
 160             << ", hint=" << d.size_hint
 161             << ", max=" << d.max_size
 162         );
 163
 164         if( d.done )
 165         {
 166           _num_not_done -= 1;
 167           continue;
 168         }
 169
 170         if( d.stretch > 0 )
 171         {
 172           _sum_stretch += d.stretch;
 173           _space_stretch += d.size;
 174         }
 175       }
 176
 177       // Distribute remaining space to increase the size of each item up to its
 178       // size_hint/max_size
 179       while( _space_left > 0 )
 180       {
 181         if( _num_not_done <= 0 )
 182         {
 183           SG_LOG(SG_GUI, SG_WARN, "space left, but no more items?");
 184           break;
 185         }
 186
 187         int space_per_element = std::max(1, _space_left / _num_not_done);
 188
 189         SG_LOG(SG_GUI, SG_DEBUG, "space/element=" << space_per_element);
 190
 191         for(int i = 0; i < num_children; ++i)
 192         {
 193           ItemData& d = items[i];
 194
 195           SG_LOG(
 196             SG_GUI,
 197             SG_DEBUG,
 198             i << ") left=" << _space_left
 199               << ", not_done=" << _num_not_done
 200               << ", sum=" << _sum_stretch
 201               << ", stretch=" << _space_stretch
 202               << ", stretch/unit=" << _space_stretch / std::max(1, _sum_stretch)
 203           );
 204
 205           if( d.done )
 206             continue;
 207
 208           if( _sum_stretch > 0 && d.stretch <= 0 )
 209             d.done = true;
 210           else
 211           {
 212             int target_size = 0;
 213             int max_size = less_then_hint ? d.size_hint : d.max_size;
 214
 215             if( _sum_stretch > 0 )
 216             {
 217               target_size = (d.stretch * (_space_left + _space_stretch))
 218                           / _sum_stretch;
 219
 220               // Item would be smaller than minimum size or larger than maximum
 221               // size, so just keep bounded size and ignore stretch factor
 222               if( target_size <= d.size || target_size >= max_size )
 223               {
 224                 d.done = true;
 225                 _sum_stretch -= d.stretch;
 226                 _space_stretch -= d.size;
 227
 228                 if( target_size >= max_size )
 229                   target_size = max_size;
 230                 else
 231                   target_size = d.size;
 232               }
 233               else
 234                 _space_stretch += target_size - d.size;
 235             }
 236             else
 237             {
 238               // Give space evenly to all remaining elements in this round
 239               target_size = d.size + std::min(_space_left, space_per_element);
 240
 241               if( target_size >= max_size )
 242               {
 243                 d.done = true;
 244                 target_size = max_size;
 245               }
 246             }
 247
 248             int old_size = d.size;
 249             d.size = target_size;
 250             _space_left -= d.size - old_size;
 251           }
 252
 253           if( d.done )
 254           {
 255             _num_not_done -= 1;
 256
 257             if( _sum_stretch <= 0 && d.stretch > 0 )
 258               // Distribute remaining space evenly to all non-stretchable items
 259               // in a new round
 260               break;
 261           }
 262         }
 263       }
 264     }
 265     else
 266     {
 267       _space_left = space.size - space.max_size;
 268       for(int i = 0; i < num_children; ++i)
 269       {
 270         ItemData& d = items[i];
 271         d.size = d.max_size;
 272
 273         // Add superfluous space as padding
 274         d.padding = d.padding_orig + _space_left
 275                                    // Padding after last child...
 276                                    / (_num_not_done + 1);
 277
 278         _space_left -= d.padding - d.padding_orig;
 279         _num_not_done -= 1;
 280       }
 281     }
 282
 283     SG_LOG(SG_GUI, SG_DEBUG, "distribute:");
 284     for(int i = 0; i < num_children; ++i)
 285     {
 286       ItemData const& d = items[i];
 287       SG_LOG( SG_GUI,
 288               SG_DEBUG,
 289               i << ") pad=" << d.padding
 290                 << ", size = " << d.size );
 291     }
 292   }
 293
 294 } // namespace canvas
 295 } // namespace simgear