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/CanvasEventListener.hxx>
22 #include <simgear/canvas/CanvasEventVisitor.hxx>
23 #include <simgear/canvas/MouseEvent.hxx>
24 #include <simgear/math/SGMisc.hxx>
25 #include <simgear/misc/strutils.hxx>
26 #include <simgear/scene/material/parseBlendFunc.hxx>
28 #include <osg/Drawable>
30 #include <osg/Scissor>
32 #include <boost/algorithm/string/predicate.hpp>
33 #include <boost/foreach.hpp>
34 #include <boost/make_shared.hpp>
43 const std::string NAME_TRANSFORM = "tf";
45 //----------------------------------------------------------------------------
46 Element::OSGUserData::OSGUserData(ElementPtr element):
52 //----------------------------------------------------------------------------
58 //----------------------------------------------------------------------------
59 void Element::setSelf(const PropertyBasedElementPtr& self)
61 PropertyBasedElement::setSelf(self);
63 _transform->setUserData
65 new OSGUserData(boost::static_pointer_cast<Element>(self))
69 //----------------------------------------------------------------------------
70 void Element::onDestroy()
72 if( !_transform.valid() )
75 // The transform node keeps a reference on this element, so ensure it is
77 BOOST_FOREACH(osg::Group* parent, _transform->getParents())
79 parent->removeChild(_transform.get());
83 //----------------------------------------------------------------------------
84 ElementWeakPtr Element::getWeakPtr() const
86 return boost::static_pointer_cast<Element>(_self.lock());
89 //----------------------------------------------------------------------------
90 void Element::update(double dt)
92 if( !_transform->getNodeMask() )
93 // Don't do anything if element is hidden
96 if( _transform_dirty )
99 for( size_t i = 0; i < _transform_types.size(); ++i )
101 // Skip unused indizes...
102 if( _transform_types[i] == TT_NONE )
105 SGPropertyNode* tf_node = _node->getChild("tf", i, true);
107 // Build up the matrix representation of the current transform node
109 switch( _transform_types[i] )
112 tf = osg::Matrix( tf_node->getDoubleValue("m[0]", 1),
113 tf_node->getDoubleValue("m[1]", 0),
115 tf_node->getDoubleValue("m[6]", 0),
117 tf_node->getDoubleValue("m[2]", 0),
118 tf_node->getDoubleValue("m[3]", 1),
120 tf_node->getDoubleValue("m[7]", 0),
127 tf_node->getDoubleValue("m[4]", 0),
128 tf_node->getDoubleValue("m[5]", 0),
130 tf_node->getDoubleValue("m[8]", 1) );
133 tf.makeTranslate( osg::Vec3f( tf_node->getDoubleValue("t[0]", 0),
134 tf_node->getDoubleValue("t[1]", 0),
138 tf.makeRotate( tf_node->getDoubleValue("rot", 0), 0, 0, 1 );
142 float sx = tf_node->getDoubleValue("s[0]", 1);
143 // sy defaults to sx...
144 tf.makeScale( sx, tf_node->getDoubleValue("s[1]", sx), 1 );
152 _transform->setMatrix(m);
153 _transform_dirty = false;
156 // Update bounding box on manual update (manual updates pass zero dt)
157 if( dt == 0 && _drawable )
158 _drawable->getBound();
160 if( _attributes_dirty & BLEND_FUNC )
163 _transform->getOrCreateStateSet(),
164 _node->getChild("blend-source"),
165 _node->getChild("blend-destination"),
166 _node->getChild("blend-source-rgb"),
167 _node->getChild("blend-destination-rgb"),
168 _node->getChild("blend-source-alpha"),
169 _node->getChild("blend-destination-alpha")
171 _attributes_dirty &= ~BLEND_FUNC;
175 //----------------------------------------------------------------------------
176 naRef Element::addEventListener(const nasal::CallContext& ctx)
178 const std::string type_str = ctx.requireArg<std::string>(0);
179 naRef code = ctx.requireArg<naRef>(1);
185 "addEventListener(" << _node->getPath() << ", " << type_str << ")"
188 Event::Type type = Event::strToType(type_str);
189 if( type == Event::UNKNOWN )
190 naRuntimeError( ctx.c,
191 "addEventListener: Unknown event type %s",
194 _listener[ type ].push_back
196 boost::make_shared<EventListener>( code,
197 _canvas.lock()->getSystemAdapter() )
203 //----------------------------------------------------------------------------
204 void Element::clearEventListener()
209 //----------------------------------------------------------------------------
210 bool Element::accept(EventVisitor& visitor)
215 return visitor.apply(*this);
218 //----------------------------------------------------------------------------
219 bool Element::ascend(EventVisitor& visitor)
222 return _parent->accept(visitor);
226 //----------------------------------------------------------------------------
227 bool Element::traverse(EventVisitor& visitor)
232 //----------------------------------------------------------------------------
233 bool Element::handleEvent(canvas::EventPtr event)
235 ListenerMap::iterator listeners = _listener.find(event->getType());
236 if( listeners == _listener.end() )
239 BOOST_FOREACH(EventListenerPtr listener, listeners->second)
240 listener->call(event);
245 //----------------------------------------------------------------------------
246 bool Element::hitBound( const osg::Vec2f& pos,
247 const osg::Vec2f& local_pos ) const
249 const osg::Vec3f pos3(pos, 0);
251 // Drawables have a bounding box...
253 return _drawable->getBound().contains(osg::Vec3f(local_pos, 0));
254 // ... for other elements, i.e. groups only a bounding sphere is available
256 return _transform->getBound().contains(osg::Vec3f(pos, 0));
259 //----------------------------------------------------------------------------
260 bool Element::isVisible() const
262 return _transform.valid() && _transform->getNodeMask() != 0;
265 //----------------------------------------------------------------------------
266 osg::MatrixTransform* Element::getMatrixTransform()
268 return _transform.get();
271 //----------------------------------------------------------------------------
272 osg::MatrixTransform const* Element::getMatrixTransform() const
274 return _transform.get();
277 //----------------------------------------------------------------------------
278 void Element::childAdded(SGPropertyNode* parent, SGPropertyNode* child)
281 && child->getNameString() == NAME_TRANSFORM )
283 if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
284 _transform_types.resize( child->getIndex() + 1 );
286 _transform_types[ child->getIndex() ] = TT_NONE;
287 _transform_dirty = true;
290 else if( parent->getParent() == _node
291 && parent->getNameString() == NAME_TRANSFORM )
293 assert(parent->getIndex() < static_cast<int>(_transform_types.size()));
295 const std::string& name = child->getNameString();
297 TransformType& type = _transform_types[parent->getIndex()];
301 else if( name == "t" )
303 else if( name == "rot" )
305 else if( name == "s" )
308 _transform_dirty = true;
315 //----------------------------------------------------------------------------
316 void Element::childRemoved(SGPropertyNode* parent, SGPropertyNode* child)
318 if( parent == _node )
320 if( child->getNameString() == NAME_TRANSFORM )
322 if( !_transform.valid() )
325 if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
331 "Element::childRemoved: unknown transform: " << child->getPath()
336 _transform_types[ child->getIndex() ] = TT_NONE;
338 while( !_transform_types.empty() && _transform_types.back() == TT_NONE )
339 _transform_types.pop_back();
341 _transform_dirty = true;
344 else if( StyleInfo const* style = getStyleInfo(child->getNameString()) )
346 if( setStyle(getParentStyle(child), style) )
354 //----------------------------------------------------------------------------
355 void Element::valueChanged(SGPropertyNode* child)
357 SGPropertyNode *parent = child->getParent();
358 if( parent == _node )
360 const std::string& name = child->getNameString();
361 if( StyleInfo const* style_info = getStyleInfo(name) )
363 SGPropertyNode const* style = child;
364 if( isStyleEmpty(child) )
367 style = getParentStyle(child);
369 setStyle(style, style_info);
372 else if( name == "update" )
374 else if( name == "visible" )
375 // TODO check if we need another nodemask
376 return _transform->setNodeMask( child->getBoolValue() ? 0xffffffff : 0 );
377 else if( boost::starts_with(name, "blend-") )
378 return (void)(_attributes_dirty |= BLEND_FUNC);
380 else if( parent->getParent() == _node
381 && parent->getNameString() == NAME_TRANSFORM )
383 _transform_dirty = true;
390 //----------------------------------------------------------------------------
391 bool Element::setStyle( const SGPropertyNode* child,
392 const StyleInfo* style_info )
394 return canApplyStyle(child) && setStyleImpl(child, style_info);
397 //----------------------------------------------------------------------------
398 void Element::setClip(const std::string& clip)
400 if( clip.empty() || clip == "auto" )
402 getOrCreateStateSet()->removeAttribute(osg::StateAttribute::SCISSOR);
406 // TODO generalize CSS property parsing
407 const std::string RECT("rect(");
408 if( !boost::ends_with(clip, ")")
409 || !boost::starts_with(clip, RECT) )
411 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
415 const std::string sep(", \t\npx");
419 for(size_t pos = RECT.size(); comp < 4; ++comp)
421 pos = clip.find_first_not_of(sep, pos);
422 if( pos == std::string::npos || pos == clip.size() - 1 )
426 values[comp] = strtod(&clip[pos], &end);
427 if( end == &clip[pos] || !end )
430 pos = end - &clip[0];
435 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
439 float width = values[1] - values[3],
440 height = values[2] - values[0];
442 if( width < 0 || height < 0 )
444 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: negative clip size: " << clip);
451 CanvasPtr canvas = _canvas.lock();
454 // The scissor rectangle isn't affected by any transformation, so we need
455 // to convert to image/canvas coordinates on our selves.
456 scale_x = canvas->getSizeX()
457 / static_cast<float>(canvas->getViewWidth());
458 scale_y = canvas->getSizeY()
459 / static_cast<float>(canvas->getViewHeight());
462 osg::Scissor* scissor = new osg::Scissor();
463 // <top>, <right>, <bottom>, <left>
464 scissor->x() = SGMiscf::roundToInt(scale_x * values[3]);
465 scissor->y() = SGMiscf::roundToInt(scale_y * values[0]);
466 scissor->width() = SGMiscf::roundToInt(scale_x * width);
467 scissor->height() = SGMiscf::roundToInt(scale_y * height);
470 // Canvas has y axis upside down
471 scissor->y() = canvas->getSizeY() - scissor->y() - scissor->height();
473 getOrCreateStateSet()->setAttributeAndModes(scissor);
476 //----------------------------------------------------------------------------
477 void Element::setBoundingBox(const osg::BoundingBox& bb)
479 if( _bounding_box.empty() )
481 SGPropertyNode* bb_node = _node->getChild("bounding-box", 0, true);
482 _bounding_box.resize(4);
483 _bounding_box[0] = bb_node->getChild("min-x", 0, true);
484 _bounding_box[1] = bb_node->getChild("min-y", 0, true);
485 _bounding_box[2] = bb_node->getChild("max-x", 0, true);
486 _bounding_box[3] = bb_node->getChild("max-y", 0, true);
489 _bounding_box[0]->setFloatValue(bb._min.x());
490 _bounding_box[1]->setFloatValue(bb._min.y());
491 _bounding_box[2]->setFloatValue(bb._max.x());
492 _bounding_box[3]->setFloatValue(bb._max.y());
495 //----------------------------------------------------------------------------
496 osg::BoundingBox Element::getTransformedBounds(const osg::Matrix& m) const
499 return osg::BoundingBox();
501 osg::BoundingBox transformed;
502 const osg::BoundingBox& bb = _drawable->getBound();
503 for(int i = 0; i < 4; ++i)
504 transformed.expandBy( bb.corner(i) * m );
509 //----------------------------------------------------------------------------
510 Element::StyleSetters Element::_style_setters;
512 //----------------------------------------------------------------------------
513 Element::Element( const CanvasWeakPtr& canvas,
514 const SGPropertyNode_ptr& node,
515 const Style& parent_style,
517 PropertyBasedElement(node),
520 _attributes_dirty( 0 ),
521 _transform_dirty( false ),
522 _transform( new osg::MatrixTransform ),
523 _style( parent_style ),
532 "New canvas element " << node->getPath()
535 // Ensure elements are drawn in order they appear in the element tree
536 _transform->getOrCreateStateSet()
537 ->setRenderBinDetails
541 osg::StateSet::OVERRIDE_RENDERBIN_DETAILS
545 //----------------------------------------------------------------------------
546 void Element::staticInit()
548 if( isInit<Element>() )
551 addStyle("clip", "", &Element::setClip, false);
554 //----------------------------------------------------------------------------
555 bool Element::isStyleEmpty(const SGPropertyNode* child) const
558 || simgear::strutils::strip(child->getStringValue()).empty();
561 //----------------------------------------------------------------------------
562 bool Element::canApplyStyle(const SGPropertyNode* child) const
564 if( _node == child->getParent() )
567 // Parent values do not override if element has own value
568 return isStyleEmpty( _node->getChild(child->getName()) );
571 //----------------------------------------------------------------------------
572 bool Element::setStyleImpl( const SGPropertyNode* child,
573 const StyleInfo* style_info )
575 const StyleSetter* style_setter = style_info
576 ? &style_info->setter
577 : getStyleSetter(child->getNameString());
578 while( style_setter )
580 if( style_setter->func(*this, child) )
582 style_setter = style_setter->next;
587 //----------------------------------------------------------------------------
588 const Element::StyleInfo*
589 Element::getStyleInfo(const std::string& name) const
591 StyleSetters::const_iterator setter = _style_setters.find(name);
592 if( setter == _style_setters.end() )
595 return &setter->second;
598 //----------------------------------------------------------------------------
599 const Element::StyleSetter*
600 Element::getStyleSetter(const std::string& name) const
602 const StyleInfo* info = getStyleInfo(name);
603 return info ? &info->setter : 0;
606 //----------------------------------------------------------------------------
607 const SGPropertyNode*
608 Element::getParentStyle(const SGPropertyNode* child) const
610 // Try to get value from parent...
613 Style::const_iterator style =
614 _parent->_style.find(child->getNameString());
615 if( style != _parent->_style.end() )
616 return style->second;
619 // ...or reset to default if none is available
620 return child; // TODO somehow get default value for each style?
623 //----------------------------------------------------------------------------
624 void Element::setDrawable( osg::Drawable* drawable )
626 _drawable = drawable;
629 osg::ref_ptr<osg::Geode> geode = new osg::Geode;
630 geode->addDrawable(_drawable);
631 _transform->addChild(geode);
634 //----------------------------------------------------------------------------
635 osg::StateSet* Element::getOrCreateStateSet()
637 return _drawable ? _drawable->getOrCreateStateSet()
638 : _transform->getOrCreateStateSet();
641 //----------------------------------------------------------------------------
642 void Element::setupStyle()
644 BOOST_FOREACH( Style::value_type style, _style )
645 setStyle(style.second);
648 } // namespace canvas
649 } // namespace simgear