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>
25 #include <osg/Drawable>
27 #include <osg/Scissor>
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>
42 const std::string NAME_TRANSFORM = "tf";
44 //----------------------------------------------------------------------------
45 void Element::removeListener()
47 _node->removeChangeListener(this);
50 //----------------------------------------------------------------------------
55 BOOST_FOREACH(osg::Group* parent, _transform->getParents())
57 parent->removeChild(_transform);
61 //----------------------------------------------------------------------------
62 ElementWeakPtr Element::getWeakPtr() const
64 return boost::static_pointer_cast<Element>(_self.lock());
67 //----------------------------------------------------------------------------
68 void Element::update(double dt)
70 if( !_transform->getNodeMask() )
71 // Don't do anything if element is hidden
74 if( _transform_dirty )
77 for( size_t i = 0; i < _transform_types.size(); ++i )
79 // Skip unused indizes...
80 if( _transform_types[i] == TT_NONE )
83 SGPropertyNode* tf_node = _node->getChild("tf", i, true);
85 // Build up the matrix representation of the current transform node
87 switch( _transform_types[i] )
90 tf = osg::Matrix( tf_node->getDoubleValue("m[0]", 1),
91 tf_node->getDoubleValue("m[1]", 0),
93 tf_node->getDoubleValue("m[6]", 0),
95 tf_node->getDoubleValue("m[2]", 0),
96 tf_node->getDoubleValue("m[3]", 1),
98 tf_node->getDoubleValue("m[7]", 0),
105 tf_node->getDoubleValue("m[4]", 0),
106 tf_node->getDoubleValue("m[5]", 0),
108 tf_node->getDoubleValue("m[8]", 1) );
111 tf.makeTranslate( osg::Vec3f( tf_node->getDoubleValue("t[0]", 0),
112 tf_node->getDoubleValue("t[1]", 0),
116 tf.makeRotate( tf_node->getDoubleValue("rot", 0), 0, 0, 1 );
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 );
130 _transform->setMatrix(m);
131 _transform_dirty = false;
134 // Update bounding box on manual update (manual updates pass zero dt)
135 if( dt == 0 && _drawable )
136 _drawable->getBound();
139 //----------------------------------------------------------------------------
140 naRef Element::addEventListener(const nasal::CallContext& ctx)
142 const std::string type_str = ctx.requireArg<std::string>(0);
143 naRef code = ctx.requireArg<naRef>(1);
149 "addEventListener(" << _node->getPath() << ", " << type_str << ")"
152 Event::Type type = Event::strToType(type_str);
153 if( type == Event::UNKNOWN )
154 naRuntimeError( ctx.c,
155 "addEventListener: Unknown event type %s",
158 _listener[ type ].push_back
160 boost::make_shared<EventListener>( code,
161 _canvas.lock()->getSystemAdapter() )
167 //----------------------------------------------------------------------------
168 bool Element::accept(EventVisitor& visitor)
170 return visitor.apply(*this);
173 //----------------------------------------------------------------------------
174 bool Element::ascend(EventVisitor& visitor)
177 return _parent->accept(visitor);
181 //----------------------------------------------------------------------------
182 bool Element::traverse(EventVisitor& visitor)
187 //----------------------------------------------------------------------------
188 bool Element::handleEvent(canvas::EventPtr event)
190 ListenerMap::iterator listeners = _listener.find(event->getType());
191 if( listeners == _listener.end() )
194 BOOST_FOREACH(EventListenerPtr listener, listeners->second)
195 listener->call(event);
200 //----------------------------------------------------------------------------
201 bool Element::hitBound( const osg::Vec2f& pos,
202 const osg::Vec2f& local_pos ) const
204 const osg::Vec3f pos3(pos, 0);
206 // Drawables have a bounding box...
209 if( !_drawable->getBound().contains(osg::Vec3f(local_pos, 0)) )
212 // ... for other elements, i.e. groups only a bounding sphere is available
213 else if( !_transform->getBound().contains(osg::Vec3f(pos, 0)) )
219 //----------------------------------------------------------------------------
220 bool Element::isVisible() const
222 return _transform->getNodeMask() != 0;
225 //----------------------------------------------------------------------------
226 osg::ref_ptr<osg::MatrixTransform> Element::getMatrixTransform()
231 //----------------------------------------------------------------------------
232 void Element::childAdded(SGPropertyNode* parent, SGPropertyNode* child)
235 && child->getNameString() == NAME_TRANSFORM )
237 if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
238 _transform_types.resize( child->getIndex() + 1 );
240 _transform_types[ child->getIndex() ] = TT_NONE;
241 _transform_dirty = true;
244 else if( parent->getParent() == _node
245 && parent->getNameString() == NAME_TRANSFORM )
247 assert(parent->getIndex() < static_cast<int>(_transform_types.size()));
249 const std::string& name = child->getNameString();
251 TransformType& type = _transform_types[parent->getIndex()];
255 else if( name == "t" )
257 else if( name == "rot" )
259 else if( name == "s" )
262 _transform_dirty = true;
269 //----------------------------------------------------------------------------
270 void Element::childRemoved(SGPropertyNode* parent, SGPropertyNode* child)
272 if( parent == _node && child->getNameString() == NAME_TRANSFORM )
274 if( child->getIndex() >= static_cast<int>(_transform_types.size()) )
280 "Element::childRemoved: unknown transform: " << child->getPath()
285 _transform_types[ child->getIndex() ] = TT_NONE;
287 while( !_transform_types.empty() && _transform_types.back() == TT_NONE )
288 _transform_types.pop_back();
290 _transform_dirty = true;
297 //----------------------------------------------------------------------------
298 void Element::valueChanged(SGPropertyNode* child)
300 SGPropertyNode *parent = child->getParent();
301 if( parent == _node )
303 if( setStyle(child) )
305 else if( child->getNameString() == "update" )
307 else if( child->getNameString() == "visible" )
308 // TODO check if we need another nodemask
309 return _transform->setNodeMask( child->getBoolValue() ? 0xffffffff : 0 );
311 else if( parent->getParent() == _node
312 && parent->getNameString() == NAME_TRANSFORM )
314 _transform_dirty = true;
321 //----------------------------------------------------------------------------
322 bool Element::setStyle(const SGPropertyNode* child)
324 StyleSetters::const_iterator setter =
325 _style_setters.find(child->getNameString());
326 if( setter == _style_setters.end() )
329 const StyleSetter* style_setter = &setter->second.setter;
330 while( style_setter )
332 if( style_setter->func(*this, child) )
334 style_setter = style_setter->next;
339 //----------------------------------------------------------------------------
340 void Element::setClip(const std::string& clip)
342 if( clip.empty() || clip == "auto" )
344 getOrCreateStateSet()->removeAttribute(osg::StateAttribute::SCISSOR);
348 // TODO generalize CSS property parsing
349 const std::string RECT("rect(");
350 if( !boost::ends_with(clip, ")")
351 || !boost::starts_with(clip, RECT) )
353 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
357 typedef boost::tokenizer<boost::char_separator<char> > tokenizer;
358 const boost::char_separator<char> del(", \t\npx");
360 tokenizer tokens(clip.begin() + RECT.size(), clip.end() - 1, del);
363 for( tokenizer::const_iterator tok = tokens.begin();
364 tok != tokens.end() && comp < 4;
367 values[comp] = boost::lexical_cast<int>(*tok);
372 SG_LOG(SG_GENERAL, SG_WARN, "Canvas: invalid clip: " << clip);
379 CanvasPtr canvas = _canvas.lock();
382 // The scissor rectangle isn't affected by any transformation, so we need
383 // to convert to image/canvas coordinates on our selves.
384 scale_x = canvas->getSizeX()
385 / static_cast<float>(canvas->getViewWidth());
386 scale_y = canvas->getSizeY()
387 / static_cast<float>(canvas->getViewHeight());
390 osg::Scissor* scissor = new osg::Scissor();
391 // <top>, <right>, <bottom>, <left>
392 scissor->x() = scale_x * values[3];
393 scissor->y() = scale_y * values[0];
394 scissor->width() = scale_x * (values[1] - values[3]);
395 scissor->height() = scale_y * (values[2] - values[0]);
398 // Canvas has y axis upside down
399 scissor->y() = canvas->getSizeY() - scissor->y() - scissor->height();
401 getOrCreateStateSet()->setAttributeAndModes(scissor);
404 //----------------------------------------------------------------------------
405 void Element::setBoundingBox(const osg::BoundingBox& bb)
407 if( _bounding_box.empty() )
409 SGPropertyNode* bb_node = _node->getChild("bounding-box", 0, true);
410 _bounding_box.resize(4);
411 _bounding_box[0] = bb_node->getChild("min-x", 0, true);
412 _bounding_box[1] = bb_node->getChild("min-y", 0, true);
413 _bounding_box[2] = bb_node->getChild("max-x", 0, true);
414 _bounding_box[3] = bb_node->getChild("max-y", 0, true);
417 _bounding_box[0]->setFloatValue(bb._min.x());
418 _bounding_box[1]->setFloatValue(bb._min.y());
419 _bounding_box[2]->setFloatValue(bb._max.x());
420 _bounding_box[3]->setFloatValue(bb._max.y());
423 //----------------------------------------------------------------------------
424 osg::BoundingBox Element::getTransformedBounds(const osg::Matrix& m) const
427 return osg::BoundingBox();
429 osg::BoundingBox transformed;
430 const osg::BoundingBox& bb = _drawable->getBound();
431 for(int i = 0; i < 4; ++i)
432 transformed.expandBy( m * bb.corner(i) );
437 //----------------------------------------------------------------------------
438 Element::StyleSetters Element::_style_setters;
440 //----------------------------------------------------------------------------
441 Element::Element( const CanvasWeakPtr& canvas,
442 const SGPropertyNode_ptr& node,
443 const Style& parent_style,
445 PropertyBasedElement(node),
448 _attributes_dirty( 0 ),
449 _transform_dirty( false ),
450 _transform( new osg::MatrixTransform ),
451 _style( parent_style ),
458 "New canvas element " << node->getPath()
461 if( !isInit<Element>() )
463 addStyle("clip", "", &Element::setClip);
467 //----------------------------------------------------------------------------
468 void Element::setDrawable( osg::Drawable* drawable )
470 _drawable = drawable;
473 osg::ref_ptr<osg::Geode> geode = new osg::Geode;
474 geode->addDrawable(_drawable);
475 _transform->addChild(geode);
478 //----------------------------------------------------------------------------
479 osg::StateSet* Element::getOrCreateStateSet()
481 return _drawable ? _drawable->getOrCreateStateSet()
482 : _transform->getOrCreateStateSet();
485 //----------------------------------------------------------------------------
486 void Element::setupStyle()
488 BOOST_FOREACH( Style::value_type style, _style )
489 setStyle(style.second);
492 } // namespace canvas
493 } // namespace simgear