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/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>
26 #include <osg/Drawable>
28 #include <osg/Scissor>
30 #include <boost/algorithm/string/predicate.hpp>
31 #include <boost/foreach.hpp>
32 #include <boost/make_shared.hpp>
42 const std::string NAME_TRANSFORM = "tf";
45 * glScissor with coordinates relative to different reference frames.
47 class Element::RelativeScissor:
52 ReferenceFrame _coord_reference;
53 osg::Matrix _parent_inverse;
56 _coord_reference(GLOBAL)
59 virtual void apply(osg::State& state) const
61 const osg::Viewport* vp = state.getCurrentViewport();
62 float w2 = 0.5 * vp->width(),
63 h2 = 0.5 * vp->height();
65 osg::Matrix model_view
72 model_view.preMult(state.getProjectionMatrix());
74 if( _coord_reference != GLOBAL )
76 model_view.preMult(state.getModelViewMatrix());
78 if( _coord_reference == PARENT )
79 model_view.preMult(_parent_inverse);
82 const osg::Vec2 scale( model_view(0,0), model_view(1,1)),
83 offset(model_view(3,0), model_view(3,1));
85 // TODO check/warn for rotation?
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);
97 glScissor(x, y, w, h);
101 //----------------------------------------------------------------------------
102 Element::OSGUserData::OSGUserData(ElementPtr element):
108 //----------------------------------------------------------------------------
111 if( !_transform.valid() )
114 for(unsigned int i = 0; i < _transform->getNumChildren(); ++i)
117 static_cast<OSGUserData*>(_transform->getChild(i)->getUserData());
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;
126 //----------------------------------------------------------------------------
127 void Element::setSelf(const PropertyBasedElementPtr& self)
129 PropertyBasedElement::setSelf(self);
131 _transform->setUserData
133 new OSGUserData(boost::static_pointer_cast<Element>(self))
137 //----------------------------------------------------------------------------
138 void Element::onDestroy()
140 if( !_transform.valid() )
143 // The transform node keeps a reference on this element, so ensure it is
145 BOOST_FOREACH(osg::Group* parent, _transform->getParents())
147 parent->removeChild(_transform.get());
151 //----------------------------------------------------------------------------
152 ElementWeakPtr Element::getWeakPtr() const
154 return boost::static_pointer_cast<Element>(_self.lock());
157 //----------------------------------------------------------------------------
158 ElementPtr Element::getParent()
160 return _parent ? _parent->getWeakPtr().lock() : ElementPtr();
163 //----------------------------------------------------------------------------
164 void Element::update(double dt)
166 if( !_transform->getNodeMask() )
167 // Don't do anything if element is hidden
170 if( _transform_dirty )
173 for( size_t i = 0; i < _transform_types.size(); ++i )
175 // Skip unused indizes...
176 if( _transform_types[i] == TT_NONE )
179 SGPropertyNode* tf_node = _node->getChild("tf", i, true);
181 // Build up the matrix representation of the current transform node
183 switch( _transform_types[i] )
186 tf = osg::Matrix( tf_node->getDoubleValue("m[0]", 1),
187 tf_node->getDoubleValue("m[1]", 0),
189 tf_node->getDoubleValue("m[6]", 0),
191 tf_node->getDoubleValue("m[2]", 0),
192 tf_node->getDoubleValue("m[3]", 1),
194 tf_node->getDoubleValue("m[7]", 0),
201 tf_node->getDoubleValue("m[4]", 0),
202 tf_node->getDoubleValue("m[5]", 0),
204 tf_node->getDoubleValue("m[8]", 1) );
207 tf.makeTranslate( osg::Vec3f( tf_node->getDoubleValue("t[0]", 0),
208 tf_node->getDoubleValue("t[1]", 0),
212 tf.makeRotate( tf_node->getDoubleValue("rot", 0), 0, 0, 1 );
216 float sx = tf_node->getDoubleValue("s[0]", 1);
217 // sy defaults to sx...
218 tf.makeScale( sx, tf_node->getDoubleValue("s[1]", sx), 1 );
226 _transform->setMatrix(m);
227 _transform_dirty = false;
228 _attributes_dirty |= SCISSOR_COORDS;
231 if( _attributes_dirty & SCISSOR_COORDS )
233 if( _scissor && _scissor->_coord_reference != GLOBAL )
234 _scissor->_parent_inverse = _transform->getInverseMatrix();
236 _attributes_dirty &= ~SCISSOR_COORDS;
239 // Update bounding box on manual update (manual updates pass zero dt)
240 if( dt == 0 && _drawable )
241 _drawable->getBound();
243 if( _attributes_dirty & BLEND_FUNC )
246 _transform->getOrCreateStateSet(),
247 _node->getChild("blend-source"),
248 _node->getChild("blend-destination"),
249 _node->getChild("blend-source-rgb"),
250 _node->getChild("blend-destination-rgb"),
251 _node->getChild("blend-source-alpha"),
252 _node->getChild("blend-destination-alpha")
254 _attributes_dirty &= ~BLEND_FUNC;
258 //----------------------------------------------------------------------------
259 bool Element::addEventListener( const std::string& type_str,
260 const EventListener& cb )
266 "addEventListener(" << _node->getPath() << ", " << type_str << ")"
269 Event::Type type = Event::strToType(type_str);
270 if( type == Event::UNKNOWN )
274 "addEventListener: Unknown event type " << type_str );
278 _listener[ type ].push_back(cb);
283 //----------------------------------------------------------------------------
284 void Element::clearEventListener()
289 //----------------------------------------------------------------------------
290 bool Element::accept(EventVisitor& visitor)
295 return visitor.apply(*this);
298 //----------------------------------------------------------------------------
299 bool Element::ascend(EventVisitor& visitor)
302 return _parent->accept(visitor);
306 //----------------------------------------------------------------------------
307 bool Element::traverse(EventVisitor& visitor)
312 //----------------------------------------------------------------------------
313 bool Element::handleEvent(canvas::EventPtr event)
315 ListenerMap::iterator listeners = _listener.find(event->getType());
316 if( listeners == _listener.end() )
319 BOOST_FOREACH(EventListener const& listener, listeners->second)
325 //----------------------------------------------------------------------------
326 bool Element::hitBound( const osg::Vec2f& pos,
327 const osg::Vec2f& local_pos ) const
329 const osg::Vec3f pos3(pos, 0);
331 // Drawables have a bounding box...
333 return _drawable->getBound().contains(osg::Vec3f(local_pos, 0));
334 // ... for other elements, i.e. groups only a bounding sphere is available
336 return _transform->getBound().contains(osg::Vec3f(pos, 0));
339 //----------------------------------------------------------------------------
340 bool Element::isVisible() const
342 return _transform.valid() && _transform->getNodeMask() != 0;
345 //----------------------------------------------------------------------------
346 osg::MatrixTransform* Element::getMatrixTransform()
348 return _transform.get();
351 //----------------------------------------------------------------------------
352 osg::MatrixTransform const* Element::getMatrixTransform() const
354 return _transform.get();
357 //----------------------------------------------------------------------------
358 void Element::childAdded(SGPropertyNode* parent, SGPropertyNode* child)
361 && child->getNameString() == NAME_TRANSFORM )
363 if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
364 _transform_types.resize( child->getIndex() + 1 );
366 _transform_types[ child->getIndex() ] = TT_NONE;
367 _transform_dirty = true;
370 else if( parent->getParent() == _node
371 && parent->getNameString() == NAME_TRANSFORM )
373 assert(parent->getIndex() < static_cast<int>(_transform_types.size()));
375 const std::string& name = child->getNameString();
377 TransformType& type = _transform_types[parent->getIndex()];
381 else if( name == "t" )
383 else if( name == "rot" )
385 else if( name == "s" )
388 _transform_dirty = true;
395 //----------------------------------------------------------------------------
396 void Element::childRemoved(SGPropertyNode* parent, SGPropertyNode* child)
398 if( parent == _node )
400 if( child->getNameString() == NAME_TRANSFORM )
402 if( !_transform.valid() )
405 if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
411 "Element::childRemoved: unknown transform: " << child->getPath()
416 _transform_types[ child->getIndex() ] = TT_NONE;
418 while( !_transform_types.empty() && _transform_types.back() == TT_NONE )
419 _transform_types.pop_back();
421 _transform_dirty = true;
424 else if( StyleInfo const* style = getStyleInfo(child->getNameString()) )
426 if( setStyle(getParentStyle(child), style) )
434 //----------------------------------------------------------------------------
435 void Element::valueChanged(SGPropertyNode* child)
437 SGPropertyNode *parent = child->getParent();
438 if( parent == _node )
440 const std::string& name = child->getNameString();
441 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( name == "visible" )
455 // TODO check if we need another nodemask
456 return _transform->setNodeMask( child->getBoolValue() ? 0xffffffff : 0 );
457 else if( boost::starts_with(name, "blend-") )
458 return (void)(_attributes_dirty |= BLEND_FUNC);
460 else if( parent->getParent() == _node
461 && parent->getNameString() == NAME_TRANSFORM )
463 _transform_dirty = true;
470 //----------------------------------------------------------------------------
471 bool Element::setStyle( const SGPropertyNode* child,
472 const StyleInfo* style_info )
474 return canApplyStyle(child) && setStyleImpl(child, style_info);
477 //----------------------------------------------------------------------------
478 void Element::setClip(const std::string& clip)
480 if( clip.empty() || clip == "auto" )
482 getOrCreateStateSet()->removeAttribute(osg::StateAttribute::SCISSOR);
487 // TODO generalize CSS property parsing
488 const std::string RECT("rect(");
489 if( !boost::ends_with(clip, ")")
490 || !boost::starts_with(clip, RECT) )
492 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
496 const std::string sep(", \t\npx");
500 for(size_t pos = RECT.size(); comp < 4; ++comp)
502 pos = clip.find_first_not_of(sep, pos);
503 if( pos == std::string::npos || pos == clip.size() - 1 )
507 values[comp] = strtod(&clip[pos], &end);
508 if( end == &clip[pos] || !end )
511 pos = end - &clip[0];
516 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
520 float width = values[1] - values[3],
521 height = values[2] - values[0];
523 if( width < 0 || height < 0 )
525 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: negative clip size: " << clip);
529 _scissor = new RelativeScissor();
530 // <top>, <right>, <bottom>, <left>
531 _scissor->x() = SGMiscf::roundToInt(values[3]);
532 _scissor->y() = SGMiscf::roundToInt(values[0]);
533 _scissor->width() = SGMiscf::roundToInt(width);
534 _scissor->height() = SGMiscf::roundToInt(height);
536 getOrCreateStateSet()->setAttributeAndModes(_scissor);
538 SGPropertyNode* clip_frame = _node->getChild("clip-frame", 0);
540 valueChanged(clip_frame);
543 //----------------------------------------------------------------------------
544 void Element::setClipFrame(ReferenceFrame rf)
548 _scissor->_coord_reference = rf;
549 _attributes_dirty |= SCISSOR_COORDS;
553 //----------------------------------------------------------------------------
554 void Element::setBoundingBox(const osg::BoundingBox& bb)
556 if( _bounding_box.empty() )
558 SGPropertyNode* bb_node = _node->getChild("bounding-box", 0, true);
559 _bounding_box.resize(4);
560 _bounding_box[0] = bb_node->getChild("min-x", 0, true);
561 _bounding_box[1] = bb_node->getChild("min-y", 0, true);
562 _bounding_box[2] = bb_node->getChild("max-x", 0, true);
563 _bounding_box[3] = bb_node->getChild("max-y", 0, true);
566 _bounding_box[0]->setFloatValue(bb._min.x());
567 _bounding_box[1]->setFloatValue(bb._min.y());
568 _bounding_box[2]->setFloatValue(bb._max.x());
569 _bounding_box[3]->setFloatValue(bb._max.y());
572 //----------------------------------------------------------------------------
573 osg::BoundingBox Element::getTransformedBounds(const osg::Matrix& m) const
576 return osg::BoundingBox();
578 osg::BoundingBox transformed;
579 const osg::BoundingBox& bb = _drawable->getBound();
580 for(int i = 0; i < 4; ++i)
581 transformed.expandBy( bb.corner(i) * m );
586 //----------------------------------------------------------------------------
587 Element::StyleSetters Element::_style_setters;
589 //----------------------------------------------------------------------------
590 Element::Element( const CanvasWeakPtr& canvas,
591 const SGPropertyNode_ptr& node,
592 const Style& parent_style,
594 PropertyBasedElement(node),
597 _attributes_dirty( 0 ),
598 _transform_dirty( false ),
599 _transform( new osg::MatrixTransform ),
600 _style( parent_style ),
610 "New canvas element " << node->getPath()
613 // Ensure elements are drawn in order they appear in the element tree
614 _transform->getOrCreateStateSet()
615 ->setRenderBinDetails
619 osg::StateSet::OVERRIDE_RENDERBIN_DETAILS
623 //----------------------------------------------------------------------------
624 void Element::staticInit()
626 if( isInit<Element>() )
629 addStyle("clip", "", &Element::setClip, false);
630 addStyle("clip-frame", "", &Element::setClipFrame, false);
633 //----------------------------------------------------------------------------
634 bool Element::isStyleEmpty(const SGPropertyNode* child) const
637 || simgear::strutils::strip(child->getStringValue()).empty();
640 //----------------------------------------------------------------------------
641 bool Element::canApplyStyle(const SGPropertyNode* child) const
643 if( _node == child->getParent() )
646 // Parent values do not override if element has own value
647 return isStyleEmpty( _node->getChild(child->getName()) );
650 //----------------------------------------------------------------------------
651 bool Element::setStyleImpl( const SGPropertyNode* child,
652 const StyleInfo* style_info )
654 const StyleSetter* style_setter = style_info
655 ? &style_info->setter
656 : getStyleSetter(child->getNameString());
657 while( style_setter )
659 if( style_setter->func(*this, child) )
661 style_setter = style_setter->next;
666 //----------------------------------------------------------------------------
667 const Element::StyleInfo*
668 Element::getStyleInfo(const std::string& name) const
670 StyleSetters::const_iterator setter = _style_setters.find(name);
671 if( setter == _style_setters.end() )
674 return &setter->second;
677 //----------------------------------------------------------------------------
678 const Element::StyleSetter*
679 Element::getStyleSetter(const std::string& name) const
681 const StyleInfo* info = getStyleInfo(name);
682 return info ? &info->setter : 0;
685 //----------------------------------------------------------------------------
686 const SGPropertyNode*
687 Element::getParentStyle(const SGPropertyNode* child) const
689 // Try to get value from parent...
692 Style::const_iterator style =
693 _parent->_style.find(child->getNameString());
694 if( style != _parent->_style.end() )
695 return style->second;
698 // ...or reset to default if none is available
699 return child; // TODO somehow get default value for each style?
702 //----------------------------------------------------------------------------
703 void Element::setDrawable( osg::Drawable* drawable )
705 _drawable = drawable;
708 osg::ref_ptr<osg::Geode> geode = new osg::Geode;
709 geode->addDrawable(_drawable);
710 _transform->addChild(geode);
713 //----------------------------------------------------------------------------
714 osg::StateSet* Element::getOrCreateStateSet()
716 return _drawable ? _drawable->getOrCreateStateSet()
717 : _transform->getOrCreateStateSet();
720 //----------------------------------------------------------------------------
721 void Element::setupStyle()
723 BOOST_FOREACH( Style::value_type style, _style )
724 setStyle(style.second);
727 } // namespace canvas
728 } // namespace simgear