src/Canvas/window.cxx

   1 // Window for placing a Canvas onto it (for dialogs, menus, etc.)
   2 //
   3 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18
  19 #include "canvas_mgr.hxx"
  20 #include "window.hxx"
  21 #include <Main/globals.hxx>
  22 #include <simgear/canvas/Canvas.hxx>
  23 #include <simgear/scene/util/OsgMath.hxx>
  24
  25 #include <osgGA/GUIEventHandler>
  26
  27 #include <boost/algorithm/string/predicate.hpp>
  28 #include <boost/foreach.hpp>
  29
  30 namespace canvas
  31 {
  32   namespace sc = simgear::canvas;
  33
  34   //----------------------------------------------------------------------------
  35   const std::string Window::TYPE_NAME = "window";
  36
  37   //----------------------------------------------------------------------------
  38   Window::Window( const simgear::canvas::CanvasWeakPtr& canvas,
  39                   const SGPropertyNode_ptr& node,
  40                   const Style& parent_style,
  41                   Element* parent ):
  42     Image(canvas, node, parent_style, parent),
  43     _attributes_dirty(0),
  44     _resizable(false),
  45     _capture_events(true),
  46     _resize_top(node, "resize-top"),
  47     _resize_right(node, "resize-right"),
  48     _resize_bottom(node, "resize-bottom"),
  49     _resize_left(node, "resize-left"),
  50     _resize_status(node, "resize-status")
  51   {
  52     node->setFloatValue("source/right", 1);
  53     node->setFloatValue("source/bottom", 1);
  54     node->setBoolValue("source/normalized", true);
  55   }
  56
  57   //----------------------------------------------------------------------------
  58   Window::~Window()
  59   {
  60     if( _canvas_decoration )
  61       _canvas_decoration->destroy();
  62   }
  63
  64   //----------------------------------------------------------------------------
  65   void Window::update(double delta_time_sec)
  66   {
  67     if( _attributes_dirty & DECORATION )
  68     {
  69       updateDecoration();
  70       _attributes_dirty &= ~DECORATION;
  71     }
  72
  73     Image::update(delta_time_sec);
  74   }
  75
  76   //----------------------------------------------------------------------------
  77   void Window::valueChanged(SGPropertyNode * node)
  78   {
  79     bool handled = false;
  80     if( node->getParent() == _node )
  81     {
  82       handled = true;
  83       const std::string& name = node->getNameString();
  84       if( name  == "resize" )
  85         _resizable = node->getBoolValue();
  86       else if( name == "update" )
  87         update(0);
  88       else if( name == "capture-events" )
  89         _capture_events = node->getBoolValue();
  90       else if( name == "decoration-border" )
  91         parseDecorationBorder(node->getStringValue());
  92       else if( boost::starts_with(name, "shadow-") )
  93         _attributes_dirty |= DECORATION;
  94       else
  95         handled = false;
  96     }
  97
  98     if( !handled )
  99       Image::valueChanged(node);
 100   }
 101
 102   //----------------------------------------------------------------------------
 103   osg::Group* Window::getGroup()
 104   {
 105     return getMatrixTransform();
 106   }
 107
 108   //----------------------------------------------------------------------------
 109   const SGVec2<float> Window::getPosition() const
 110   {
 111     const osg::Matrix& m = getMatrixTransform()->getMatrix();
 112     return SGVec2<float>( m(3, 0), m(3, 1) );
 113   }
 114
 115   //----------------------------------------------------------------------------
 116   const SGRect<float> Window::getScreenRegion() const
 117   {
 118     return getPosition() + getRegion();
 119   }
 120
 121   //----------------------------------------------------------------------------
 122   void Window::setCanvasContent(sc::CanvasPtr canvas)
 123   {
 124     _canvas_content = canvas;
 125
 126     if( _image_content )
 127       // Placement within decoration canvas
 128       _image_content->setSrcCanvas(canvas);
 129     else
 130       setSrcCanvas(canvas);
 131   }
 132
 133   //----------------------------------------------------------------------------
 134   sc::CanvasWeakPtr Window::getCanvasContent() const
 135   {
 136     return _canvas_content;
 137   }
 138
 139   //----------------------------------------------------------------------------
 140   sc::CanvasPtr Window::getCanvasDecoration()
 141   {
 142     return _canvas_decoration;
 143   }
 144
 145   //----------------------------------------------------------------------------
 146   bool Window::isResizable() const
 147   {
 148     return _resizable;
 149   }
 150
 151   //----------------------------------------------------------------------------
 152   bool Window::isCapturingEvents() const
 153   {
 154     return _capture_events;
 155   }
 156
 157   //----------------------------------------------------------------------------
 158   void Window::raise()
 159   {
 160     // on writing the z-index the window always is moved to the top of all other
 161     // windows with the same z-index.
 162     set<int>("z-index", get<int>("z-index", 0));
 163   }
 164
 165   //----------------------------------------------------------------------------
 166   void Window::handleResize( uint8_t mode,
 167                              const osg::Vec2f& offset )
 168   {
 169     if( mode == NONE )
 170     {
 171       _resize_status = 0;
 172       return;
 173     }
 174     else if( mode & INIT )
 175     {
 176       _resize_top    = getRegion().t();
 177       _resize_right  = getRegion().r();
 178       _resize_bottom = getRegion().b();
 179       _resize_left   = getRegion().l();
 180       _resize_status = 1;
 181     }
 182
 183     if( mode & BOTTOM )
 184       _resize_bottom = getRegion().b() + offset.y();
 185     else if( mode & TOP )
 186       _resize_top = getRegion().t() + offset.y();
 187
 188     if( mode & canvas::Window::RIGHT )
 189       _resize_right = getRegion().r() + offset.x();
 190     else if( mode & canvas::Window::LEFT )
 191       _resize_left = getRegion().l() + offset.x();
 192   }
 193
 194   //----------------------------------------------------------------------------
 195   void Window::parseDecorationBorder(const std::string& str)
 196   {
 197     _decoration_border = simgear::CSSBorder::parse(str);
 198     _attributes_dirty |= DECORATION;
 199   }
 200
 201   //----------------------------------------------------------------------------
 202   void Window::updateDecoration()
 203   {
 204     int shadow_radius = get<float>("shadow-radius") + 0.5;
 205     if( shadow_radius < 2 )
 206       shadow_radius = 0;
 207
 208     if( _decoration_border.isNone() && !shadow_radius )
 209     {
 210       sc::CanvasPtr canvas_content = _canvas_content.lock();
 211       setSrcCanvas(canvas_content);
 212       set<int>("size[0]", canvas_content->getViewWidth());
 213       set<int>("size[1]", canvas_content->getViewHeight());
 214
 215       _image_content.reset();
 216       _image_shadow.reset();
 217       _canvas_decoration->destroy();
 218       _canvas_decoration.reset();
 219       return;
 220     }
 221
 222     sc::CanvasPtr content = _canvas_content.lock();
 223     if( !_canvas_decoration )
 224     {
 225       CanvasMgr* mgr =
 226         dynamic_cast<CanvasMgr*>(globals->get_subsystem("Canvas"));
 227
 228       if( !mgr )
 229       {
 230         SG_LOG(SG_GENERAL, SG_WARN, "canvas::Window: no canvas manager!");
 231         return;
 232       }
 233
 234       _canvas_decoration = mgr->createCanvas("window-decoration");
 235       _canvas_decoration->getProps()
 236                         ->setStringValue("background", "rgba(0,0,0,0)");
 237       setSrcCanvas(_canvas_decoration);
 238
 239       _image_content = _canvas_decoration->getRootGroup()
 240                                          ->createChild<sc::Image>("content");
 241       _image_content->setSrcCanvas(content);
 242
 243       // Draw content on top of decoration
 244       _image_content->set<int>("z-index", 1);
 245     }
 246
 247     sc::GroupPtr group_decoration =
 248       _canvas_decoration->getOrCreateGroup("decoration");
 249     group_decoration->set<int>("tf/t[0]", shadow_radius);
 250     group_decoration->set<int>("tf/t[1]", shadow_radius);
 251     // TODO do we need clipping or shall we trust the decorator not to draw over
 252     //      the shadow?
 253
 254     simgear::CSSBorder::Offsets const border =
 255       _decoration_border.getAbsOffsets(content->getViewport());
 256
 257     int shad2 = 2 * shadow_radius,
 258         outer_width  = border.l + content->getViewWidth()  + border.r + shad2,
 259         outer_height = border.t + content->getViewHeight() + border.b + shad2;
 260
 261     _canvas_decoration->setSizeX( outer_width );
 262     _canvas_decoration->setSizeY( outer_height );
 263     _canvas_decoration->setViewWidth( outer_width );
 264     _canvas_decoration->setViewHeight( outer_height );
 265
 266     set<int>("size[0]", outer_width - shad2);
 267     set<int>("size[1]", outer_height - shad2);
 268     set<int>("outset", shadow_radius);
 269
 270     assert(_image_content);
 271     _image_content->set<int>("x", shadow_radius + border.l);
 272     _image_content->set<int>("y", shadow_radius + border.t);
 273
 274     if( !shadow_radius )
 275     {
 276       if( _image_shadow )
 277       {
 278         _image_shadow->destroy();
 279         _image_shadow.reset();
 280       }
 281       return;
 282     }
 283
 284     int shadow_inset = std::max<int>(get<float>("shadow-inset") + 0.5, 0),
 285         slice_width  = shadow_radius + shadow_inset;
 286
 287     _image_shadow = _canvas_decoration->getRootGroup()
 288                                       ->getOrCreateChild<sc::Image>("shadow");
 289     _image_shadow->set<std::string>("file", "gui/images/shadow.png");
 290     _image_shadow->set<float>("slice", 7);
 291     _image_shadow->set<std::string>("fill", "#000000");
 292     _image_shadow->set<float>("slice-width", slice_width);
 293     _image_shadow->set<int>("size[0]", outer_width);
 294     _image_shadow->set<int>("size[1]", outer_height);
 295
 296     // Draw shadow below decoration
 297     _image_shadow->set<int>("z-index", -1);
 298   }
 299
 300 } // namespace canvas