1 // Interface for 2D Canvas elements
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 #ifndef CANVAS_ELEMENT_HXX_
20 #define CANVAS_ELEMENT_HXX_
22 #include <simgear/canvas/canvas_fwd.hxx>
23 #include <simgear/canvas/CanvasEvent.hxx>
24 #include <simgear/props/PropertyBasedElement.hxx>
25 #include <simgear/misc/stdint.hxx> // for uint32_t
26 #include <simgear/nasal/cppbind/Ghost.hxx>
28 #include <osg/BoundingBox>
29 #include <osg/MatrixTransform>
31 #include <boost/bind.hpp>
32 #include <boost/function.hpp>
45 public PropertyBasedElement
50 * Store pointer to window as user data
53 public osg::Referenced
57 OSGUserData(ElementPtr element);
60 typedef boost::function<bool(Element&, const SGPropertyNode*)>
62 typedef boost::function<void(Element&, const SGPropertyNode*)>
63 StyleSetterFuncUnchecked;
68 SGSharedPtr<StyleSetter> next;
72 StyleSetter setter; ///!< Function(s) for setting this style
73 std::string type; ///!< Interpolation type
79 virtual ~Element() = 0;
81 virtual void setSelf(const PropertyBasedElementPtr& self);
82 virtual void onDestroy();
84 ElementWeakPtr getWeakPtr() const;
87 * Called every frame to update internal state
89 * @param dt Frame time in seconds
91 virtual void update(double dt);
93 naRef addEventListener(const nasal::CallContext& ctx);
94 virtual void clearEventListener();
96 virtual bool accept(EventVisitor& visitor);
97 virtual bool ascend(EventVisitor& visitor);
98 virtual bool traverse(EventVisitor& visitor);
100 virtual bool handleEvent(canvas::EventPtr event);
102 virtual bool hitBound( const osg::Vec2f& pos,
103 const osg::Vec2f& local_pos ) const;
106 * Get whether the element is visible or hidden (Can be changed with
107 * setting property "visible" accordingly).
109 bool isVisible() const;
111 osg::MatrixTransform* getMatrixTransform();
112 osg::MatrixTransform const* getMatrixTransform() const;
114 virtual void childAdded( SGPropertyNode * parent,
115 SGPropertyNode * child );
116 virtual void childRemoved( SGPropertyNode * parent,
117 SGPropertyNode * child );
118 virtual void valueChanged(SGPropertyNode * child);
120 virtual bool setStyle(const SGPropertyNode* child);
125 * @note Only "rect(<top>, <right>, <bottom>, <left>)" is supported
126 * @see http://www.w3.org/TR/CSS21/visufx.html#propdef-clip
128 void setClip(const std::string& clip);
131 * Write the given bounding box to the property tree
133 void setBoundingBox(const osg::BoundingBox& bb);
136 * Get bounding box with children/drawables transformed by passed matrix
138 virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
141 * Create an canvas Element
143 * @tparam Derived Type of element (needs to derive from Element)
145 template<typename Derived>
147 typename boost::enable_if<
148 boost::is_base_of<Element, Derived>,
150 >::type create( const CanvasWeakPtr& canvas,
151 const SGPropertyNode_ptr& node,
155 ElementPtr el( new Derived(canvas, node, style, parent) );
165 LAST_ATTRIBUTE = BLEND_FUNC << 1
177 CanvasWeakPtr _canvas;
180 uint32_t _attributes_dirty;
182 bool _transform_dirty;
183 osg::observer_ptr<osg::MatrixTransform> _transform;
184 std::vector<TransformType> _transform_types;
187 std::vector<SGPropertyNode_ptr> _bounding_box;
189 typedef std::vector<EventListenerPtr> Listener;
190 typedef std::map<Event::Type, Listener> ListenerMap;
192 ListenerMap _listener;
194 typedef std::map<std::string, StyleInfo> StyleSetters;
195 static StyleSetters _style_setters;
197 Element( const CanvasWeakPtr& canvas,
198 const SGPropertyNode_ptr& node,
199 const Style& parent_style,
203 * Returns false on first call and true on any successive call. Use to
204 * perform initialization tasks which are only required once per element
207 * @tparam Derived (Derived) class type
209 template<class Derived>
212 static bool is_init = false;
221 * Register a function for setting a style specified by the given property
223 * @param name Property name
224 * @param type Interpolation type
225 * @param setter Setter function
227 * @tparam T1 Type of value used to retrieve value from property
229 * @tparam T2 Type of value the setter function expects
230 * @tparam Derived Type of class the setter can be applied to
232 * @note T1 needs to be convertible to T2
240 addStyle( const std::string& name,
241 const std::string& type,
242 const boost::function<void (Derived&, T2)>& setter )
244 StyleInfo& style_info = _style_setters[ name ];
247 if( !style_info.type.empty() && type != style_info.type )
252 "changing animation type for '" << name << "': "
253 << style_info.type << " -> " << type
256 style_info.type = type;
259 StyleSetter* style = &style_info.setter;
263 style = style->next = new StyleSetter;
265 style->func = boost::bind
267 &type_match<Derived>::call,
270 bindStyleSetter<T1>(name, setter)
280 addStyle( const std::string& name,
281 const std::string& type,
282 const boost::function<void (Derived&, T)>& setter )
284 return addStyle<T, T>(name, type, setter);
292 addStyle( const std::string& name,
293 const std::string& type,
294 void (Derived::*setter)(T) )
296 return addStyle<T, T>
300 boost::function<void (Derived&, T)>(setter)
310 addStyle( const std::string& name,
311 const std::string& type,
312 void (Derived::*setter)(T2) )
318 boost::function<void (Derived&, T2)>(setter)
326 addStyle( const std::string& name,
327 const std::string& type,
328 void (Derived::*setter)(const std::string&) )
330 return addStyle<const char*, const std::string&>
334 boost::function<void (Derived&, const std::string&)>(setter)
345 addStyle( const std::string& name,
346 const std::string& type,
347 void (Other::*setter)(T),
348 OtherRef Derived::*instance_ref )
350 return addStyle<T, T>(name, type, bindOther(setter, instance_ref));
361 addStyle( const std::string& name,
362 const std::string& type,
363 void (Other::*setter)(T2),
364 OtherRef Derived::*instance_ref )
366 return addStyle<T1>(name, type, bindOther(setter, instance_ref));
377 addStyle( const std::string& name,
378 const std::string& type,
379 const boost::function<void (Other&, T2)>& setter,
380 OtherRef Derived::*instance_ref )
382 return addStyle<T1>(name, type, bindOther(setter, instance_ref));
391 addStyle( const std::string& name,
392 const std::string& type,
393 void (Other::*setter)(const std::string&),
394 OtherRef Derived::*instance_ref )
396 return addStyle<const char*, const std::string&>
400 boost::function<void (Other&, const std::string&)>(setter),
405 template<typename T, class Derived, class Other, class OtherRef>
406 boost::function<void (Derived&, T)>
407 bindOther( void (Other::*setter)(T), OtherRef Derived::*instance_ref )
409 return boost::bind(setter, boost::bind(instance_ref, _1), _2);
412 template<typename T, class Derived, class Other, class OtherRef>
413 boost::function<void (Derived&, T)>
414 bindOther( const boost::function<void (Other&, T)>& setter,
415 OtherRef Derived::*instance_ref )
422 &reference_from_pointer<Other, OtherRef>,
423 boost::bind(instance_ref, _1)
429 template<typename T1, typename T2, class Derived>
430 StyleSetterFuncUnchecked
431 bindStyleSetter( const std::string& name,
432 const boost::function<void (Derived&, T2)>& setter )
437 // We will only call setters with Derived instances, so we can safely
439 boost::bind(&derived_cast<Derived>, _1),
440 boost::bind(&getValue<T1>, _2)
444 virtual void childAdded(SGPropertyNode * child) {}
445 virtual void childRemoved(SGPropertyNode * child){}
446 virtual void childChanged(SGPropertyNode * child){}
448 void setDrawable(osg::Drawable* drawable);
451 * Get stateset of drawable if available or use transform otherwise
453 osg::StateSet* getOrCreateStateSet();
459 osg::ref_ptr<osg::Drawable> _drawable;
461 Element(const Element&);// = delete
463 template<class Derived>
464 static Derived& derived_cast(Element& el)
466 return static_cast<Derived&>(el);
469 template<class T, class SharedPtr>
470 static T& reference_from_pointer(const SharedPtr& p)
472 return *get_pointer(p);
476 * Helper to call a function only of the element type can be converted to
479 * @return Whether the function has been called
481 template<class Derived>
484 static bool call( Element& el,
485 const SGPropertyNode* prop,
486 const StyleSetterFuncUnchecked& func )
488 Derived* d = dynamic_cast<Derived*>(&el);
497 } // namespace canvas
498 } // namespace simgear
500 #endif /* CANVAS_ELEMENT_HXX_ */