simgear/canvas/elements/CanvasElement.hxx

   1 // Interface for 2D Canvas elements
   2 //
   3 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   4 //
   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.
   9 //
  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.
  14 //
  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
  18
  19 #ifndef CANVAS_ELEMENT_HXX_
  20 #define CANVAS_ELEMENT_HXX_
  21
  22 #include <simgear/canvas/canvas_fwd.hxx>
  23 #include <simgear/canvas/CanvasEvent.hxx>
  24 #include <simgear/props/props.hxx>
  25 #include <simgear/misc/stdint.hxx> // for uint32_t
  26 #include <simgear/nasal/cppbind/Ghost.hxx>
  27
  28 #include <osg/BoundingBox>
  29 #include <osg/MatrixTransform>
  30
  31 #include <boost/bind.hpp>
  32 #include <boost/function.hpp>
  33
  34 namespace osg
  35 {
  36   class Drawable;
  37 }
  38
  39 namespace simgear
  40 {
  41 namespace canvas
  42 {
  43
  44   class Element:
  45     public SGPropertyChangeListener
  46   {
  47     public:
  48       typedef boost::function<void(const SGPropertyNode*)> StyleSetter;
  49       typedef std::map<std::string, StyleSetter> StyleSetters;
  50
  51       /**
  52        * Remove the property listener of the element.
  53        *
  54        * You will need to call the appropriate methods (#childAdded,
  55        * #childRemoved, #valueChanged) yourself to ensure the element still
  56        * receives the needed events.
  57        */
  58       void removeListener();
  59
  60       /**
  61        *
  62        */
  63       virtual ~Element() = 0;
  64
  65       /**
  66        * Called every frame to update internal state
  67        *
  68        * @param dt  Frame time in seconds
  69        */
  70       virtual void update(double dt);
  71
  72       naRef addEventListener(const nasal::CallContext& ctx);
  73
  74       SGConstPropertyNode_ptr getProps() const;
  75       SGPropertyNode_ptr getProps();
  76
  77       virtual bool accept(EventVisitor& visitor);
  78       virtual bool ascend(EventVisitor& visitor);
  79       virtual bool traverse(EventVisitor& visitor);
  80
  81       void callListeners(const canvas::EventPtr& event);
  82
  83       virtual bool hitBound(const osg::Vec2f& pos) const;
  84
  85
  86       osg::ref_ptr<osg::MatrixTransform> getMatrixTransform();
  87
  88       virtual void childAdded( SGPropertyNode * parent,
  89                                SGPropertyNode * child );
  90       virtual void childRemoved( SGPropertyNode * parent,
  91                                  SGPropertyNode * child );
  92       virtual void valueChanged(SGPropertyNode * child);
  93
  94       /**
  95        * Write the given bounding box to the property tree
  96        */
  97       void setBoundingBox(const osg::BoundingBox& bb);
  98
  99       /**
 100        * Get bounding box with children/drawables transformed by passed matrix
 101        */
 102       virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
 103
 104     protected:
 105
 106       enum Attributes
 107       {
 108         LAST_ATTRIBUTE  = 0x0001
 109       };
 110
 111       enum TransformType
 112       {
 113         TT_NONE,
 114         TT_MATRIX,
 115         TT_TRANSLATE,
 116         TT_ROTATE,
 117         TT_SCALE
 118       };
 119
 120       CanvasWeakPtr _canvas;
 121       Element      *_parent;
 122       uint32_t _attributes_dirty;
 123
 124       bool _transform_dirty;
 125       osg::ref_ptr<osg::MatrixTransform>    _transform;
 126       std::vector<TransformType>            _transform_types;
 127
 128       SGPropertyNode_ptr                _node;
 129       Style                             _style;
 130       StyleSetters                      _style_setters;
 131       std::vector<SGPropertyNode_ptr>   _bounding_box;
 132
 133       typedef std::vector<EventListenerPtr> Listener;
 134       typedef std::map<Event::Type, Listener> ListenerMap;
 135
 136       ListenerMap _listener;
 137
 138       Element( const CanvasWeakPtr& canvas,
 139                const SGPropertyNode_ptr& node,
 140                const Style& parent_style,
 141                Element* parent );
 142
 143       template<typename T, class C1, class C2>
 144       Element::StyleSetter
 145       addStyle(const std::string& name, void (C1::*setter)(T), C2 instance)
 146       {
 147         return _style_setters[ name ] =
 148                  bindStyleSetter<T>(name, setter, instance);
 149       }
 150
 151       template<typename T1, typename T2, class C1, class C2>
 152       Element::StyleSetter
 153       addStyle(const std::string& name, void (C1::*setter)(T2), C2 instance)
 154       {
 155         return _style_setters[ name ] =
 156                  bindStyleSetter<T1>(name, setter, instance);
 157       }
 158
 159       template<class C1, class C2>
 160       Element::StyleSetter
 161       addStyle( const std::string& name,
 162                 void (C1::*setter)(const std::string&),
 163                 C2 instance )
 164       {
 165         return _style_setters[ name ] =
 166                  bindStyleSetter<const char*>(name, setter, instance);
 167       }
 168
 169       template<typename T1, typename T2, class C1, class C2>
 170       Element::StyleSetter
 171       bindStyleSetter( const std::string& name,
 172                        void (C1::*setter)(T2),
 173                        C2 instance )
 174       {
 175         return boost::bind(setter, instance, boost::bind(&getValue<T1>, _1));
 176       }
 177
 178       virtual void childAdded(SGPropertyNode * child)  {}
 179       virtual void childRemoved(SGPropertyNode * child){}
 180       virtual void childChanged(SGPropertyNode * child){}
 181
 182       void setDrawable(osg::Drawable* drawable);
 183
 184       void setupStyle();
 185       bool setStyle(const SGPropertyNode* child);
 186
 187     private:
 188
 189       osg::ref_ptr<osg::Drawable> _drawable;
 190
 191       Element(const Element&);// = delete
 192   };
 193
 194 } // namespace canvas
 195 } // namespace simgear
 196
 197 #endif /* CANVAS_ELEMENT_HXX_ */