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/Canvas.hxx>
  21 #include <simgear/canvas/CanvasEventListener.hxx>
  22 #include <simgear/canvas/CanvasEventVisitor.hxx>
  23 #include <simgear/canvas/MouseEvent.hxx>
  24
  25 #include <osg/Drawable>
  26 #include <osg/Geode>
  27 #include <osg/Scissor>
  28
  29 #include <boost/algorithm/string/predicate.hpp>
  30 #include <boost/foreach.hpp>
  31 #include <boost/lexical_cast.hpp>
  32 #include <boost/make_shared.hpp>
  33 #include <boost/tokenizer.hpp>
  34
  35 #include <cassert>
  36 #include <cstring>
  37
  38 namespace simgear
  39 {
  40 namespace canvas
  41 {
  42   const std::string NAME_TRANSFORM = "tf";
  43
  44   //----------------------------------------------------------------------------
  45   void Element::removeListener()
  46   {
  47     _node->removeChangeListener(this);
  48   }
  49
  50   //----------------------------------------------------------------------------
  51   Element::~Element()
  52   {
  53     removeListener();
  54
  55     BOOST_FOREACH(osg::Group* parent, _transform->getParents())
  56     {
  57       parent->removeChild(_transform);
  58     }
  59   }
  60
  61   //----------------------------------------------------------------------------
  62   ElementWeakPtr Element::getWeakPtr() const
  63   {
  64     return boost::static_pointer_cast<Element>(_self.lock());
  65   }
  66
  67   //----------------------------------------------------------------------------
  68   void Element::update(double dt)
  69   {
  70     if( !_transform->getNodeMask() )
  71       // Don't do anything if element is hidden
  72       return;
  73
  74     if( _transform_dirty )
  75     {
  76       osg::Matrix m;
  77       for( size_t i = 0; i < _transform_types.size(); ++i )
  78       {
  79         // Skip unused indizes...
  80         if( _transform_types[i] == TT_NONE )
  81           continue;
  82
  83         SGPropertyNode* tf_node = _node->getChild("tf", i, true);
  84
  85         // Build up the matrix representation of the current transform node
  86         osg::Matrix tf;
  87         switch( _transform_types[i] )
  88         {
  89           case TT_MATRIX:
  90             tf = osg::Matrix( tf_node->getDoubleValue("m[0]", 1),
  91                               tf_node->getDoubleValue("m[1]", 0),
  92                               0,
  93                               tf_node->getDoubleValue("m[6]", 0),
  94
  95                               tf_node->getDoubleValue("m[2]", 0),
  96                               tf_node->getDoubleValue("m[3]", 1),
  97                               0,
  98                               tf_node->getDoubleValue("m[7]", 0),
  99
 100                               0,
 101                               0,
 102                               1,
 103                               0,
 104
 105                               tf_node->getDoubleValue("m[4]", 0),
 106                               tf_node->getDoubleValue("m[5]", 0),
 107                               0,
 108                               tf_node->getDoubleValue("m[8]", 1) );
 109             break;
 110           case TT_TRANSLATE:
 111             tf.makeTranslate( osg::Vec3f( tf_node->getDoubleValue("t[0]", 0),
 112                                           tf_node->getDoubleValue("t[1]", 0),
 113                                           0 ) );
 114             break;
 115           case TT_ROTATE:
 116             tf.makeRotate( tf_node->getDoubleValue("rot", 0), 0, 0, 1 );
 117             break;
 118           case TT_SCALE:
 119           {
 120             float sx = tf_node->getDoubleValue("s[0]", 1);
 121             // sy defaults to sx...
 122             tf.makeScale( sx, tf_node->getDoubleValue("s[1]", sx), 1 );
 123             break;
 124           }
 125           default:
 126             break;
 127         }
 128         m.postMult( tf );
 129       }
 130       _transform->setMatrix(m);
 131       _transform_dirty = false;
 132     }
 133
 134     // Update bounding box on manual update (manual updates pass zero dt)
 135     if( dt == 0 && _drawable )
 136       _drawable->getBound();
 137   }
 138
 139   //----------------------------------------------------------------------------
 140   naRef Element::addEventListener(const nasal::CallContext& ctx)
 141   {
 142     const std::string type_str = ctx.requireArg<std::string>(0);
 143     naRef code = ctx.requireArg<naRef>(1);
 144
 145     SG_LOG
 146     (
 147       SG_NASAL,
 148       SG_INFO,
 149       "addEventListener(" << _node->getPath() << ", " << type_str << ")"
 150     );
 151
 152     Event::Type type = Event::strToType(type_str);
 153     if( type == Event::UNKNOWN )
 154       naRuntimeError( ctx.c,
 155                       "addEventListener: Unknown event type %s",
 156                       type_str.c_str() );
 157
 158     _listener[ type ].push_back
 159     (
 160       boost::make_shared<EventListener>( code,
 161                                          _canvas.lock()->getSystemAdapter() )
 162     );
 163
 164     return naNil();
 165   }
 166
 167   //----------------------------------------------------------------------------
 168   bool Element::accept(EventVisitor& visitor)
 169   {
 170     return visitor.apply(*this);
 171   }
 172
 173   //----------------------------------------------------------------------------
 174   bool Element::ascend(EventVisitor& visitor)
 175   {
 176     if( _parent )
 177       return _parent->accept(visitor);
 178     return true;
 179   }
 180
 181   //----------------------------------------------------------------------------
 182   bool Element::traverse(EventVisitor& visitor)
 183   {
 184     return true;
 185   }
 186
 187   //----------------------------------------------------------------------------
 188   void Element::callListeners(const canvas::EventPtr& event)
 189   {
 190     ListenerMap::iterator listeners = _listener.find(event->getType());
 191     if( listeners == _listener.end() )
 192       return;
 193
 194     BOOST_FOREACH(EventListenerPtr listener, listeners->second)
 195       listener->call(event);
 196   }
 197
 198   //----------------------------------------------------------------------------
 199   bool Element::hitBound( const osg::Vec2f& pos,
 200                           const osg::Vec2f& local_pos ) const
 201   {
 202     const osg::Vec3f pos3(pos, 0);
 203
 204     // Drawables have a bounding box...
 205     if( _drawable )
 206     {
 207       if( !_drawable->getBound().contains(osg::Vec3f(local_pos, 0)) )
 208         return false;
 209     }
 210     // ... for other elements, i.e. groups only a bounding sphere is available
 211     else if( !_transform->getBound().contains(osg::Vec3f(pos, 0)) )
 212         return false;
 213
 214     return true;
 215   }
 216
 217   //----------------------------------------------------------------------------
 218   bool Element::isVisible() const
 219   {
 220     return _transform->getNodeMask() != 0;
 221   }
 222
 223   //----------------------------------------------------------------------------
 224   osg::ref_ptr<osg::MatrixTransform> Element::getMatrixTransform()
 225   {
 226     return _transform;
 227   }
 228
 229   //----------------------------------------------------------------------------
 230   void Element::childAdded(SGPropertyNode* parent, SGPropertyNode* child)
 231   {
 232     if(    parent == _node
 233         && child->getNameString() == NAME_TRANSFORM )
 234     {
 235       if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
 236         _transform_types.resize( child->getIndex() + 1 );
 237
 238       _transform_types[ child->getIndex() ] = TT_NONE;
 239       _transform_dirty = true;
 240       return;
 241     }
 242     else if(    parent->getParent() == _node
 243              && parent->getNameString() == NAME_TRANSFORM )
 244     {
 245       assert(parent->getIndex() < static_cast<int>(_transform_types.size()));
 246
 247       const std::string& name = child->getNameString();
 248
 249       TransformType& type = _transform_types[parent->getIndex()];
 250
 251       if(      name == "m" )
 252         type = TT_MATRIX;
 253       else if( name == "t" )
 254         type = TT_TRANSLATE;
 255       else if( name == "rot" )
 256         type = TT_ROTATE;
 257       else if( name == "s" )
 258         type = TT_SCALE;
 259
 260       _transform_dirty = true;
 261       return;
 262     }
 263
 264     childAdded(child);
 265   }
 266
 267   //----------------------------------------------------------------------------
 268   void Element::childRemoved(SGPropertyNode* parent, SGPropertyNode* child)
 269   {
 270     if( parent == _node && child->getNameString() == NAME_TRANSFORM )
 271     {
 272       if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
 273       {
 274         SG_LOG
 275         (
 276           SG_GENERAL,
 277           SG_WARN,
 278           "Element::childRemoved: unknown transform: " << child->getPath()
 279         );
 280         return;
 281       }
 282
 283       _transform_types[ child->getIndex() ] = TT_NONE;
 284
 285       while( !_transform_types.empty() && _transform_types.back() == TT_NONE )
 286         _transform_types.pop_back();
 287
 288       _transform_dirty = true;
 289       return;
 290     }
 291
 292     childRemoved(child);
 293   }
 294
 295   //----------------------------------------------------------------------------
 296   void Element::valueChanged(SGPropertyNode* child)
 297   {
 298     SGPropertyNode *parent = child->getParent();
 299     if( parent == _node )
 300     {
 301       if( setStyle(child) )
 302         return;
 303       else if( child->getNameString() == "update" )
 304         return update(0);
 305       else if( child->getNameString() == "visible" )
 306         // TODO check if we need another nodemask
 307         return _transform->setNodeMask( child->getBoolValue() ? 0xffffffff : 0 );
 308     }
 309     else if(   parent->getParent() == _node
 310             && parent->getNameString() == NAME_TRANSFORM )
 311     {
 312       _transform_dirty = true;
 313       return;
 314     }
 315
 316     childChanged(child);
 317   }
 318
 319   //----------------------------------------------------------------------------
 320   bool Element::setStyle(const SGPropertyNode* child)
 321   {
 322     StyleSetters::const_iterator setter =
 323       _style_setters.find(child->getNameString());
 324     if( setter == _style_setters.end() )
 325       return false;
 326
 327     setter->second(child);
 328     return true;
 329   }
 330
 331   //----------------------------------------------------------------------------
 332   void Element::setClip(const std::string& clip)
 333   {
 334     if( clip.empty() || clip == "auto" )
 335     {
 336       getOrCreateStateSet()->removeAttribute(osg::StateAttribute::SCISSOR);
 337       return;
 338     }
 339
 340     // TODO generalize CSS property parsing
 341     const std::string RECT("rect(");
 342     if(    !boost::ends_with(clip, ")")
 343         || !boost::starts_with(clip, RECT) )
 344     {
 345       SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
 346       return;
 347     }
 348
 349     typedef boost::tokenizer<boost::char_separator<char> > tokenizer;
 350     const boost::char_separator<char> del(", \t\npx");
 351
 352     tokenizer tokens(clip.begin() + RECT.size(), clip.end() - 1, del);
 353     int comp = 0;
 354     int values[4];
 355     for( tokenizer::const_iterator tok = tokens.begin();
 356          tok != tokens.end() && comp < 4;
 357          ++tok, ++comp )
 358     {
 359       values[comp] = boost::lexical_cast<int>(*tok);
 360     }
 361
 362     if( comp < 4 )
 363     {
 364       SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
 365       return;
 366     }
 367
 368     float scale_x = 1,
 369           scale_y = 1;
 370
 371     CanvasPtr canvas = _canvas.lock();
 372     if( canvas )
 373     {
 374       // The scissor rectangle isn't affected by any transformation, so we need
 375       // to convert to image/canvas coordinates on our selves.
 376       scale_x = canvas->getSizeX()
 377               / static_cast<float>(canvas->getViewWidth());
 378       scale_y = canvas->getSizeY()
 379               / static_cast<float>(canvas->getViewHeight());
 380     }
 381
 382     osg::Scissor* scissor = new osg::Scissor();
 383     // <top>, <right>, <bottom>, <left>
 384     scissor->x() = scale_x * values[3];
 385     scissor->y() = scale_y * values[0];
 386     scissor->width() = scale_x * (values[1] - values[3]);
 387     scissor->height() = scale_y * (values[2] - values[0]);
 388
 389     if( canvas )
 390       // Canvas has y axis upside down
 391       scissor->y() = canvas->getSizeY() - scissor->y() - scissor->height();
 392
 393     getOrCreateStateSet()->setAttributeAndModes(scissor);
 394   }
 395
 396   //----------------------------------------------------------------------------
 397   void Element::setBoundingBox(const osg::BoundingBox& bb)
 398   {
 399     if( _bounding_box.empty() )
 400     {
 401       SGPropertyNode* bb_node = _node->getChild("bounding-box", 0, true);
 402       _bounding_box.resize(4);
 403       _bounding_box[0] = bb_node->getChild("min-x", 0, true);
 404       _bounding_box[1] = bb_node->getChild("min-y", 0, true);
 405       _bounding_box[2] = bb_node->getChild("max-x", 0, true);
 406       _bounding_box[3] = bb_node->getChild("max-y", 0, true);
 407     }
 408
 409     _bounding_box[0]->setFloatValue(bb._min.x());
 410     _bounding_box[1]->setFloatValue(bb._min.y());
 411     _bounding_box[2]->setFloatValue(bb._max.x());
 412     _bounding_box[3]->setFloatValue(bb._max.y());
 413   }
 414
 415   //----------------------------------------------------------------------------
 416   osg::BoundingBox Element::getTransformedBounds(const osg::Matrix& m) const
 417   {
 418     if( !_drawable )
 419       return osg::BoundingBox();
 420
 421     osg::BoundingBox transformed;
 422     const osg::BoundingBox& bb = _drawable->getBound();
 423     for(int i = 0; i < 4; ++i)
 424       transformed.expandBy( m * bb.corner(i) );
 425
 426     return transformed;
 427   }
 428
 429   //----------------------------------------------------------------------------
 430   Element::Element( const CanvasWeakPtr& canvas,
 431                     const SGPropertyNode_ptr& node,
 432                     const Style& parent_style,
 433                     Element* parent ):
 434     PropertyBasedElement(node),
 435     _canvas( canvas ),
 436     _parent( parent ),
 437     _transform_dirty( false ),
 438     _transform( new osg::MatrixTransform ),
 439     _style( parent_style ),
 440     _drawable( 0 )
 441   {
 442     SG_LOG
 443     (
 444       SG_GL,
 445       SG_DEBUG,
 446       "New canvas element " << node->getPath()
 447     );
 448
 449     addStyle("clip", &Element::setClip, this);
 450   }
 451
 452   //----------------------------------------------------------------------------
 453   void Element::setDrawable( osg::Drawable* drawable )
 454   {
 455     _drawable = drawable;
 456     assert( _drawable );
 457
 458     osg::ref_ptr<osg::Geode> geode = new osg::Geode;
 459     geode->addDrawable(_drawable);
 460     _transform->addChild(geode);
 461   }
 462
 463   //----------------------------------------------------------------------------
 464   osg::StateSet* Element::getOrCreateStateSet()
 465   {
 466     return _drawable ? _drawable->getOrCreateStateSet()
 467                      : _transform->getOrCreateStateSet();
 468   }
 469
 470   //----------------------------------------------------------------------------
 471   void Element::setupStyle()
 472   {
 473     BOOST_FOREACH( Style::value_type style, _style )
 474       setStyle(style.second);
 475   }
 476
 477 } // namespace canvas
 478 } // namespace simgear