simgear/canvas/elements/CanvasElement.cxx

   1 // Interface for 2D Canvas element
   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 "CanvasElement.hxx"
  20 #include <simgear/canvas/CanvasEventVisitor.hxx>
  21 #include <simgear/canvas/MouseEvent.hxx>
  22 #include <simgear/math/SGMisc.hxx>
  23 #include <simgear/misc/strutils.hxx>
  24 #include <simgear/scene/material/parseBlendFunc.hxx>
  25
  26 #include <osg/Drawable>
  27 #include <osg/Geode>
  28 #include <osg/Scissor>
  29
  30 #include <boost/algorithm/string/predicate.hpp>
  31 #include <boost/foreach.hpp>
  32 #include <boost/make_shared.hpp>
  33
  34 #include <cassert>
  35 #include <cmath>
  36 #include <cstring>
  37
  38 namespace simgear
  39 {
  40 namespace canvas
  41 {
  42   const std::string NAME_TRANSFORM = "tf";
  43
  44   /**
  45    * glScissor with coordinates relative to different reference frames.
  46    */
  47   class Element::RelativeScissor:
  48     public osg::Scissor
  49   {
  50     public:
  51
  52       ReferenceFrame    _coord_reference;
  53       osg::Matrix       _parent_inverse;
  54
  55       RelativeScissor():
  56         _coord_reference(GLOBAL)
  57       {}
  58
  59       virtual void apply(osg::State& state) const
  60       {
  61         const osg::Viewport* vp = state.getCurrentViewport();
  62         float w2 = 0.5 * vp->width(),
  63               h2 = 0.5 * vp->height();
  64
  65         osg::Matrix model_view
  66         (
  67           w2, 0,  0, 0,
  68           0,  h2, 0, 0,
  69           0,  0,  1, 0,
  70           w2, h2, 0, 1
  71         );
  72         model_view.preMult(state.getProjectionMatrix());
  73
  74         if( _coord_reference != GLOBAL )
  75         {
  76           model_view.preMult(state.getModelViewMatrix());
  77
  78           if( _coord_reference == PARENT )
  79             model_view.preMult(_parent_inverse);
  80         }
  81
  82         const osg::Vec2 scale( model_view(0,0), model_view(1,1)),
  83                         offset(model_view(3,0), model_view(3,1));
  84
  85         // TODO check/warn for rotation?
  86
  87         GLint x = SGMiscf::roundToInt(scale.x() * _x + offset.x()),
  88               y = SGMiscf::roundToInt(scale.y() * _y + offset.y()),
  89               w = SGMiscf::roundToInt(std::fabs(scale.x()) * _width),
  90               h = SGMiscf::roundToInt(std::fabs(scale.y()) * _height);
  91
  92         if( scale.x() < 0 )
  93           x -= w;
  94         if( scale.y() < 0 )
  95           y -= h;
  96
  97         glScissor(x, y, w, h);
  98       }
  99   };
 100
 101   //----------------------------------------------------------------------------
 102   Element::OSGUserData::OSGUserData(ElementPtr element):
 103     element(element)
 104   {
 105
 106   }
 107
 108   //----------------------------------------------------------------------------
 109   Element::~Element()
 110   {
 111     if( !_transform.valid() )
 112       return;
 113
 114     for(unsigned int i = 0; i < _transform->getNumChildren(); ++i)
 115     {
 116       OSGUserData* ud =
 117         static_cast<OSGUserData*>(_transform->getChild(i)->getUserData());
 118
 119       if( ud )
 120         // Ensure parent is cleared to prevent accessing released memory if an
 121         // element somehow survives longer than his parent.
 122         ud->element->_parent = 0;
 123     }
 124   }
 125
 126   //----------------------------------------------------------------------------
 127   void Element::setSelf(const PropertyBasedElementPtr& self)
 128   {
 129     PropertyBasedElement::setSelf(self);
 130
 131     _transform->setUserData
 132     (
 133       new OSGUserData(boost::static_pointer_cast<Element>(self))
 134     );
 135   }
 136
 137   //----------------------------------------------------------------------------
 138   void Element::onDestroy()
 139   {
 140     if( !_transform.valid() )
 141       return;
 142
 143     // The transform node keeps a reference on this element, so ensure it is
 144     // deleted.
 145     BOOST_FOREACH(osg::Group* parent, _transform->getParents())
 146     {
 147       parent->removeChild(_transform.get());
 148     }
 149   }
 150
 151   //----------------------------------------------------------------------------
 152   ElementWeakPtr Element::getWeakPtr() const
 153   {
 154     return boost::static_pointer_cast<Element>(_self.lock());
 155   }
 156
 157   //----------------------------------------------------------------------------
 158   ElementPtr Element::getParent()
 159   {
 160     return _parent ? _parent->getWeakPtr().lock() : ElementPtr();
 161   }
 162
 163   //----------------------------------------------------------------------------
 164   void Element::update(double dt)
 165   {
 166     if( !isVisible() )
 167       return;
 168
 169     // Trigger matrix update
 170     getMatrix();
 171
 172     if( _attributes_dirty & SCISSOR_COORDS )
 173     {
 174       if( _scissor && _scissor->_coord_reference != GLOBAL )
 175         _scissor->_parent_inverse = _transform->getInverseMatrix();
 176
 177       _attributes_dirty &= ~SCISSOR_COORDS;
 178     }
 179
 180     // Update bounding box on manual update (manual updates pass zero dt)
 181     if( dt == 0 && _drawable )
 182       _drawable->getBound();
 183
 184     if( _attributes_dirty & BLEND_FUNC )
 185     {
 186       parseBlendFunc(
 187         _transform->getOrCreateStateSet(),
 188         _node->getChild("blend-source"),
 189         _node->getChild("blend-destination"),
 190         _node->getChild("blend-source-rgb"),
 191         _node->getChild("blend-destination-rgb"),
 192         _node->getChild("blend-source-alpha"),
 193         _node->getChild("blend-destination-alpha")
 194       );
 195       _attributes_dirty &= ~BLEND_FUNC;
 196     }
 197   }
 198
 199   //----------------------------------------------------------------------------
 200   bool Element::addEventListener( const std::string& type_str,
 201                                   const EventListener& cb )
 202   {
 203     SG_LOG
 204     (
 205       SG_GENERAL,
 206       SG_INFO,
 207       "addEventListener(" << _node->getPath() << ", " << type_str << ")"
 208     );
 209
 210     Event::Type type = Event::strToType(type_str);
 211     if( type == Event::UNKNOWN )
 212     {
 213       SG_LOG( SG_GENERAL,
 214               SG_WARN,
 215               "addEventListener: Unknown event type " << type_str );
 216       return false;
 217     }
 218
 219     _listener[ type ].push_back(cb);
 220
 221     return true;
 222   }
 223
 224   //----------------------------------------------------------------------------
 225   void Element::clearEventListener()
 226   {
 227     _listener.clear();
 228   }
 229
 230   //----------------------------------------------------------------------------
 231   bool Element::accept(EventVisitor& visitor)
 232   {
 233     if( !isVisible() )
 234       return false;
 235
 236     return visitor.apply(*this);
 237   }
 238
 239   //----------------------------------------------------------------------------
 240   bool Element::ascend(EventVisitor& visitor)
 241   {
 242     if( _parent )
 243       return _parent->accept(visitor);
 244     return true;
 245   }
 246
 247   //----------------------------------------------------------------------------
 248   bool Element::traverse(EventVisitor& visitor)
 249   {
 250     return true;
 251   }
 252
 253   //----------------------------------------------------------------------------
 254   bool Element::handleEvent(canvas::EventPtr event)
 255   {
 256     ListenerMap::iterator listeners = _listener.find(event->getType());
 257     if( listeners == _listener.end() )
 258       return false;
 259
 260     BOOST_FOREACH(EventListener const& listener, listeners->second)
 261       listener(event);
 262
 263     return true;
 264   }
 265
 266   //----------------------------------------------------------------------------
 267   bool Element::hitBound( const osg::Vec2f& pos,
 268                           const osg::Vec2f& local_pos ) const
 269   {
 270     const osg::Vec3f pos3(pos, 0);
 271
 272     // Drawables have a bounding box...
 273     if( _drawable )
 274       return _drawable->getBound().contains(osg::Vec3f(local_pos, 0));
 275     // ... for other elements, i.e. groups only a bounding sphere is available
 276     else
 277       return _transform->getBound().contains(osg::Vec3f(pos, 0));
 278   }
 279
 280   //----------------------------------------------------------------------------
 281   void Element::setVisible(bool visible)
 282   {
 283     if( _transform.valid() )
 284       // TODO check if we need another nodemask
 285       _transform->setNodeMask(visible ? 0xffffffff : 0);
 286   }
 287
 288   //----------------------------------------------------------------------------
 289   bool Element::isVisible() const
 290   {
 291     return _transform.valid() && _transform->getNodeMask() != 0;
 292   }
 293
 294   //----------------------------------------------------------------------------
 295   osg::MatrixTransform* Element::getMatrixTransform()
 296   {
 297     return _transform.get();
 298   }
 299
 300   //----------------------------------------------------------------------------
 301   osg::MatrixTransform const* Element::getMatrixTransform() const
 302   {
 303     return _transform.get();
 304   }
 305
 306   //----------------------------------------------------------------------------
 307   void Element::childAdded(SGPropertyNode* parent, SGPropertyNode* child)
 308   {
 309     if(    parent == _node
 310         && child->getNameString() == NAME_TRANSFORM )
 311     {
 312       if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
 313         _transform_types.resize( child->getIndex() + 1 );
 314
 315       _transform_types[ child->getIndex() ] = TT_NONE;
 316       _attributes_dirty |= TRANSFORM;
 317       return;
 318     }
 319     else if(    parent->getParent() == _node
 320              && parent->getNameString() == NAME_TRANSFORM )
 321     {
 322       assert(parent->getIndex() < static_cast<int>(_transform_types.size()));
 323
 324       const std::string& name = child->getNameString();
 325
 326       TransformType& type = _transform_types[parent->getIndex()];
 327
 328       if(      name == "m" )
 329         type = TT_MATRIX;
 330       else if( name == "t" )
 331         type = TT_TRANSLATE;
 332       else if( name == "rot" )
 333         type = TT_ROTATE;
 334       else if( name == "s" )
 335         type = TT_SCALE;
 336
 337       _attributes_dirty |= TRANSFORM;
 338       return;
 339     }
 340
 341     childAdded(child);
 342   }
 343
 344   //----------------------------------------------------------------------------
 345   void Element::childRemoved(SGPropertyNode* parent, SGPropertyNode* child)
 346   {
 347     if( parent == _node )
 348     {
 349       if( child->getNameString() == NAME_TRANSFORM )
 350       {
 351         if( !_transform.valid() )
 352           return;
 353
 354         if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
 355         {
 356           SG_LOG
 357           (
 358             SG_GENERAL,
 359             SG_WARN,
 360             "Element::childRemoved: unknown transform: " << child->getPath()
 361           );
 362           return;
 363         }
 364
 365         _transform_types[ child->getIndex() ] = TT_NONE;
 366
 367         while( !_transform_types.empty() && _transform_types.back() == TT_NONE )
 368           _transform_types.pop_back();
 369
 370         _attributes_dirty |= TRANSFORM;
 371         return;
 372       }
 373       else if( StyleInfo const* style = getStyleInfo(child->getNameString()) )
 374       {
 375         if( setStyle(getParentStyle(child), style) )
 376           return;
 377       }
 378     }
 379
 380     childRemoved(child);
 381   }
 382
 383   //----------------------------------------------------------------------------
 384   void Element::valueChanged(SGPropertyNode* child)
 385   {
 386     SGPropertyNode *parent = child->getParent();
 387     if( parent == _node )
 388     {
 389       const std::string& name = child->getNameString();
 390       if( StyleInfo const* style_info = getStyleInfo(name) )
 391       {
 392         SGPropertyNode const* style = child;
 393         if( isStyleEmpty(child) )
 394         {
 395           child->clearValue();
 396           style = getParentStyle(child);
 397         }
 398         setStyle(style, style_info);
 399         return;
 400       }
 401       else if( name == "update" )
 402         return update(0);
 403       else if( boost::starts_with(name, "blend-") )
 404         return (void)(_attributes_dirty |= BLEND_FUNC);
 405     }
 406     else if(   parent->getParent() == _node
 407             && parent->getNameString() == NAME_TRANSFORM )
 408     {
 409       _attributes_dirty |= TRANSFORM;
 410       return;
 411     }
 412
 413     childChanged(child);
 414   }
 415
 416   //----------------------------------------------------------------------------
 417   bool Element::setStyle( const SGPropertyNode* child,
 418                           const StyleInfo* style_info )
 419   {
 420     return canApplyStyle(child) && setStyleImpl(child, style_info);
 421   }
 422
 423   //----------------------------------------------------------------------------
 424   void Element::setClip(const std::string& clip)
 425   {
 426     if( clip.empty() || clip == "auto" )
 427     {
 428       getOrCreateStateSet()->removeAttribute(osg::StateAttribute::SCISSOR);
 429       _scissor = 0;
 430       return;
 431     }
 432
 433     // TODO generalize CSS property parsing
 434     const std::string RECT("rect(");
 435     if(    !boost::ends_with(clip, ")")
 436         || !boost::starts_with(clip, RECT) )
 437     {
 438       SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
 439       return;
 440     }
 441
 442     const std::string sep(", \t\npx");
 443     int comp = 0;
 444     float values[4];
 445
 446     for(size_t pos = RECT.size(); comp < 4; ++comp)
 447     {
 448       pos = clip.find_first_not_of(sep, pos);
 449       if( pos == std::string::npos || pos == clip.size() - 1 )
 450         break;
 451
 452       char *end = 0;
 453       values[comp] = strtod(&clip[pos], &end);
 454       if( end == &clip[pos] || !end )
 455         break;
 456
 457       pos = end - &clip[0];
 458     }
 459
 460     if( comp < 4 )
 461     {
 462       SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
 463       return;
 464     }
 465
 466     float width = values[1] - values[3],
 467           height = values[2] - values[0];
 468
 469     if( width < 0 || height < 0 )
 470     {
 471       SG_LOG(SG_GENERAL, SG_WARN, "Canvas: negative clip size: " << clip);
 472       return;
 473     }
 474
 475     _scissor = new RelativeScissor();
 476     // <top>, <right>, <bottom>, <left>
 477     _scissor->x() = SGMiscf::roundToInt(values[3]);
 478     _scissor->y() = SGMiscf::roundToInt(values[0]);
 479     _scissor->width() = SGMiscf::roundToInt(width);
 480     _scissor->height() = SGMiscf::roundToInt(height);
 481
 482     getOrCreateStateSet()->setAttributeAndModes(_scissor);
 483
 484     SGPropertyNode* clip_frame = _node->getChild("clip-frame", 0);
 485     if( clip_frame )
 486       valueChanged(clip_frame);
 487   }
 488
 489   //----------------------------------------------------------------------------
 490   void Element::setClipFrame(ReferenceFrame rf)
 491   {
 492     if( _scissor )
 493     {
 494       _scissor->_coord_reference = rf;
 495       _attributes_dirty |= SCISSOR_COORDS;
 496     }
 497   }
 498
 499   //----------------------------------------------------------------------------
 500   void Element::setBoundingBox(const osg::BoundingBox& bb)
 501   {
 502     if( _bounding_box.empty() )
 503     {
 504       SGPropertyNode* bb_node = _node->getChild("bounding-box", 0, true);
 505       _bounding_box.resize(4);
 506       _bounding_box[0] = bb_node->getChild("min-x", 0, true);
 507       _bounding_box[1] = bb_node->getChild("min-y", 0, true);
 508       _bounding_box[2] = bb_node->getChild("max-x", 0, true);
 509       _bounding_box[3] = bb_node->getChild("max-y", 0, true);
 510     }
 511
 512     _bounding_box[0]->setFloatValue(bb._min.x());
 513     _bounding_box[1]->setFloatValue(bb._min.y());
 514     _bounding_box[2]->setFloatValue(bb._max.x());
 515     _bounding_box[3]->setFloatValue(bb._max.y());
 516   }
 517
 518   //----------------------------------------------------------------------------
 519   osg::BoundingBox Element::getTransformedBounds(const osg::Matrix& m) const
 520   {
 521     if( !_drawable )
 522       return osg::BoundingBox();
 523
 524     osg::BoundingBox transformed;
 525     const osg::BoundingBox& bb = _drawable->getBound();
 526     for(int i = 0; i < 4; ++i)
 527       transformed.expandBy( bb.corner(i) * m );
 528
 529     return transformed;
 530   }
 531
 532   //----------------------------------------------------------------------------
 533   osg::Matrix Element::getMatrix() const
 534   {
 535     if( !(_attributes_dirty & TRANSFORM) )
 536       return _transform->getMatrix();
 537
 538     osg::Matrix m;
 539     for( size_t i = 0; i < _transform_types.size(); ++i )
 540     {
 541       // Skip unused indizes...
 542       if( _transform_types[i] == TT_NONE )
 543         continue;
 544
 545       SGPropertyNode* tf_node = _node->getChild("tf", i, true);
 546
 547       // Build up the matrix representation of the current transform node
 548       osg::Matrix tf;
 549       switch( _transform_types[i] )
 550       {
 551         case TT_MATRIX:
 552           tf = osg::Matrix( tf_node->getDoubleValue("m[0]", 1),
 553                             tf_node->getDoubleValue("m[1]", 0),
 554                             0,
 555                             tf_node->getDoubleValue("m[6]", 0),
 556
 557                             tf_node->getDoubleValue("m[2]", 0),
 558                             tf_node->getDoubleValue("m[3]", 1),
 559                             0,
 560                             tf_node->getDoubleValue("m[7]", 0),
 561
 562                             0,
 563                             0,
 564                             1,
 565                             0,
 566
 567                             tf_node->getDoubleValue("m[4]", 0),
 568                             tf_node->getDoubleValue("m[5]", 0),
 569                             0,
 570                             tf_node->getDoubleValue("m[8]", 1) );
 571           break;
 572         case TT_TRANSLATE:
 573           tf.makeTranslate( osg::Vec3f( tf_node->getDoubleValue("t[0]", 0),
 574                                         tf_node->getDoubleValue("t[1]", 0),
 575                                         0 ) );
 576           break;
 577         case TT_ROTATE:
 578           tf.makeRotate( tf_node->getDoubleValue("rot", 0), 0, 0, 1 );
 579           break;
 580         case TT_SCALE:
 581         {
 582           float sx = tf_node->getDoubleValue("s[0]", 1);
 583           // sy defaults to sx...
 584           tf.makeScale( sx, tf_node->getDoubleValue("s[1]", sx), 1 );
 585           break;
 586         }
 587         default:
 588           break;
 589       }
 590       m.postMult( tf );
 591     }
 592     _transform->setMatrix(m);
 593     _attributes_dirty &= ~TRANSFORM;
 594     _attributes_dirty |= SCISSOR_COORDS;
 595
 596     return m;
 597   }
 598
 599   //----------------------------------------------------------------------------
 600   Element::StyleSetters Element::_style_setters;
 601
 602   //----------------------------------------------------------------------------
 603   Element::Element( const CanvasWeakPtr& canvas,
 604                     const SGPropertyNode_ptr& node,
 605                     const Style& parent_style,
 606                     Element* parent ):
 607     PropertyBasedElement(node),
 608     _canvas( canvas ),
 609     _parent( parent ),
 610     _attributes_dirty( 0 ),
 611     _transform( new osg::MatrixTransform ),
 612     _style( parent_style ),
 613     _scissor( 0 ),
 614     _drawable( 0 )
 615   {
 616     staticInit();
 617
 618     SG_LOG
 619     (
 620       SG_GL,
 621       SG_DEBUG,
 622       "New canvas element " << node->getPath()
 623     );
 624
 625     // Ensure elements are drawn in order they appear in the element tree
 626     _transform->getOrCreateStateSet()
 627               ->setRenderBinDetails
 628               (
 629                 0,
 630                 "PreOrderBin",
 631                 osg::StateSet::OVERRIDE_RENDERBIN_DETAILS
 632               );
 633   }
 634
 635   //----------------------------------------------------------------------------
 636   void Element::staticInit()
 637   {
 638     if( isInit<Element>() )
 639       return;
 640
 641     addStyle("clip", "", &Element::setClip, false);
 642     addStyle("clip-frame", "", &Element::setClipFrame, false);
 643     addStyle("visible", "", &Element::setVisible, false);
 644   }
 645
 646   //----------------------------------------------------------------------------
 647   bool Element::isStyleEmpty(const SGPropertyNode* child) const
 648   {
 649     return !child
 650         || simgear::strutils::strip(child->getStringValue()).empty();
 651   }
 652
 653   //----------------------------------------------------------------------------
 654   bool Element::canApplyStyle(const SGPropertyNode* child) const
 655   {
 656     if( _node == child->getParent() )
 657       return true;
 658
 659     // Parent values do not override if element has own value
 660     return isStyleEmpty( _node->getChild(child->getName()) );
 661   }
 662
 663   //----------------------------------------------------------------------------
 664   bool Element::setStyleImpl( const SGPropertyNode* child,
 665                               const StyleInfo* style_info )
 666   {
 667     const StyleSetter* style_setter = style_info
 668                                     ? &style_info->setter
 669                                     : getStyleSetter(child->getNameString());
 670     while( style_setter )
 671     {
 672       if( style_setter->func(*this, child) )
 673         return true;
 674       style_setter = style_setter->next;
 675     }
 676     return false;
 677   }
 678
 679   //----------------------------------------------------------------------------
 680   const Element::StyleInfo*
 681   Element::getStyleInfo(const std::string& name) const
 682   {
 683     StyleSetters::const_iterator setter = _style_setters.find(name);
 684     if( setter == _style_setters.end() )
 685       return 0;
 686
 687     return &setter->second;
 688   }
 689
 690   //----------------------------------------------------------------------------
 691   const Element::StyleSetter*
 692   Element::getStyleSetter(const std::string& name) const
 693   {
 694     const StyleInfo* info = getStyleInfo(name);
 695     return info ? &info->setter : 0;
 696   }
 697
 698   //----------------------------------------------------------------------------
 699   const SGPropertyNode*
 700   Element::getParentStyle(const SGPropertyNode* child) const
 701   {
 702     // Try to get value from parent...
 703     if( _parent )
 704     {
 705       Style::const_iterator style =
 706         _parent->_style.find(child->getNameString());
 707       if( style != _parent->_style.end() )
 708         return style->second;
 709     }
 710
 711     // ...or reset to default if none is available
 712     return child; // TODO somehow get default value for each style?
 713   }
 714
 715   //----------------------------------------------------------------------------
 716   void Element::setDrawable( osg::Drawable* drawable )
 717   {
 718     _drawable = drawable;
 719     assert( _drawable );
 720
 721     osg::ref_ptr<osg::Geode> geode = new osg::Geode;
 722     geode->addDrawable(_drawable);
 723     _transform->addChild(geode);
 724   }
 725
 726   //----------------------------------------------------------------------------
 727   osg::StateSet* Element::getOrCreateStateSet()
 728   {
 729     return _drawable ? _drawable->getOrCreateStateSet()
 730                      : _transform->getOrCreateStateSet();
 731   }
 732
 733   //----------------------------------------------------------------------------
 734   void Element::setupStyle()
 735   {
 736     BOOST_FOREACH( Style::value_type style, _style )
 737       setStyle(style.second);
 738   }
 739
 740 } // namespace canvas
 741 } // namespace simgear