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/PropertyBasedElement.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 PropertyBasedElement
  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       ElementWeakPtr getWeakPtr() const;
  66
  67       /**
  68        * Called every frame to update internal state
  69        *
  70        * @param dt  Frame time in seconds
  71        */
  72       virtual void update(double dt);
  73
  74       naRef addEventListener(const nasal::CallContext& ctx);
  75
  76       virtual bool accept(EventVisitor& visitor);
  77       virtual bool ascend(EventVisitor& visitor);
  78       virtual bool traverse(EventVisitor& visitor);
  79
  80       void callListeners(const canvas::EventPtr& event);
  81
  82       virtual bool hitBound(const osg::Vec2f& pos) const;
  83
  84
  85       osg::ref_ptr<osg::MatrixTransform> getMatrixTransform();
  86
  87       virtual void childAdded( SGPropertyNode * parent,
  88                                SGPropertyNode * child );
  89       virtual void childRemoved( SGPropertyNode * parent,
  90                                  SGPropertyNode * child );
  91       virtual void valueChanged(SGPropertyNode * child);
  92
  93       virtual bool setStyle(const SGPropertyNode* child);
  94
  95       /**
  96        * Set clipping shape
  97        *
  98        * @note Only "rect(<top>, <right>, <bottom>, <left>)" is supported
  99        * @see http://www.w3.org/TR/CSS21/visufx.html#propdef-clip
 100        */
 101       void setClip(const std::string& clip);
 102
 103       /**
 104        * Write the given bounding box to the property tree
 105        */
 106       void setBoundingBox(const osg::BoundingBox& bb);
 107
 108       /**
 109        * Get bounding box with children/drawables transformed by passed matrix
 110        */
 111       virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
 112
 113     protected:
 114
 115       enum Attributes
 116       {
 117         LAST_ATTRIBUTE  = 0x0001
 118       };
 119
 120       enum TransformType
 121       {
 122         TT_NONE,
 123         TT_MATRIX,
 124         TT_TRANSLATE,
 125         TT_ROTATE,
 126         TT_SCALE
 127       };
 128
 129       CanvasWeakPtr _canvas;
 130       Element      *_parent;
 131
 132       uint32_t _attributes_dirty;
 133
 134       bool _transform_dirty;
 135       osg::ref_ptr<osg::MatrixTransform>    _transform;
 136       std::vector<TransformType>            _transform_types;
 137
 138       Style                             _style;
 139       StyleSetters                      _style_setters;
 140       std::vector<SGPropertyNode_ptr>   _bounding_box;
 141
 142       typedef std::vector<EventListenerPtr> Listener;
 143       typedef std::map<Event::Type, Listener> ListenerMap;
 144
 145       ListenerMap _listener;
 146
 147       Element( const CanvasWeakPtr& canvas,
 148                const SGPropertyNode_ptr& node,
 149                const Style& parent_style,
 150                Element* parent );
 151
 152       template<typename T, class C1, class C2>
 153       Element::StyleSetter
 154       addStyle(const std::string& name, void (C1::*setter)(T), C2 instance)
 155       {
 156         return _style_setters[ name ] =
 157                  bindStyleSetter<T>(name, setter, instance);
 158       }
 159
 160       template<typename T1, typename T2, class C1, class C2>
 161       Element::StyleSetter
 162       addStyle(const std::string& name, void (C1::*setter)(T2), C2 instance)
 163       {
 164         return _style_setters[ name ] =
 165                  bindStyleSetter<T1>(name, setter, instance);
 166       }
 167
 168       template<class C1, class C2>
 169       Element::StyleSetter
 170       addStyle( const std::string& name,
 171                 void (C1::*setter)(const std::string&),
 172                 C2 instance )
 173       {
 174         return _style_setters[ name ] =
 175                  bindStyleSetter<const char*>(name, setter, instance);
 176       }
 177
 178       template<typename T1, typename T2, class C1, class C2>
 179       Element::StyleSetter
 180       bindStyleSetter( const std::string& name,
 181                        void (C1::*setter)(T2),
 182                        C2 instance )
 183       {
 184         return boost::bind(setter, instance, boost::bind(&getValue<T1>, _1));
 185       }
 186
 187       virtual void childAdded(SGPropertyNode * child)  {}
 188       virtual void childRemoved(SGPropertyNode * child){}
 189       virtual void childChanged(SGPropertyNode * child){}
 190
 191       void setDrawable(osg::Drawable* drawable);
 192
 193       /**
 194        * Get stateset of drawable if available or use transform otherwise
 195        */
 196       osg::StateSet* getOrCreateStateSet();
 197
 198       void setupStyle();
 199
 200     private:
 201
 202       osg::ref_ptr<osg::Drawable> _drawable;
 203
 204       Element(const Element&);// = delete
 205   };
 206
 207 } // namespace canvas
 208 } // namespace simgear
 209
 210 #endif /* CANVAS_ELEMENT_HXX_ */