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);
118 * @param global_pos Position in global (canvas) coordinate frame
119 * @param parent_pos Position in parent coordinate frame
120 * @param local_pos Position in local (element) coordinate frame
122 virtual bool hitBound( const osg::Vec2f& global_pos,
123 const osg::Vec2f& parent_pos,
124 const osg::Vec2f& local_pos ) const;
127 * Set visibility of the element.
129 void setVisible(bool visible);
132 * Get whether the element is visible or hidden.
134 bool isVisible() const;
136 osg::MatrixTransform* getMatrixTransform();
137 osg::MatrixTransform const* getMatrixTransform() const;
140 * Transform position to local coordinages.
142 osg::Vec2f posToLocal(const osg::Vec2f& pos) const;
144 virtual void childAdded( SGPropertyNode * parent,
145 SGPropertyNode * child );
146 virtual void childRemoved( SGPropertyNode * parent,
147 SGPropertyNode * child );
148 virtual void valueChanged(SGPropertyNode * child);
150 virtual bool setStyle( const SGPropertyNode* child,
151 const StyleInfo* style_info = 0 );
156 * @note Only "rect(<top>, <right>, <bottom>, <left>)" is supported
157 * @see http://www.w3.org/TR/CSS21/visufx.html#propdef-clip
159 void setClip(const std::string& clip);
162 * Clipping coordinates reference frame
164 void setClipFrame(ReferenceFrame rf);
167 * Write the given bounding box to the property tree
169 void setBoundingBox(const osg::BoundingBox& bb);
172 * Get bounding box with children/drawables transformed by passed matrix
174 virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
177 * Get the transformation matrix (product of all transforms)
179 osg::Matrix getMatrix() const;
182 * Create an canvas Element
184 * @tparam Derived Type of element (needs to derive from Element)
186 template<typename Derived>
188 typename boost::enable_if<
189 boost::is_base_of<Element, Derived>,
191 >::type create( const CanvasWeakPtr& canvas,
192 const SGPropertyNode_ptr& node,
196 ElementPtr el( new Derived(canvas, node, style, parent) );
206 BLEND_FUNC = TRANSFORM << 1,
207 SCISSOR_COORDS = BLEND_FUNC << 1,
208 LAST_ATTRIBUTE = SCISSOR_COORDS << 1
220 class RelativeScissor;
222 CanvasWeakPtr _canvas;
225 mutable uint32_t _attributes_dirty;
227 osg::observer_ptr<osg::MatrixTransform> _transform;
228 std::vector<TransformType> _transform_types;
231 std::vector<SGPropertyNode_ptr> _bounding_box;
232 RelativeScissor *_scissor;
234 typedef std::vector<EventListener> Listener;
235 typedef std::map<Event::Type, Listener> ListenerMap;
237 ListenerMap _listener;
239 typedef std::map<std::string, StyleInfo> StyleSetters;
240 static StyleSetters _style_setters;
242 static void staticInit();
244 Element( const CanvasWeakPtr& canvas,
245 const SGPropertyNode_ptr& node,
246 const Style& parent_style,
250 * Returns false on first call and true on any successive call. Use to
251 * perform initialization tasks which are only required once per element
254 * @tparam Derived (Derived) class type
256 template<class Derived>
259 static bool is_init = false;
268 * Register a function for setting a style specified by the given property
270 * @param name Property name
271 * @param type Interpolation type
272 * @param setter Setter function
274 * @tparam T1 Type of value used to retrieve value from property
276 * @tparam T2 Type of value the setter function expects
277 * @tparam Derived Type of class the setter can be applied to
279 * @note T1 needs to be convertible to T2
288 addStyle( const std::string& name,
289 const std::string& type,
290 const boost::function<void (Derived&, T2)>& setter,
291 bool inheritable = true )
293 StyleInfo& style_info = _style_setters[ name ];
296 if( !style_info.type.empty() && type != style_info.type )
301 "changing animation type for '" << name << "': "
302 << style_info.type << " -> " << type
305 style_info.type = type;
307 // TODO check if changed?
308 style_info.inheritable = inheritable;
310 StyleSetter* style = &style_info.setter;
314 style = style->next = new StyleSetter;
316 style->func = boost::bind
318 &type_match<Derived>::call,
321 bindStyleSetter<T1>(name, setter)
332 addStyle( const std::string& name,
333 const std::string& type,
334 const boost::function<void (Derived&, T)>& setter,
335 bool inheritable = true )
337 return addStyle<T, T>(name, type, setter, inheritable);
346 addStyle( const std::string& name,
347 const std::string& type,
348 void (Derived::*setter)(T),
349 bool inheritable = true )
351 return addStyle<T, T>
355 boost::function<void (Derived&, T)>(setter),
367 addStyle( const std::string& name,
368 const std::string& type,
369 void (Derived::*setter)(T2),
370 bool inheritable = true )
376 boost::function<void (Derived&, T2)>(setter),
386 addStyle( const std::string& name,
387 const std::string& type,
388 void (Derived::*setter)(const std::string&),
389 bool inheritable = true )
391 return addStyle<const char*, const std::string&>
395 boost::function<void (Derived&, const std::string&)>(setter),
408 addStyle( const std::string& name,
409 const std::string& type,
410 void (Other::*setter)(T),
411 OtherRef Derived::*instance_ref,
412 bool inheritable = true )
414 return addStyle<T, T>
418 bindOther(setter, instance_ref),
432 addStyle( const std::string& name,
433 const std::string& type,
434 void (Other::*setter)(T2),
435 OtherRef Derived::*instance_ref,
436 bool inheritable = true )
442 bindOther(setter, instance_ref),
456 addStyle( const std::string& name,
457 const std::string& type,
458 const boost::function<void (Other&, T2)>& setter,
459 OtherRef Derived::*instance_ref,
460 bool inheritable = true )
466 bindOther(setter, instance_ref),
478 addStyle( const std::string& name,
479 const std::string& type,
480 void (Other::*setter)(const std::string&),
481 OtherRef Derived::*instance_ref,
482 bool inheritable = true )
484 return addStyle<const char*, const std::string&>
488 boost::function<void (Other&, const std::string&)>(setter),
494 template<typename T, class Derived, class Other, class OtherRef>
496 boost::function<void (Derived&, T)>
497 bindOther( void (Other::*setter)(T), OtherRef Derived::*instance_ref )
499 return boost::bind(setter, boost::bind(instance_ref, _1), _2);
502 template<typename T, class Derived, class Other, class OtherRef>
504 boost::function<void (Derived&, T)>
505 bindOther( const boost::function<void (Other&, T)>& setter,
506 OtherRef Derived::*instance_ref )
513 &reference_from_pointer<Other, OtherRef>,
514 boost::bind(instance_ref, _1)
520 template<typename T1, typename T2, class Derived>
522 StyleSetterFuncUnchecked
523 bindStyleSetter( const std::string& name,
524 const boost::function<void (Derived&, T2)>& setter )
529 // We will only call setters with Derived instances, so we can safely
531 boost::bind(&derived_cast<Derived>, _1),
532 boost::bind(&getValue<T1>, _2)
536 bool isStyleEmpty(const SGPropertyNode* child) const;
537 bool canApplyStyle(const SGPropertyNode* child) const;
538 bool setStyleImpl( const SGPropertyNode* child,
539 const StyleInfo* style_info = 0 );
541 const StyleInfo* getStyleInfo(const std::string& name) const;
542 const StyleSetter* getStyleSetter(const std::string& name) const;
543 const SGPropertyNode* getParentStyle(const SGPropertyNode* child) const;
545 virtual void childAdded(SGPropertyNode * child) {}
546 virtual void childRemoved(SGPropertyNode * child){}
547 virtual void childChanged(SGPropertyNode * child){}
549 void setDrawable(osg::Drawable* drawable);
552 * Get stateset of drawable if available or use transform otherwise
554 osg::StateSet* getOrCreateStateSet();
560 osg::ref_ptr<osg::Drawable> _drawable;
562 Element(const Element&);// = delete
564 template<class Derived>
565 static Derived& derived_cast(Element& el)
567 return static_cast<Derived&>(el);
570 template<class T, class SharedPtr>
571 static T& reference_from_pointer(const SharedPtr& p)
573 return *get_pointer(p);
577 * Helper to call a function only of the element type can be converted to
580 * @return Whether the function has been called
582 template<class Derived>
585 static bool call( Element& el,
586 const SGPropertyNode* prop,
587 const StyleSetterFuncUnchecked& func )
589 Derived* d = dynamic_cast<Derived*>(&el);
598 } // namespace canvas
601 struct enum_traits<canvas::Element::ReferenceFrame>
603 static const char* name()
605 return "canvas::Element::ReferenceFrame";
608 static canvas::Element::ReferenceFrame defVal()
610 return canvas::Element::GLOBAL;
613 static bool validate(int frame)
615 return frame >= canvas::Element::GLOBAL
616 && frame <= canvas::Element::LOCAL;
620 } // namespace simgear
622 #endif /* CANVAS_ELEMENT_HXX_ */