1 // Interface for 2D Canvas element
3 // Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
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.
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.
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
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>
27 #include <osg/Drawable>
29 #include <osg/Scissor>
31 #include <boost/algorithm/string/predicate.hpp>
32 #include <boost/foreach.hpp>
33 #include <boost/make_shared.hpp>
43 const std::string NAME_TRANSFORM = "tf";
46 * glScissor with coordinates relative to different reference frames.
48 class Element::RelativeScissor:
53 ReferenceFrame _coord_reference;
54 osg::Matrix _parent_inverse;
57 _coord_reference(GLOBAL)
60 bool contains(const osg::Vec2f& pos) const
62 return _x <= pos.x() && pos.x() <= _x + _width
63 && _y <= pos.y() && pos.y() <= _y + _height;
66 bool contains( const osg::Vec2f& global_pos,
67 const osg::Vec2f& parent_pos,
68 const osg::Vec2f& local_pos ) const
70 switch( _coord_reference )
72 case GLOBAL: return contains(global_pos);
73 case PARENT: return contains(parent_pos);
74 case LOCAL: return contains(local_pos);
80 virtual void apply(osg::State& state) const
82 const osg::Viewport* vp = state.getCurrentViewport();
83 float w2 = 0.5 * vp->width(),
84 h2 = 0.5 * vp->height();
86 osg::Matrix model_view
93 model_view.preMult(state.getProjectionMatrix());
95 if( _coord_reference != GLOBAL )
97 model_view.preMult(state.getModelViewMatrix());
99 if( _coord_reference == PARENT )
100 model_view.preMult(_parent_inverse);
103 const osg::Vec2 scale( model_view(0,0), model_view(1,1)),
104 offset(model_view(3,0), model_view(3,1));
106 // TODO check/warn for rotation?
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);
118 glScissor(x, y, w, h);
122 //----------------------------------------------------------------------------
123 Element::OSGUserData::OSGUserData(ElementPtr element):
129 //----------------------------------------------------------------------------
132 if( !_transform.valid() )
135 for(unsigned int i = 0; i < _transform->getNumChildren(); ++i)
138 static_cast<OSGUserData*>(_transform->getChild(i)->getUserData());
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;
147 //----------------------------------------------------------------------------
148 void Element::onDestroy()
150 if( !_transform.valid() )
153 // The transform node keeps a reference on this element, so ensure it is
155 BOOST_FOREACH(osg::Group* parent, _transform->getParents())
157 parent->removeChild(_transform.get());
161 //----------------------------------------------------------------------------
162 ElementPtr Element::getParent() const
167 //----------------------------------------------------------------------------
168 CanvasWeakPtr Element::getCanvas() const
173 //----------------------------------------------------------------------------
174 void Element::update(double dt)
179 // Trigger matrix update
182 // TODO limit bounding box to scissor
183 if( _attributes_dirty & SCISSOR_COORDS )
185 if( _scissor && _scissor->_coord_reference != GLOBAL )
186 _scissor->_parent_inverse = _transform->getInverseMatrix();
188 _attributes_dirty &= ~SCISSOR_COORDS;
191 // Update bounding box on manual update (manual updates pass zero dt)
192 if( dt == 0 && _drawable )
193 _drawable->getBound();
195 if( _attributes_dirty & BLEND_FUNC )
198 _transform->getOrCreateStateSet(),
199 _node->getChild("blend-source"),
200 _node->getChild("blend-destination"),
201 _node->getChild("blend-source-rgb"),
202 _node->getChild("blend-destination-rgb"),
203 _node->getChild("blend-source-alpha"),
204 _node->getChild("blend-destination-alpha")
206 _attributes_dirty &= ~BLEND_FUNC;
210 //----------------------------------------------------------------------------
211 bool Element::addEventListener( const std::string& type_str,
212 const EventListener& cb )
218 "addEventListener(" << _node->getPath() << ", " << type_str << ")"
221 _listener[ Event::getOrRegisterType(type_str) ].push_back(cb);
225 //----------------------------------------------------------------------------
226 void Element::clearEventListener()
231 //----------------------------------------------------------------------------
232 bool Element::accept(EventVisitor& visitor)
237 return visitor.apply(*this);
240 //----------------------------------------------------------------------------
241 bool Element::ascend(EventVisitor& visitor)
244 return _parent->accept(visitor);
248 //----------------------------------------------------------------------------
249 bool Element::traverse(EventVisitor& visitor)
254 //----------------------------------------------------------------------------
255 bool Element::handleEvent(const EventPtr& event)
257 ListenerMap::iterator listeners = _listener.find(event->getType());
258 if( listeners == _listener.end() )
261 BOOST_FOREACH(EventListener const& listener, listeners->second)
266 catch( std::exception const& ex )
271 "canvas::Element: event handler error: '" << ex.what() << "'"
278 //----------------------------------------------------------------------------
279 bool Element::dispatchEvent(const EventPtr& event)
281 EventPropagationPath path;
282 path.push_back( EventTarget(this) );
284 for( Element* parent = _parent;
286 parent = parent->_parent )
287 path.push_front( EventTarget(parent) );
289 CanvasPtr canvas = _canvas.lock();
293 return canvas->propagateEvent(event, path);
296 //----------------------------------------------------------------------------
297 bool Element::hitBound( const osg::Vec2f& global_pos,
298 const osg::Vec2f& parent_pos,
299 const osg::Vec2f& local_pos ) const
301 if( _scissor && !_scissor->contains(global_pos, parent_pos, local_pos) )
304 const osg::Vec3f pos3(parent_pos, 0);
306 // Drawables have a bounding box...
308 return _drawable->getBound().contains(osg::Vec3f(local_pos, 0));
309 else if( _transform.valid() )
310 // ... for other elements, i.e. groups only a bounding sphere is available
311 return _transform->getBound().contains(osg::Vec3f(parent_pos, 0));
317 //----------------------------------------------------------------------------
318 void Element::setVisible(bool visible)
320 if( _transform.valid() )
321 // TODO check if we need another nodemask
322 _transform->setNodeMask(visible ? 0xffffffff : 0);
325 //----------------------------------------------------------------------------
326 bool Element::isVisible() const
328 return _transform.valid() && _transform->getNodeMask() != 0;
331 //----------------------------------------------------------------------------
332 osg::MatrixTransform* Element::getMatrixTransform()
334 return _transform.get();
337 //----------------------------------------------------------------------------
338 osg::MatrixTransform const* Element::getMatrixTransform() const
340 return _transform.get();
343 //----------------------------------------------------------------------------
344 osg::Vec2f Element::posToLocal(const osg::Vec2f& pos) const
347 const osg::Matrix& m = _transform->getInverseMatrix();
350 m(0, 0) * pos[0] + m(1, 0) * pos[1] + m(3, 0),
351 m(0, 1) * pos[0] + m(1, 1) * pos[1] + m(3, 1)
355 //----------------------------------------------------------------------------
356 void Element::childAdded(SGPropertyNode* parent, SGPropertyNode* child)
359 && child->getNameString() == NAME_TRANSFORM )
361 if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
362 _transform_types.resize( child->getIndex() + 1 );
364 _transform_types[ child->getIndex() ] = TT_NONE;
365 _attributes_dirty |= TRANSFORM;
368 else if( parent->getParent() == _node
369 && parent->getNameString() == NAME_TRANSFORM )
371 assert(parent->getIndex() < static_cast<int>(_transform_types.size()));
373 const std::string& name = child->getNameString();
375 TransformType& type = _transform_types[parent->getIndex()];
379 else if( name == "t" )
381 else if( name == "rot" )
383 else if( name == "s" )
386 _attributes_dirty |= TRANSFORM;
393 //----------------------------------------------------------------------------
394 void Element::childRemoved(SGPropertyNode* parent, SGPropertyNode* child)
396 if( parent == _node )
398 if( child->getNameString() == NAME_TRANSFORM )
400 if( !_transform.valid() )
403 if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
409 "Element::childRemoved: unknown transform: " << child->getPath()
414 _transform_types[ child->getIndex() ] = TT_NONE;
416 while( !_transform_types.empty() && _transform_types.back() == TT_NONE )
417 _transform_types.pop_back();
419 _attributes_dirty |= TRANSFORM;
422 else if( StyleInfo const* style = getStyleInfo(child->getNameString()) )
424 if( setStyle(getParentStyle(child), style) )
432 //----------------------------------------------------------------------------
433 void Element::valueChanged(SGPropertyNode* child)
435 SGPropertyNode *parent = child->getParent();
436 if( parent == _node )
438 const std::string& name = child->getNameString();
439 if( boost::starts_with(name, "data-") )
441 else if( StyleInfo const* style_info = getStyleInfo(name) )
443 SGPropertyNode const* style = child;
444 if( isStyleEmpty(child) )
447 style = getParentStyle(child);
449 setStyle(style, style_info);
452 else if( name == "update" )
454 else if( boost::starts_with(name, "blend-") )
455 return (void)(_attributes_dirty |= BLEND_FUNC);
458 && parent->getParent() == _node
459 && parent->getNameString() == NAME_TRANSFORM )
461 _attributes_dirty |= TRANSFORM;
468 //----------------------------------------------------------------------------
469 bool Element::setStyle( const SGPropertyNode* child,
470 const StyleInfo* style_info )
472 return canApplyStyle(child) && setStyleImpl(child, style_info);
475 //----------------------------------------------------------------------------
476 void Element::setClip(const std::string& clip)
478 if( clip.empty() || clip == "auto" )
480 getOrCreateStateSet()->removeAttribute(osg::StateAttribute::SCISSOR);
485 // TODO generalize CSS property parsing
486 const std::string RECT("rect(");
487 if( !boost::ends_with(clip, ")")
488 || !boost::starts_with(clip, RECT) )
490 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
494 const std::string sep(", \t\npx");
498 for(size_t pos = RECT.size(); comp < 4; ++comp)
500 pos = clip.find_first_not_of(sep, pos);
501 if( pos == std::string::npos || pos == clip.size() - 1 )
505 values[comp] = strtod(&clip[pos], &end);
506 if( end == &clip[pos] || !end )
509 pos = end - &clip[0];
514 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
518 float width = values[1] - values[3],
519 height = values[2] - values[0];
521 if( width < 0 || height < 0 )
523 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: negative clip size: " << clip);
527 _scissor = new RelativeScissor();
528 // <top>, <right>, <bottom>, <left>
529 _scissor->x() = SGMiscf::roundToInt(values[3]);
530 _scissor->y() = SGMiscf::roundToInt(values[0]);
531 _scissor->width() = SGMiscf::roundToInt(width);
532 _scissor->height() = SGMiscf::roundToInt(height);
534 getOrCreateStateSet()->setAttributeAndModes(_scissor);
536 SGPropertyNode* clip_frame = _node->getChild("clip-frame", 0);
538 valueChanged(clip_frame);
541 //----------------------------------------------------------------------------
542 void Element::setClipFrame(ReferenceFrame rf)
546 _scissor->_coord_reference = rf;
547 _attributes_dirty |= SCISSOR_COORDS;
551 //----------------------------------------------------------------------------
552 osg::BoundingBox Element::getBoundingBox() const
555 return _drawable->getBound();
559 if( _transform.valid() )
560 bb.expandBy(_transform->getBound());
565 //----------------------------------------------------------------------------
566 osg::BoundingBox Element::getTightBoundingBox() const
568 return getTransformedBounds(getMatrix());
571 //----------------------------------------------------------------------------
572 osg::BoundingBox Element::getTransformedBounds(const osg::Matrix& m) const
575 return osg::BoundingBox();
577 osg::BoundingBox transformed;
578 const osg::BoundingBox& bb = _drawable->getBound();
579 for(int i = 0; i < 4; ++i)
580 transformed.expandBy( bb.corner(i) * m );
585 //----------------------------------------------------------------------------
586 osg::Matrix Element::getMatrix() const
589 return osg::Matrix::identity();
591 if( !(_attributes_dirty & TRANSFORM) )
592 return _transform->getMatrix();
595 for( size_t i = 0; i < _transform_types.size(); ++i )
597 // Skip unused indizes...
598 if( _transform_types[i] == TT_NONE )
601 SGPropertyNode* tf_node = _node->getChild("tf", i, true);
603 // Build up the matrix representation of the current transform node
605 switch( _transform_types[i] )
608 tf = osg::Matrix( tf_node->getDoubleValue("m[0]", 1),
609 tf_node->getDoubleValue("m[1]", 0),
611 tf_node->getDoubleValue("m[6]", 0),
613 tf_node->getDoubleValue("m[2]", 0),
614 tf_node->getDoubleValue("m[3]", 1),
616 tf_node->getDoubleValue("m[7]", 0),
623 tf_node->getDoubleValue("m[4]", 0),
624 tf_node->getDoubleValue("m[5]", 0),
626 tf_node->getDoubleValue("m[8]", 1) );
629 tf.makeTranslate( osg::Vec3f( tf_node->getDoubleValue("t[0]", 0),
630 tf_node->getDoubleValue("t[1]", 0),
634 tf.makeRotate( tf_node->getDoubleValue("rot", 0), 0, 0, 1 );
638 float sx = tf_node->getDoubleValue("s[0]", 1);
639 // sy defaults to sx...
640 tf.makeScale( sx, tf_node->getDoubleValue("s[1]", sx), 1 );
648 _transform->setMatrix(m);
649 _attributes_dirty &= ~TRANSFORM;
650 _attributes_dirty |= SCISSOR_COORDS;
655 //----------------------------------------------------------------------------
656 Element::StyleSetters Element::_style_setters;
658 //----------------------------------------------------------------------------
659 Element::Element( const CanvasWeakPtr& canvas,
660 const SGPropertyNode_ptr& node,
661 const Style& parent_style,
663 PropertyBasedElement(node),
666 _attributes_dirty( 0 ),
667 _transform( new osg::MatrixTransform ),
668 _style( parent_style ),
678 "New canvas element " << node->getPath()
681 // Ensure elements are drawn in order they appear in the element tree
682 _transform->getOrCreateStateSet()
683 ->setRenderBinDetails
687 osg::StateSet::OVERRIDE_RENDERBIN_DETAILS
690 _transform->setUserData( new OSGUserData(this) );
693 //----------------------------------------------------------------------------
694 void Element::staticInit()
696 if( isInit<Element>() )
699 addStyle("clip", "", &Element::setClip, false);
700 addStyle("clip-frame", "", &Element::setClipFrame, false);
701 addStyle("visible", "", &Element::setVisible, false);
704 //----------------------------------------------------------------------------
705 bool Element::isStyleEmpty(const SGPropertyNode* child) const
708 || simgear::strutils::strip(child->getStringValue()).empty();
711 //----------------------------------------------------------------------------
712 bool Element::canApplyStyle(const SGPropertyNode* child) const
714 if( _node == child->getParent() )
717 // Parent values do not override if element has own value
718 return isStyleEmpty( _node->getChild(child->getName()) );
721 //----------------------------------------------------------------------------
722 bool Element::setStyleImpl( const SGPropertyNode* child,
723 const StyleInfo* style_info )
725 const StyleSetter* style_setter = style_info
726 ? &style_info->setter
727 : getStyleSetter(child->getNameString());
728 while( style_setter )
730 if( style_setter->func(*this, child) )
732 style_setter = style_setter->next;
737 //----------------------------------------------------------------------------
738 const Element::StyleInfo*
739 Element::getStyleInfo(const std::string& name) const
741 StyleSetters::const_iterator setter = _style_setters.find(name);
742 if( setter == _style_setters.end() )
745 return &setter->second;
748 //----------------------------------------------------------------------------
749 const Element::StyleSetter*
750 Element::getStyleSetter(const std::string& name) const
752 const StyleInfo* info = getStyleInfo(name);
753 return info ? &info->setter : 0;
756 //----------------------------------------------------------------------------
757 const SGPropertyNode*
758 Element::getParentStyle(const SGPropertyNode* child) const
760 // Try to get value from parent...
763 Style::const_iterator style =
764 _parent->_style.find(child->getNameString());
765 if( style != _parent->_style.end() )
766 return style->second;
769 // ...or reset to default if none is available
770 return child; // TODO somehow get default value for each style?
773 //----------------------------------------------------------------------------
774 void Element::setDrawable( osg::Drawable* drawable )
776 _drawable = drawable;
779 osg::ref_ptr<osg::Geode> geode = new osg::Geode;
780 geode->addDrawable(_drawable);
781 _transform->addChild(geode);
784 //----------------------------------------------------------------------------
785 osg::StateSet* Element::getOrCreateStateSet()
787 return _drawable ? _drawable->getOrCreateStateSet()
788 : _transform->getOrCreateStateSet();
791 //----------------------------------------------------------------------------
792 void Element::setupStyle()
794 BOOST_FOREACH( Style::value_type style, _style )
795 setStyle(style.second);
798 } // namespace canvas
799 } // namespace simgear