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
27 #include <osg/BoundingBox>
28 #include <osg/MatrixTransform>
30 #include <boost/bind.hpp>
31 #include <boost/function.hpp>
32 #include <boost/type_traits/is_base_of.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
74 bool inheritable; ///!< Whether children can inherit this style from
79 * Coordinate reference frame (eg. "clip" property)
83 GLOBAL, ///!< Global coordinates
84 PARENT, ///!< Coordinates relative to parent coordinate frame
85 LOCAL ///!< Coordinates relative to local coordinates (parent
86 /// coordinates with local transformations applied)
92 virtual ~Element() = 0;
94 virtual void setSelf(const PropertyBasedElementPtr& self);
95 virtual void onDestroy();
97 ElementWeakPtr getWeakPtr() const;
98 ElementPtr getParent();
101 * Called every frame to update internal state
103 * @param dt Frame time in seconds
105 virtual void update(double dt);
107 bool addEventListener(const std::string& type, const EventListener& cb);
108 virtual void clearEventListener();
110 virtual bool accept(EventVisitor& visitor);
111 virtual bool ascend(EventVisitor& visitor);
112 virtual bool traverse(EventVisitor& visitor);
114 virtual bool handleEvent(canvas::EventPtr event);
116 virtual bool hitBound( const osg::Vec2f& pos,
117 const osg::Vec2f& local_pos ) const;
120 * Get whether the element is visible or hidden (Can be changed with
121 * setting property "visible" accordingly).
123 bool isVisible() const;
125 osg::MatrixTransform* getMatrixTransform();
126 osg::MatrixTransform const* getMatrixTransform() const;
128 virtual void childAdded( SGPropertyNode * parent,
129 SGPropertyNode * child );
130 virtual void childRemoved( SGPropertyNode * parent,
131 SGPropertyNode * child );
132 virtual void valueChanged(SGPropertyNode * child);
134 virtual bool setStyle( const SGPropertyNode* child,
135 const StyleInfo* style_info = 0 );
140 * @note Only "rect(<top>, <right>, <bottom>, <left>)" is supported
141 * @see http://www.w3.org/TR/CSS21/visufx.html#propdef-clip
143 void setClip(const std::string& clip);
146 * Clipping coordinates reference frame
148 void setClipFrame(ReferenceFrame rf);
151 * Write the given bounding box to the property tree
153 void setBoundingBox(const osg::BoundingBox& bb);
156 * Get bounding box with children/drawables transformed by passed matrix
158 virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
161 * Create an canvas Element
163 * @tparam Derived Type of element (needs to derive from Element)
165 template<typename Derived>
167 typename boost::enable_if<
168 boost::is_base_of<Element, Derived>,
170 >::type create( const CanvasWeakPtr& canvas,
171 const SGPropertyNode_ptr& node,
175 ElementPtr el( new Derived(canvas, node, style, parent) );
185 SCISSOR_COORDS = BLEND_FUNC << 1,
186 LAST_ATTRIBUTE = SCISSOR_COORDS << 1
198 class RelativeScissor;
200 CanvasWeakPtr _canvas;
203 uint32_t _attributes_dirty;
205 bool _transform_dirty;
206 osg::observer_ptr<osg::MatrixTransform> _transform;
207 std::vector<TransformType> _transform_types;
210 std::vector<SGPropertyNode_ptr> _bounding_box;
211 RelativeScissor *_scissor;
213 typedef std::vector<EventListener> Listener;
214 typedef std::map<Event::Type, Listener> ListenerMap;
216 ListenerMap _listener;
218 typedef std::map<std::string, StyleInfo> StyleSetters;
219 static StyleSetters _style_setters;
221 static void staticInit();
223 Element( const CanvasWeakPtr& canvas,
224 const SGPropertyNode_ptr& node,
225 const Style& parent_style,
229 * Returns false on first call and true on any successive call. Use to
230 * perform initialization tasks which are only required once per element
233 * @tparam Derived (Derived) class type
235 template<class Derived>
238 static bool is_init = false;
247 * Register a function for setting a style specified by the given property
249 * @param name Property name
250 * @param type Interpolation type
251 * @param setter Setter function
253 * @tparam T1 Type of value used to retrieve value from property
255 * @tparam T2 Type of value the setter function expects
256 * @tparam Derived Type of class the setter can be applied to
258 * @note T1 needs to be convertible to T2
267 addStyle( const std::string& name,
268 const std::string& type,
269 const boost::function<void (Derived&, T2)>& setter,
270 bool inheritable = true )
272 StyleInfo& style_info = _style_setters[ name ];
275 if( !style_info.type.empty() && type != style_info.type )
280 "changing animation type for '" << name << "': "
281 << style_info.type << " -> " << type
284 style_info.type = type;
286 // TODO check if changed?
287 style_info.inheritable = inheritable;
289 StyleSetter* style = &style_info.setter;
293 style = style->next = new StyleSetter;
295 style->func = boost::bind
297 &type_match<Derived>::call,
300 bindStyleSetter<T1>(name, setter)
311 addStyle( const std::string& name,
312 const std::string& type,
313 const boost::function<void (Derived&, T)>& setter,
314 bool inheritable = true )
316 return addStyle<T, T>(name, type, setter, inheritable);
325 addStyle( const std::string& name,
326 const std::string& type,
327 void (Derived::*setter)(T),
328 bool inheritable = true )
330 return addStyle<T, T>
334 boost::function<void (Derived&, T)>(setter),
346 addStyle( const std::string& name,
347 const std::string& type,
348 void (Derived::*setter)(T2),
349 bool inheritable = true )
355 boost::function<void (Derived&, T2)>(setter),
365 addStyle( const std::string& name,
366 const std::string& type,
367 void (Derived::*setter)(const std::string&),
368 bool inheritable = true )
370 return addStyle<const char*, const std::string&>
374 boost::function<void (Derived&, const std::string&)>(setter),
387 addStyle( const std::string& name,
388 const std::string& type,
389 void (Other::*setter)(T),
390 OtherRef Derived::*instance_ref,
391 bool inheritable = true )
393 return addStyle<T, T>
397 bindOther(setter, instance_ref),
411 addStyle( const std::string& name,
412 const std::string& type,
413 void (Other::*setter)(T2),
414 OtherRef Derived::*instance_ref,
415 bool inheritable = true )
421 bindOther(setter, instance_ref),
435 addStyle( const std::string& name,
436 const std::string& type,
437 const boost::function<void (Other&, T2)>& setter,
438 OtherRef Derived::*instance_ref,
439 bool inheritable = true )
445 bindOther(setter, instance_ref),
457 addStyle( const std::string& name,
458 const std::string& type,
459 void (Other::*setter)(const std::string&),
460 OtherRef Derived::*instance_ref,
461 bool inheritable = true )
463 return addStyle<const char*, const std::string&>
467 boost::function<void (Other&, const std::string&)>(setter),
473 template<typename T, class Derived, class Other, class OtherRef>
475 boost::function<void (Derived&, T)>
476 bindOther( void (Other::*setter)(T), OtherRef Derived::*instance_ref )
478 return boost::bind(setter, boost::bind(instance_ref, _1), _2);
481 template<typename T, class Derived, class Other, class OtherRef>
483 boost::function<void (Derived&, T)>
484 bindOther( const boost::function<void (Other&, T)>& setter,
485 OtherRef Derived::*instance_ref )
492 &reference_from_pointer<Other, OtherRef>,
493 boost::bind(instance_ref, _1)
499 template<typename T1, typename T2, class Derived>
501 StyleSetterFuncUnchecked
502 bindStyleSetter( const std::string& name,
503 const boost::function<void (Derived&, T2)>& setter )
508 // We will only call setters with Derived instances, so we can safely
510 boost::bind(&derived_cast<Derived>, _1),
511 boost::bind(&getValue<T1>, _2)
515 bool isStyleEmpty(const SGPropertyNode* child) const;
516 bool canApplyStyle(const SGPropertyNode* child) const;
517 bool setStyleImpl( const SGPropertyNode* child,
518 const StyleInfo* style_info = 0 );
520 const StyleInfo* getStyleInfo(const std::string& name) const;
521 const StyleSetter* getStyleSetter(const std::string& name) const;
522 const SGPropertyNode* getParentStyle(const SGPropertyNode* child) const;
524 virtual void childAdded(SGPropertyNode * child) {}
525 virtual void childRemoved(SGPropertyNode * child){}
526 virtual void childChanged(SGPropertyNode * child){}
528 void setDrawable(osg::Drawable* drawable);
531 * Get stateset of drawable if available or use transform otherwise
533 osg::StateSet* getOrCreateStateSet();
539 osg::ref_ptr<osg::Drawable> _drawable;
541 Element(const Element&);// = delete
543 template<class Derived>
544 static Derived& derived_cast(Element& el)
546 return static_cast<Derived&>(el);
549 template<class T, class SharedPtr>
550 static T& reference_from_pointer(const SharedPtr& p)
552 return *get_pointer(p);
556 * Helper to call a function only of the element type can be converted to
559 * @return Whether the function has been called
561 template<class Derived>
564 static bool call( Element& el,
565 const SGPropertyNode* prop,
566 const StyleSetterFuncUnchecked& func )
568 Derived* d = dynamic_cast<Derived*>(&el);
577 } // namespace canvas
580 struct enum_traits<canvas::Element::ReferenceFrame>
582 static const char* name()
584 return "canvas::Element::ReferenceFrame";
587 static canvas::Element::ReferenceFrame defVal()
589 return canvas::Element::GLOBAL;
592 static bool validate(int frame)
594 return frame >= canvas::Element::GLOBAL
595 && frame <= canvas::Element::LOCAL;
599 } // namespace simgear
601 #endif /* CANVAS_ELEMENT_HXX_ */