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