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
 135   //----------------------------------------------------------------------------
 136   naRef Element::addEventListener(const nasal::CallContext& ctx)
 137   {
 138     const std::string type_str = ctx.requireArg<std::string>(0);
 139     naRef code = ctx.requireArg<naRef>(1);
 140
 141     SG_LOG
 142     (
 143       SG_NASAL,
 144       SG_INFO,
 145       "addEventListener(" << _node->getPath() << ", " << type_str << ")"
 146     );
 147
 148     Event::Type type = Event::strToType(type_str);
 149     if( type == Event::UNKNOWN )
 150       naRuntimeError( ctx.c,
 151                       "addEventListener: Unknown event type %s",
 152                       type_str.c_str() );
 153
 154     _listener[ type ].push_back
 155     (
 156       boost::make_shared<EventListener>( code,
 157                                          _canvas.lock()->getSystemAdapter() )
 158     );
 159
 160     return naNil();
 161   }
 162
 163   //----------------------------------------------------------------------------
 164   bool Element::accept(EventVisitor& visitor)
 165   {
 166     return visitor.apply(*this);
 167   }
 168
 169   //----------------------------------------------------------------------------
 170   bool Element::ascend(EventVisitor& visitor)
 171   {
 172     if( _parent )
 173       return _parent->accept(visitor);
 174     return true;
 175   }
 176
 177   //----------------------------------------------------------------------------
 178   bool Element::traverse(EventVisitor& visitor)
 179   {
 180     return true;
 181   }
 182
 183   //----------------------------------------------------------------------------
 184   void Element::callListeners(const canvas::EventPtr& event)
 185   {
 186     ListenerMap::iterator listeners = _listener.find(event->getType());
 187     if( listeners == _listener.end() )
 188       return;
 189
 190     BOOST_FOREACH(EventListenerPtr listener, listeners->second)
 191       listener->call(event);
 192   }
 193
 194   //----------------------------------------------------------------------------
 195   bool Element::hitBound(const osg::Vec2f& pos) const
 196   {
 197     const osg::Vec3f pos3(pos, 0);
 198
 199     // Drawables have a bounding box...
 200     if( _drawable )
 201     {
 202       if( !_drawable->getBound().contains(pos3) )
 203         return false;
 204     }
 205     // ... for other elements, i.e. groups only a bounding sphere is available
 206     else if( !_transform->getBound().contains(pos3) )
 207       return false;
 208
 209     return true;
 210   }
 211
 212   //----------------------------------------------------------------------------
 213   osg::ref_ptr<osg::MatrixTransform> Element::getMatrixTransform()
 214   {
 215     return _transform;
 216   }
 217
 218   //----------------------------------------------------------------------------
 219   void Element::childAdded(SGPropertyNode* parent, SGPropertyNode* child)
 220   {
 221     if(    parent == _node
 222         && child->getNameString() == NAME_TRANSFORM )
 223     {
 224       if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
 225         _transform_types.resize( child->getIndex() + 1 );
 226
 227       _transform_types[ child->getIndex() ] = TT_NONE;
 228       _transform_dirty = true;
 229       return;
 230     }
 231     else if(    parent->getParent() == _node
 232              && parent->getNameString() == NAME_TRANSFORM )
 233     {
 234       assert(parent->getIndex() < static_cast<int>(_transform_types.size()));
 235
 236       const std::string& name = child->getNameString();
 237
 238       TransformType& type = _transform_types[parent->getIndex()];
 239
 240       if(      name == "m" )
 241         type = TT_MATRIX;
 242       else if( name == "t" )
 243         type = TT_TRANSLATE;
 244       else if( name == "rot" )
 245         type = TT_ROTATE;
 246       else if( name == "s" )
 247         type = TT_SCALE;
 248
 249       _transform_dirty = true;
 250       return;
 251     }
 252
 253     childAdded(child);
 254   }
 255
 256   //----------------------------------------------------------------------------
 257   void Element::childRemoved(SGPropertyNode* parent, SGPropertyNode* child)
 258   {
 259     if( parent == _node && child->getNameString() == NAME_TRANSFORM )
 260     {
 261       if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
 262       {
 263         SG_LOG
 264         (
 265           SG_GENERAL,
 266           SG_WARN,
 267           "Element::childRemoved: unknown transform: " << child->getPath()
 268         );
 269         return;
 270       }
 271
 272       _transform_types[ child->getIndex() ] = TT_NONE;
 273
 274       while( !_transform_types.empty() && _transform_types.back() == TT_NONE )
 275         _transform_types.pop_back();
 276
 277       _transform_dirty = true;
 278       return;
 279     }
 280
 281     childRemoved(child);
 282   }
 283
 284   //----------------------------------------------------------------------------
 285   void Element::valueChanged(SGPropertyNode* child)
 286   {
 287     SGPropertyNode *parent = child->getParent();
 288     if( parent == _node )
 289     {
 290       if( setStyle(child) )
 291         return;
 292       else if( child->getNameString() == "update" )
 293         return update(0);
 294       else if( child->getNameString() == "visible" )
 295         // TODO check if we need another nodemask
 296         return _transform->setNodeMask( child->getBoolValue() ? 0xffffffff : 0 );
 297     }
 298     else if(   parent->getParent() == _node
 299             && parent->getNameString() == NAME_TRANSFORM )
 300     {
 301       _transform_dirty = true;
 302       return;
 303     }
 304
 305     childChanged(child);
 306   }
 307
 308   //----------------------------------------------------------------------------
 309   bool Element::setStyle(const SGPropertyNode* child)
 310   {
 311     StyleSetters::const_iterator setter =
 312       _style_setters.find(child->getNameString());
 313     if( setter == _style_setters.end() )
 314       return false;
 315
 316     setter->second(child);
 317     return true;
 318   }
 319
 320   //----------------------------------------------------------------------------
 321   void Element::setClip(const std::string& clip)
 322   {
 323     if( clip.empty() || clip == "auto" )
 324     {
 325       getOrCreateStateSet()->removeAttribute(osg::StateAttribute::SCISSOR);
 326       return;
 327     }
 328
 329     // TODO generalize CSS property parsing
 330     const std::string RECT("rect(");
 331     if(    !boost::ends_with(clip, ")")
 332         || !boost::starts_with(clip, RECT) )
 333     {
 334       SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
 335       return;
 336     }
 337
 338     typedef boost::tokenizer<boost::char_separator<char> > tokenizer;
 339     const boost::char_separator<char> del(", \t\npx");
 340
 341     tokenizer tokens(clip.begin() + RECT.size(), clip.end() - 1, del);
 342     int comp = 0;
 343     int values[4];
 344     for( tokenizer::const_iterator tok = tokens.begin();
 345          tok != tokens.end() && comp < 4;
 346          ++tok, ++comp )
 347     {
 348       values[comp] = boost::lexical_cast<int>(*tok);
 349     }
 350
 351     if( comp < 4 )
 352     {
 353       SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
 354       return;
 355     }
 356
 357     float scale_x = 1,
 358           scale_y = 1;
 359
 360     CanvasPtr canvas = _canvas.lock();
 361     if( canvas )
 362     {
 363       // The scissor rectangle isn't affected by any transformation, so we need
 364       // to convert to image/canvas coordinates on our selves.
 365       scale_x = canvas->getSizeX()
 366               / static_cast<float>(canvas->getViewWidth());
 367       scale_y = canvas->getSizeY()
 368               / static_cast<float>(canvas->getViewHeight());
 369     }
 370
 371     osg::Scissor* scissor = new osg::Scissor();
 372     // <top>, <right>, <bottom>, <left>
 373     scissor->x() = scale_x * values[3];
 374     scissor->y() = scale_y * values[0];
 375     scissor->width() = scale_x * (values[1] - values[3]);
 376     scissor->height() = scale_y * (values[2] - values[0]);
 377
 378     if( canvas )
 379       // Canvas has y axis upside down
 380       scissor->y() = canvas->getSizeY() - scissor->y() - scissor->height();
 381
 382     getOrCreateStateSet()->setAttributeAndModes(scissor);
 383   }
 384
 385   //----------------------------------------------------------------------------
 386   void Element::setBoundingBox(const osg::BoundingBox& bb)
 387   {
 388     if( _bounding_box.empty() )
 389     {
 390       SGPropertyNode* bb_node = _node->getChild("bounding-box", 0, true);
 391       _bounding_box.resize(4);
 392       _bounding_box[0] = bb_node->getChild("min-x", 0, true);
 393       _bounding_box[1] = bb_node->getChild("min-y", 0, true);
 394       _bounding_box[2] = bb_node->getChild("max-x", 0, true);
 395       _bounding_box[3] = bb_node->getChild("max-y", 0, true);
 396     }
 397
 398     _bounding_box[0]->setFloatValue(bb._min.x());
 399     _bounding_box[1]->setFloatValue(bb._min.y());
 400     _bounding_box[2]->setFloatValue(bb._max.x());
 401     _bounding_box[3]->setFloatValue(bb._max.y());
 402   }
 403
 404   //----------------------------------------------------------------------------
 405   osg::BoundingBox Element::getTransformedBounds(const osg::Matrix& m) const
 406   {
 407     return osg::BoundingBox();
 408   }
 409
 410   //----------------------------------------------------------------------------
 411   Element::Element( const CanvasWeakPtr& canvas,
 412                     const SGPropertyNode_ptr& node,
 413                     const Style& parent_style,
 414                     Element* parent ):
 415     PropertyBasedElement(node),
 416     _canvas( canvas ),
 417     _parent( parent ),
 418     _transform_dirty( false ),
 419     _transform( new osg::MatrixTransform ),
 420     _style( parent_style ),
 421     _drawable( 0 )
 422   {
 423     SG_LOG
 424     (
 425       SG_GL,
 426       SG_DEBUG,
 427       "New canvas element " << node->getPath()
 428     );
 429
 430     addStyle("clip", &Element::setClip, this);
 431   }
 432
 433   //----------------------------------------------------------------------------
 434   void Element::setDrawable( osg::Drawable* drawable )
 435   {
 436     _drawable = drawable;
 437     assert( _drawable );
 438
 439     osg::ref_ptr<osg::Geode> geode = new osg::Geode;
 440     geode->addDrawable(_drawable);
 441     _transform->addChild(geode);
 442   }
 443
 444   //----------------------------------------------------------------------------
 445   osg::StateSet* Element::getOrCreateStateSet()
 446   {
 447     return _drawable ? _drawable->getOrCreateStateSet()
 448                      : _transform->getOrCreateStateSet();
 449   }
 450
 451   //----------------------------------------------------------------------------
 452   void Element::setupStyle()
 453   {
 454     BOOST_FOREACH( Style::value_type style, _style )
 455       setStyle(style.second);
 456   }
 457
 458 } // namespace canvas
 459 } // namespace simgear