simgear/canvas/Canvas.cxx

   1 // The canvas for rendering with the 2d API
   2 //
   3 // Copyright (C) 2012  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 "Canvas.hxx"
  20 #include "CanvasEventManager.hxx"
  21 #include "CanvasEventVisitor.hxx"
  22 #include <simgear/canvas/MouseEvent.hxx>
  23 #include <simgear/canvas/CanvasPlacement.hxx>
  24 #include <simgear/scene/util/parse_color.hxx>
  25 #include <simgear/scene/util/RenderConstants.hxx>
  26
  27 #include <osg/Camera>
  28 #include <osg/Geode>
  29 #include <osgText/Text>
  30 #include <osgViewer/Viewer>
  31
  32 #include <boost/algorithm/string/predicate.hpp>
  33 #include <boost/foreach.hpp>
  34
  35 namespace simgear
  36 {
  37 namespace canvas
  38 {
  39
  40   //----------------------------------------------------------------------------
  41   Canvas::CullCallback::CullCallback(const CanvasWeakPtr& canvas):
  42     _canvas( canvas )
  43   {
  44
  45   }
  46
  47   //----------------------------------------------------------------------------
  48   void Canvas::CullCallback::operator()( osg::Node* node,
  49                                          osg::NodeVisitor* nv )
  50   {
  51     if( (nv->getTraversalMask() & simgear::MODEL_BIT) && !_canvas.expired() )
  52       _canvas.lock()->enableRendering();
  53
  54     traverse(node, nv);
  55   }
  56
  57   //----------------------------------------------------------------------------
  58   Canvas::Canvas(SGPropertyNode* node):
  59     PropertyBasedElement(node),
  60     _canvas_mgr(0),
  61     _event_manager(new EventManager),
  62     _size_x(-1),
  63     _size_y(-1),
  64     _view_width(-1),
  65     _view_height(-1),
  66     _status(node, "status"),
  67     _status_msg(node, "status-msg"),
  68     _sampling_dirty(false),
  69     _render_dirty(true),
  70     _visible(true),
  71     _render_always(false)
  72   {
  73     _status = 0;
  74     setStatusFlags(MISSING_SIZE_X | MISSING_SIZE_Y);
  75   }
  76
  77   //----------------------------------------------------------------------------
  78   void Canvas::onDestroy()
  79   {
  80     if( _root_group )
  81     {
  82       _root_group->clearEventListener();
  83       _root_group->onDestroy();
  84     }
  85   }
  86
  87   //----------------------------------------------------------------------------
  88   void Canvas::setSystemAdapter(const SystemAdapterPtr& system_adapter)
  89   {
  90     _system_adapter = system_adapter;
  91     _texture.setSystemAdapter(system_adapter);
  92   }
  93
  94   //----------------------------------------------------------------------------
  95   SystemAdapterPtr Canvas::getSystemAdapter() const
  96   {
  97     return _system_adapter;
  98   }
  99
 100   //----------------------------------------------------------------------------
 101   void Canvas::setCanvasMgr(CanvasMgr* canvas_mgr)
 102   {
 103     _canvas_mgr = canvas_mgr;
 104   }
 105
 106   //----------------------------------------------------------------------------
 107   CanvasMgr* Canvas::getCanvasMgr() const
 108   {
 109     return _canvas_mgr;
 110   }
 111
 112   //----------------------------------------------------------------------------
 113   bool Canvas::isInit() const
 114   {
 115     return _texture.serviceable();
 116   }
 117
 118   //----------------------------------------------------------------------------
 119   void Canvas::addParentCanvas(const CanvasWeakPtr& canvas)
 120   {
 121     if( canvas.expired() )
 122     {
 123       SG_LOG
 124       (
 125         SG_GENERAL,
 126         SG_WARN,
 127         "Canvas::addParentCanvas(" << _node->getPath(true) << "): "
 128         "got an expired parent!"
 129       );
 130       return;
 131     }
 132
 133     _parent_canvases.insert(canvas);
 134   }
 135
 136   //----------------------------------------------------------------------------
 137   void Canvas::addChildCanvas(const CanvasWeakPtr& canvas)
 138   {
 139     if( canvas.expired() )
 140     {
 141       SG_LOG
 142       (
 143         SG_GENERAL,
 144         SG_WARN,
 145         "Canvas::addChildCanvas(" << _node->getPath(true) << "): "
 146         " got an expired child!"
 147       );
 148       return;
 149     }
 150
 151     _child_canvases.insert(canvas);
 152   }
 153
 154   //----------------------------------------------------------------------------
 155   void Canvas::removeParentCanvas(const CanvasWeakPtr& canvas)
 156   {
 157     _parent_canvases.erase(canvas);
 158   }
 159
 160   //----------------------------------------------------------------------------
 161   void Canvas::removeChildCanvas(const CanvasWeakPtr& canvas)
 162   {
 163     _child_canvases.erase(canvas);
 164   }
 165
 166   //----------------------------------------------------------------------------
 167   GroupPtr Canvas::createGroup(const std::string& name)
 168   {
 169     return _root_group->createChild<Group>(name);
 170   }
 171
 172   //----------------------------------------------------------------------------
 173   GroupPtr Canvas::getGroup(const std::string& name)
 174   {
 175     return _root_group->getChild<Group>(name);
 176   }
 177
 178   //----------------------------------------------------------------------------
 179   GroupPtr Canvas::getOrCreateGroup(const std::string& name)
 180   {
 181     return _root_group->getOrCreateChild<Group>(name);
 182   }
 183
 184   //----------------------------------------------------------------------------
 185   GroupPtr Canvas::getRootGroup()
 186   {
 187     return _root_group;
 188   }
 189
 190   //----------------------------------------------------------------------------
 191   void Canvas::enableRendering(bool force)
 192   {
 193     _visible = true;
 194     if( force )
 195       _render_dirty = true;
 196   }
 197
 198   //----------------------------------------------------------------------------
 199   void Canvas::update(double delta_time_sec)
 200   {
 201     if(    (!_texture.serviceable() && _status != STATUS_DIRTY)
 202         || (_status & CREATE_FAILED) )
 203       return;
 204
 205     if( _status == STATUS_DIRTY )
 206     {
 207       _texture.setSize(_size_x, _size_y);
 208
 209       if( !_texture.serviceable() )
 210       {
 211         _texture.useImageCoords(true);
 212         _texture.useStencil(true);
 213         _texture.allocRT(/*_camera_callback*/);
 214       }
 215       else
 216       {
 217         // Resizing causes a new texture to be created so we need to reapply all
 218         // existing placements
 219         reloadPlacements();
 220       }
 221
 222       osg::Camera* camera = _texture.getCamera();
 223
 224       // TODO Allow custom render order? For now just keep in order with
 225       //      property tree.
 226       camera->setRenderOrder(osg::Camera::PRE_RENDER, _node->getIndex());
 227
 228       osg::Vec4 clear_color(0.0f, 0.0f, 0.0f , 1.0f);
 229       parseColor(_node->getStringValue("background"), clear_color);
 230       camera->setClearColor(clear_color);
 231
 232       camera->addChild(_root_group->getMatrixTransform());
 233
 234       if( _texture.serviceable() )
 235       {
 236         setStatusFlags(STATUS_OK);
 237         setStatusFlags(STATUS_DIRTY, false);
 238         _render_dirty = true;
 239       }
 240       else
 241       {
 242         setStatusFlags(CREATE_FAILED);
 243         return;
 244       }
 245     }
 246
 247     if( _visible || _render_always )
 248     {
 249       BOOST_FOREACH(CanvasWeakPtr canvas, _child_canvases)
 250       {
 251         // TODO should we check if the image the child canvas is displayed
 252         //      within is really visible?
 253         if( !canvas.expired() )
 254           canvas.lock()->_visible = true;
 255       }
 256
 257       if( _render_dirty )
 258       {
 259         // Also mark all canvases this canvas is displayed within as dirty
 260         BOOST_FOREACH(CanvasWeakPtr canvas, _parent_canvases)
 261         {
 262           if( !canvas.expired() )
 263             canvas.lock()->_render_dirty = true;
 264         }
 265       }
 266
 267       _texture.setRender(_render_dirty);
 268
 269       _render_dirty = false;
 270       _visible = false;
 271     }
 272     else
 273       _texture.setRender(false);
 274
 275     _root_group->update(delta_time_sec);
 276
 277     if( _sampling_dirty )
 278     {
 279       _texture.setSampling(
 280         _node->getBoolValue("mipmapping"),
 281         _node->getIntValue("coverage-samples"),
 282         _node->getIntValue("color-samples")
 283       );
 284       _sampling_dirty = false;
 285       _render_dirty = true;
 286     }
 287
 288     while( !_dirty_placements.empty() )
 289     {
 290       SGPropertyNode *node = _dirty_placements.back();
 291       _dirty_placements.pop_back();
 292
 293       if( node->getIndex() >= static_cast<int>(_placements.size()) )
 294         // New placement
 295         _placements.resize(node->getIndex() + 1);
 296       else
 297         // Remove possibly existing placements
 298         _placements[ node->getIndex() ].clear();
 299
 300       // Get new placements
 301       PlacementFactoryMap::const_iterator placement_factory =
 302         _placement_factories.find( node->getStringValue("type", "object") );
 303       if( placement_factory != _placement_factories.end() )
 304       {
 305         Placements& placements = _placements[ node->getIndex() ] =
 306           placement_factory->second
 307           (
 308             node,
 309             boost::static_pointer_cast<Canvas>(_self.lock())
 310           );
 311         node->setStringValue
 312         (
 313           "status-msg",
 314           placements.empty() ? "No match" : "Ok"
 315         );
 316       }
 317       else
 318         node->setStringValue("status-msg", "Unknown placement type");
 319     }
 320   }
 321
 322   //----------------------------------------------------------------------------
 323   bool Canvas::addEventListener( const std::string& type,
 324                                  const EventListener& cb )
 325   {
 326     if( !_root_group.get() )
 327       throw std::runtime_error("Canvas::AddEventListener: no root group!");
 328
 329     return _root_group->addEventListener(type, cb);
 330   }
 331
 332   //----------------------------------------------------------------------------
 333   void Canvas::setSizeX(int sx)
 334   {
 335     if( _size_x == sx )
 336       return;
 337     _size_x = sx;
 338     setStatusFlags(STATUS_DIRTY);
 339
 340     if( _size_x <= 0 )
 341       setStatusFlags(MISSING_SIZE_X);
 342     else
 343       setStatusFlags(MISSING_SIZE_X, false);
 344
 345     // reset flag to allow creation with new size
 346     setStatusFlags(CREATE_FAILED, false);
 347   }
 348
 349   //----------------------------------------------------------------------------
 350   void Canvas::setSizeY(int sy)
 351   {
 352     if( _size_y == sy )
 353       return;
 354     _size_y = sy;
 355     setStatusFlags(STATUS_DIRTY);
 356
 357     if( _size_y <= 0 )
 358       setStatusFlags(MISSING_SIZE_Y);
 359     else
 360       setStatusFlags(MISSING_SIZE_Y, false);
 361
 362     // reset flag to allow creation with new size
 363     setStatusFlags(CREATE_FAILED, false);
 364   }
 365
 366   //----------------------------------------------------------------------------
 367   int Canvas::getSizeX() const
 368   {
 369     return _size_x;
 370   }
 371
 372   //----------------------------------------------------------------------------
 373   int Canvas::getSizeY() const
 374   {
 375     return _size_y;
 376   }
 377
 378   //----------------------------------------------------------------------------
 379   void Canvas::setViewWidth(int w)
 380   {
 381     if( _view_width == w )
 382       return;
 383     _view_width = w;
 384
 385     _texture.setViewSize(_view_width, _view_height);
 386   }
 387
 388   //----------------------------------------------------------------------------
 389   void Canvas::setViewHeight(int h)
 390   {
 391     if( _view_height == h )
 392       return;
 393     _view_height = h;
 394
 395     _texture.setViewSize(_view_width, _view_height);
 396   }
 397
 398   //----------------------------------------------------------------------------
 399   int Canvas::getViewWidth() const
 400   {
 401     return _texture.getViewSize().x();
 402   }
 403
 404   //----------------------------------------------------------------------------
 405   int Canvas::getViewHeight() const
 406   {
 407     return _texture.getViewSize().y();
 408   }
 409
 410   //----------------------------------------------------------------------------
 411   SGRect<int> Canvas::getViewport() const
 412   {
 413     return SGRect<int>(0, 0, getViewWidth(), getViewHeight());
 414   }
 415
 416   //----------------------------------------------------------------------------
 417   bool Canvas::handleMouseEvent(const MouseEventPtr& event)
 418   {
 419     if( !_root_group.get() )
 420       return false;
 421
 422     EventVisitor visitor( EventVisitor::TRAVERSE_DOWN,
 423                           event->getClientPos(),
 424                           event->getDelta(),
 425                           _root_group );
 426     if( !_root_group->accept(visitor) )
 427       return false;
 428
 429     return _event_manager->handleEvent(event, visitor.getPropagationPath());
 430   }
 431
 432   //----------------------------------------------------------------------------
 433   void Canvas::childAdded( SGPropertyNode * parent,
 434                            SGPropertyNode * child )
 435   {
 436     if( parent != _node )
 437       return;
 438
 439     if( child->getNameString() == "placement" )
 440       _dirty_placements.push_back(child);
 441     else if( _root_group.get() )
 442       static_cast<Element*>(_root_group.get())->childAdded(parent, child);
 443   }
 444
 445   //----------------------------------------------------------------------------
 446   void Canvas::childRemoved( SGPropertyNode * parent,
 447                              SGPropertyNode * child )
 448   {
 449     _render_dirty = true;
 450
 451     if( parent != _node )
 452       return;
 453
 454     if( child->getNameString() == "placement" )
 455       _placements[ child->getIndex() ].clear();
 456     else if( _root_group.get() )
 457       static_cast<Element*>(_root_group.get())->childRemoved(parent, child);
 458   }
 459
 460   //----------------------------------------------------------------------------
 461   void Canvas::valueChanged(SGPropertyNode* node)
 462   {
 463     if(    boost::starts_with(node->getNameString(), "status")
 464         || node->getParent()->getNameString() == "bounding-box" )
 465       return;
 466     _render_dirty = true;
 467
 468     bool handled = true;
 469     if(    node->getParent()->getParent() == _node
 470         && node->getParent()->getNameString() == "placement" )
 471     {
 472       size_t index = node->getIndex();
 473       if( index < _placements.size() )
 474       {
 475         Placements& placements = _placements[index];
 476         if( !placements.empty() )
 477         {
 478           bool placement_dirty = false;
 479           BOOST_FOREACH(PlacementPtr& placement, placements)
 480           {
 481             // check if change can be directly handled by placement
 482             if(    placement->getProps() == node->getParent()
 483                 && !placement->childChanged(node) )
 484               placement_dirty = true;
 485           }
 486
 487           if( !placement_dirty )
 488             return;
 489         }
 490       }
 491
 492       // prevent double updates...
 493       for( size_t i = 0; i < _dirty_placements.size(); ++i )
 494       {
 495         if( node->getParent() == _dirty_placements[i] )
 496           return;
 497       }
 498
 499       _dirty_placements.push_back(node->getParent());
 500     }
 501     else if( node->getParent() == _node )
 502     {
 503       if( node->getNameString() == "background" )
 504       {
 505         osg::Vec4 color;
 506         if( _texture.getCamera() && parseColor(node->getStringValue(), color) )
 507         {
 508           _texture.getCamera()->setClearColor(color);
 509           _render_dirty = true;
 510         }
 511       }
 512       else if(    node->getNameString() == "mipmapping"
 513               || node->getNameString() == "coverage-samples"
 514               || node->getNameString() == "color-samples" )
 515       {
 516         _sampling_dirty = true;
 517       }
 518       else if( node->getNameString() == "additive-blend" )
 519       {
 520         _texture.useAdditiveBlend( node->getBoolValue() );
 521       }
 522       else if( node->getNameString() == "render-always" )
 523       {
 524         _render_always = node->getBoolValue();
 525       }
 526       else if( node->getNameString() == "size" )
 527       {
 528         if( node->getIndex() == 0 )
 529           setSizeX( node->getIntValue() );
 530         else if( node->getIndex() == 1 )
 531           setSizeY( node->getIntValue() );
 532       }
 533       else if( node->getNameString() == "view" )
 534       {
 535         if( node->getIndex() == 0 )
 536           setViewWidth( node->getIntValue() );
 537         else if( node->getIndex() == 1 )
 538           setViewHeight( node->getIntValue() );
 539       }
 540       else if( node->getNameString() == "freeze" )
 541         _texture.setRender( node->getBoolValue() );
 542       else
 543         handled = false;
 544     }
 545     else
 546       handled = false;
 547
 548     if( !handled && _root_group.get() )
 549       _root_group->valueChanged(node);
 550   }
 551
 552   //----------------------------------------------------------------------------
 553   osg::Texture2D* Canvas::getTexture() const
 554   {
 555     return _texture.getTexture();
 556   }
 557
 558   //----------------------------------------------------------------------------
 559   Canvas::CullCallbackPtr Canvas::getCullCallback() const
 560   {
 561     return _cull_callback;
 562   }
 563
 564   //----------------------------------------------------------------------------
 565   void Canvas::reloadPlacements(const std::string& type)
 566   {
 567     for(size_t i = 0; i < _placements.size(); ++i)
 568     {
 569       if( _placements[i].empty() )
 570         continue;
 571
 572       SGPropertyNode* child = _placements[i].front()->getProps();
 573       if(    type.empty()
 574              // reload if type matches or no type specified
 575           || child->getStringValue("type", type.c_str()) == type )
 576       {
 577         _dirty_placements.push_back(child);
 578       }
 579     }
 580   }
 581
 582   //----------------------------------------------------------------------------
 583   void Canvas::addPlacementFactory( const std::string& type,
 584                                     PlacementFactory factory )
 585   {
 586     if( _placement_factories.find(type) != _placement_factories.end() )
 587       SG_LOG
 588       (
 589         SG_GENERAL,
 590         SG_WARN,
 591         "Canvas::addPlacementFactory: replace existing factory '" << type << "'"
 592       );
 593
 594     _placement_factories[type] = factory;
 595   }
 596
 597   //----------------------------------------------------------------------------
 598   void Canvas::removePlacementFactory(const std::string& type)
 599   {
 600     PlacementFactoryMap::iterator it = _placement_factories.find(type);
 601     if( it == _placement_factories.end() )
 602       SG_LOG
 603       (
 604         SG_GENERAL,
 605         SG_WARN,
 606         "Canvas::removePlacementFactory: no such factory '" << type << "'"
 607       );
 608     else
 609       _placement_factories.erase(it);
 610   }
 611
 612   //----------------------------------------------------------------------------
 613   void Canvas::setSelf(const PropertyBasedElementPtr& self)
 614   {
 615     PropertyBasedElement::setSelf(self);
 616
 617     CanvasPtr canvas = boost::static_pointer_cast<Canvas>(self);
 618
 619     _root_group.reset( new Group(canvas, _node) );
 620     _root_group->setSelf(_root_group);
 621
 622     // Remove automatically created property listener as we forward them on our
 623     // own
 624     _root_group->removeListener();
 625
 626     _cull_callback = new CullCallback(canvas);
 627   }
 628
 629   //----------------------------------------------------------------------------
 630   void Canvas::setStatusFlags(unsigned int flags, bool set)
 631   {
 632     if( set )
 633       _status |= flags;
 634     else
 635       _status &= ~flags;
 636
 637     if( (_status & MISSING_SIZE_X) && (_status & MISSING_SIZE_Y) )
 638       _status_msg = "Missing size";
 639     else if( _status & MISSING_SIZE_X )
 640       _status_msg = "Missing size-x";
 641     else if( _status & MISSING_SIZE_Y )
 642       _status_msg = "Missing size-y";
 643     else if( _status & CREATE_FAILED )
 644       _status_msg = "Creating render target failed";
 645     else if( _status == STATUS_DIRTY )
 646       _status_msg = "Creation pending...";
 647     else
 648       _status_msg = "Ok";
 649   }
 650
 651   //----------------------------------------------------------------------------
 652   Canvas::PlacementFactoryMap Canvas::_placement_factories;
 653
 654 } // namespace canvas
 655 } // namespace simgear