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       virtual bool setStyle(const SGPropertyNode* child);
  95
  96       /**
  97        * Write the given bounding box to the property tree
  98        */
  99       void setBoundingBox(const osg::BoundingBox& bb);
 100
 101       /**
 102        * Get bounding box with children/drawables transformed by passed matrix
 103        */
 104       virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
 105
 106     protected:
 107
 108       enum Attributes
 109       {
 110         LAST_ATTRIBUTE  = 0x0001
 111       };
 112
 113       enum TransformType
 114       {
 115         TT_NONE,
 116         TT_MATRIX,
 117         TT_TRANSLATE,
 118         TT_ROTATE,
 119         TT_SCALE
 120       };
 121
 122       CanvasWeakPtr _canvas;
 123       Element      *_parent;
 124       uint32_t _attributes_dirty;
 125
 126       bool _transform_dirty;
 127       osg::ref_ptr<osg::MatrixTransform>    _transform;
 128       std::vector<TransformType>            _transform_types;
 129
 130       SGPropertyNode_ptr                _node;
 131       Style                             _style;
 132       StyleSetters                      _style_setters;
 133       std::vector<SGPropertyNode_ptr>   _bounding_box;
 134
 135       typedef std::vector<EventListenerPtr> Listener;
 136       typedef std::map<Event::Type, Listener> ListenerMap;
 137
 138       ListenerMap _listener;
 139
 140       Element( const CanvasWeakPtr& canvas,
 141                const SGPropertyNode_ptr& node,
 142                const Style& parent_style,
 143                Element* parent );
 144
 145       template<typename T, class C1, class C2>
 146       Element::StyleSetter
 147       addStyle(const std::string& name, void (C1::*setter)(T), C2 instance)
 148       {
 149         return _style_setters[ name ] =
 150                  bindStyleSetter<T>(name, setter, instance);
 151       }
 152
 153       template<typename T1, typename T2, class C1, class C2>
 154       Element::StyleSetter
 155       addStyle(const std::string& name, void (C1::*setter)(T2), C2 instance)
 156       {
 157         return _style_setters[ name ] =
 158                  bindStyleSetter<T1>(name, setter, instance);
 159       }
 160
 161       template<class C1, class C2>
 162       Element::StyleSetter
 163       addStyle( const std::string& name,
 164                 void (C1::*setter)(const std::string&),
 165                 C2 instance )
 166       {
 167         return _style_setters[ name ] =
 168                  bindStyleSetter<const char*>(name, setter, instance);
 169       }
 170
 171       template<typename T1, typename T2, class C1, class C2>
 172       Element::StyleSetter
 173       bindStyleSetter( const std::string& name,
 174                        void (C1::*setter)(T2),
 175                        C2 instance )
 176       {
 177         return boost::bind(setter, instance, boost::bind(&getValue<T1>, _1));
 178       }
 179
 180       virtual void childAdded(SGPropertyNode * child)  {}
 181       virtual void childRemoved(SGPropertyNode * child){}
 182       virtual void childChanged(SGPropertyNode * child){}
 183
 184       void setDrawable(osg::Drawable* drawable);
 185
 186       void setupStyle();
 187
 188     private:
 189
 190       osg::ref_ptr<osg::Drawable> _drawable;
 191
 192       Element(const Element&);// = delete
 193   };
 194
 195 } // namespace canvas
 196 } // namespace simgear
 197
 198 #endif /* CANVAS_ELEMENT_HXX_ */