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       osg::Vec4 clear_color(0.0f, 0.0f, 0.0f , 1.0f);
 225       parseColor(_node->getStringValue("background"), clear_color);
 226       camera->setClearColor(clear_color);
 227
 228       camera->addChild(_root_group->getMatrixTransform());
 229
 230       if( _texture.serviceable() )
 231       {
 232         setStatusFlags(STATUS_OK);
 233         setStatusFlags(STATUS_DIRTY, false);
 234         _render_dirty = true;
 235       }
 236       else
 237       {
 238         setStatusFlags(CREATE_FAILED);
 239         return;
 240       }
 241     }
 242
 243     if( _visible || _render_always )
 244     {
 245       BOOST_FOREACH(CanvasWeakPtr canvas, _child_canvases)
 246       {
 247         // TODO should we check if the image the child canvas is displayed
 248         //      within is really visible?
 249         if( !canvas.expired() )
 250           canvas.lock()->_visible = true;
 251       }
 252
 253       if( _render_dirty )
 254       {
 255         // Also mark all canvases this canvas is displayed within as dirty
 256         BOOST_FOREACH(CanvasWeakPtr canvas, _parent_canvases)
 257         {
 258           if( !canvas.expired() )
 259             canvas.lock()->_render_dirty = true;
 260         }
 261       }
 262
 263       _texture.setRender(_render_dirty);
 264
 265       _render_dirty = false;
 266       _visible = false;
 267     }
 268     else
 269       _texture.setRender(false);
 270
 271     _root_group->update(delta_time_sec);
 272
 273     if( _sampling_dirty )
 274     {
 275       _texture.setSampling(
 276         _node->getBoolValue("mipmapping"),
 277         _node->getIntValue("coverage-samples"),
 278         _node->getIntValue("color-samples")
 279       );
 280       _sampling_dirty = false;
 281       _render_dirty = true;
 282     }
 283
 284     while( !_dirty_placements.empty() )
 285     {
 286       SGPropertyNode *node = _dirty_placements.back();
 287       _dirty_placements.pop_back();
 288
 289       if( node->getIndex() >= static_cast<int>(_placements.size()) )
 290         // New placement
 291         _placements.resize(node->getIndex() + 1);
 292       else
 293         // Remove possibly existing placements
 294         _placements[ node->getIndex() ].clear();
 295
 296       // Get new placements
 297       PlacementFactoryMap::const_iterator placement_factory =
 298         _placement_factories.find( node->getStringValue("type", "object") );
 299       if( placement_factory != _placement_factories.end() )
 300       {
 301         Placements& placements = _placements[ node->getIndex() ] =
 302           placement_factory->second
 303           (
 304             node,
 305             boost::static_pointer_cast<Canvas>(_self.lock())
 306           );
 307         node->setStringValue
 308         (
 309           "status-msg",
 310           placements.empty() ? "No match" : "Ok"
 311         );
 312       }
 313       else
 314         node->setStringValue("status-msg", "Unknown placement type");
 315     }
 316   }
 317
 318   //----------------------------------------------------------------------------
 319   naRef Canvas::addEventListener(const nasal::CallContext& ctx)
 320   {
 321     if( !_root_group.get() )
 322       naRuntimeError(ctx.c, "Canvas: No root group!");
 323
 324     return _root_group->addEventListener(ctx);
 325   }
 326
 327   //----------------------------------------------------------------------------
 328   void Canvas::setSizeX(int sx)
 329   {
 330     if( _size_x == sx )
 331       return;
 332     _size_x = sx;
 333     setStatusFlags(STATUS_DIRTY);
 334
 335     if( _size_x <= 0 )
 336       setStatusFlags(MISSING_SIZE_X);
 337     else
 338       setStatusFlags(MISSING_SIZE_X, false);
 339
 340     // reset flag to allow creation with new size
 341     setStatusFlags(CREATE_FAILED, false);
 342   }
 343
 344   //----------------------------------------------------------------------------
 345   void Canvas::setSizeY(int sy)
 346   {
 347     if( _size_y == sy )
 348       return;
 349     _size_y = sy;
 350     setStatusFlags(STATUS_DIRTY);
 351
 352     if( _size_y <= 0 )
 353       setStatusFlags(MISSING_SIZE_Y);
 354     else
 355       setStatusFlags(MISSING_SIZE_Y, false);
 356
 357     // reset flag to allow creation with new size
 358     setStatusFlags(CREATE_FAILED, false);
 359   }
 360
 361   //----------------------------------------------------------------------------
 362   int Canvas::getSizeX() const
 363   {
 364     return _size_x;
 365   }
 366
 367   //----------------------------------------------------------------------------
 368   int Canvas::getSizeY() const
 369   {
 370     return _size_y;
 371   }
 372
 373   //----------------------------------------------------------------------------
 374   void Canvas::setViewWidth(int w)
 375   {
 376     if( _view_width == w )
 377       return;
 378     _view_width = w;
 379
 380     _texture.setViewSize(_view_width, _view_height);
 381   }
 382
 383   //----------------------------------------------------------------------------
 384   void Canvas::setViewHeight(int h)
 385   {
 386     if( _view_height == h )
 387       return;
 388     _view_height = h;
 389
 390     _texture.setViewSize(_view_width, _view_height);
 391   }
 392
 393   //----------------------------------------------------------------------------
 394   int Canvas::getViewWidth() const
 395   {
 396     return _texture.getViewSize().x();
 397   }
 398
 399   //----------------------------------------------------------------------------
 400   int Canvas::getViewHeight() const
 401   {
 402     return _texture.getViewSize().y();
 403   }
 404
 405   //----------------------------------------------------------------------------
 406   SGRect<int> Canvas::getViewport() const
 407   {
 408     return SGRect<int>(0, 0, getViewWidth(), getViewHeight());
 409   }
 410
 411   //----------------------------------------------------------------------------
 412   bool Canvas::handleMouseEvent(const MouseEventPtr& event)
 413   {
 414     if( !_root_group.get() )
 415       return false;
 416
 417     EventVisitor visitor( EventVisitor::TRAVERSE_DOWN,
 418                           event->getClientPos(),
 419                           event->getDelta(),
 420                           _root_group );
 421     if( !_root_group->accept(visitor) )
 422       return false;
 423
 424     return _event_manager->handleEvent(event, visitor.getPropagationPath());
 425   }
 426
 427   //----------------------------------------------------------------------------
 428   void Canvas::childAdded( SGPropertyNode * parent,
 429                            SGPropertyNode * child )
 430   {
 431     if( parent != _node )
 432       return;
 433
 434     if( child->getNameString() == "placement" )
 435       _dirty_placements.push_back(child);
 436     else if( _root_group.get() )
 437       static_cast<Element*>(_root_group.get())->childAdded(parent, child);
 438   }
 439
 440   //----------------------------------------------------------------------------
 441   void Canvas::childRemoved( SGPropertyNode * parent,
 442                              SGPropertyNode * child )
 443   {
 444     _render_dirty = true;
 445
 446     if( parent != _node )
 447       return;
 448
 449     if( child->getNameString() == "placement" )
 450       _placements[ child->getIndex() ].clear();
 451     else if( _root_group.get() )
 452       static_cast<Element*>(_root_group.get())->childRemoved(parent, child);
 453   }
 454
 455   //----------------------------------------------------------------------------
 456   void Canvas::valueChanged(SGPropertyNode* node)
 457   {
 458     if(    boost::starts_with(node->getNameString(), "status")
 459         || node->getParent()->getNameString() == "bounding-box" )
 460       return;
 461     _render_dirty = true;
 462
 463     bool handled = true;
 464     if(    node->getParent()->getParent() == _node
 465         && node->getParent()->getNameString() == "placement" )
 466     {
 467       size_t index = node->getIndex();
 468       if( index < _placements.size() )
 469       {
 470         Placements& placements = _placements[index];
 471         if( !placements.empty() )
 472         {
 473           bool placement_dirty = false;
 474           BOOST_FOREACH(PlacementPtr& placement, placements)
 475           {
 476             // check if change can be directly handled by placement
 477             if(    placement->getProps() == node->getParent()
 478                 && !placement->childChanged(node) )
 479               placement_dirty = true;
 480           }
 481
 482           if( !placement_dirty )
 483             return;
 484         }
 485       }
 486
 487       // prevent double updates...
 488       for( size_t i = 0; i < _dirty_placements.size(); ++i )
 489       {
 490         if( node->getParent() == _dirty_placements[i] )
 491           return;
 492       }
 493
 494       _dirty_placements.push_back(node->getParent());
 495     }
 496     else if( node->getParent() == _node )
 497     {
 498       if( node->getNameString() == "background" )
 499       {
 500         osg::Vec4 color;
 501         if( _texture.getCamera() && parseColor(node->getStringValue(), color) )
 502         {
 503           _texture.getCamera()->setClearColor(color);
 504           _render_dirty = true;
 505         }
 506       }
 507       else if(    node->getNameString() == "mipmapping"
 508               || node->getNameString() == "coverage-samples"
 509               || node->getNameString() == "color-samples" )
 510       {
 511         _sampling_dirty = true;
 512       }
 513       else if( node->getNameString() == "additive-blend" )
 514       {
 515         _texture.useAdditiveBlend( node->getBoolValue() );
 516       }
 517       else if( node->getNameString() == "render-always" )
 518       {
 519         _render_always = node->getBoolValue();
 520       }
 521       else if( node->getNameString() == "size" )
 522       {
 523         if( node->getIndex() == 0 )
 524           setSizeX( node->getIntValue() );
 525         else if( node->getIndex() == 1 )
 526           setSizeY( node->getIntValue() );
 527       }
 528       else if( node->getNameString() == "view" )
 529       {
 530         if( node->getIndex() == 0 )
 531           setViewWidth( node->getIntValue() );
 532         else if( node->getIndex() == 1 )
 533           setViewHeight( node->getIntValue() );
 534       }
 535       else if( node->getNameString() == "freeze" )
 536         _texture.setRender( node->getBoolValue() );
 537       else
 538         handled = false;
 539     }
 540     else
 541       handled = false;
 542
 543     if( !handled && _root_group.get() )
 544       _root_group->valueChanged(node);
 545   }
 546
 547   //----------------------------------------------------------------------------
 548   osg::Texture2D* Canvas::getTexture() const
 549   {
 550     return _texture.getTexture();
 551   }
 552
 553   //----------------------------------------------------------------------------
 554   Canvas::CullCallbackPtr Canvas::getCullCallback() const
 555   {
 556     return _cull_callback;
 557   }
 558
 559   //----------------------------------------------------------------------------
 560   void Canvas::reloadPlacements(const std::string& type)
 561   {
 562     for(size_t i = 0; i < _placements.size(); ++i)
 563     {
 564       if( _placements[i].empty() )
 565         continue;
 566
 567       SGPropertyNode* child = _placements[i].front()->getProps();
 568       if(    type.empty()
 569              // reload if type matches or no type specified
 570           || child->getStringValue("type", type.c_str()) == type )
 571       {
 572         _dirty_placements.push_back(child);
 573       }
 574     }
 575   }
 576
 577   //----------------------------------------------------------------------------
 578   void Canvas::addPlacementFactory( const std::string& type,
 579                                     PlacementFactory factory )
 580   {
 581     if( _placement_factories.find(type) != _placement_factories.end() )
 582       SG_LOG
 583       (
 584         SG_GENERAL,
 585         SG_WARN,
 586         "Canvas::addPlacementFactory: replace existing factor for type " << type
 587       );
 588
 589     _placement_factories[type] = factory;
 590   }
 591
 592   //----------------------------------------------------------------------------
 593   void Canvas::setSelf(const PropertyBasedElementPtr& self)
 594   {
 595     PropertyBasedElement::setSelf(self);
 596
 597     CanvasPtr canvas = boost::static_pointer_cast<Canvas>(self);
 598
 599     _root_group.reset( new Group(canvas, _node) );
 600     _root_group->setSelf(_root_group);
 601
 602     // Remove automatically created property listener as we forward them on our
 603     // own
 604     _root_group->removeListener();
 605
 606     _cull_callback = new CullCallback(canvas);
 607   }
 608
 609   //----------------------------------------------------------------------------
 610   void Canvas::setStatusFlags(unsigned int flags, bool set)
 611   {
 612     if( set )
 613       _status |= flags;
 614     else
 615       _status &= ~flags;
 616
 617     if( (_status & MISSING_SIZE_X) && (_status & MISSING_SIZE_Y) )
 618       _status_msg = "Missing size";
 619     else if( _status & MISSING_SIZE_X )
 620       _status_msg = "Missing size-x";
 621     else if( _status & MISSING_SIZE_Y )
 622       _status_msg = "Missing size-y";
 623     else if( _status & CREATE_FAILED )
 624       _status_msg = "Creating render target failed";
 625     else if( _status == STATUS_DIRTY )
 626       _status_msg = "Creation pending...";
 627     else
 628       _status_msg = "Ok";
 629   }
 630
 631   //----------------------------------------------------------------------------
 632   Canvas::PlacementFactoryMap Canvas::_placement_factories;
 633
 634 } // namespace canvas
 635 } // namespace simgear