simgear/canvas/elements/CanvasGroup.hxx

   1 // A group of 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_GROUP_HXX_
  20 #define CANVAS_GROUP_HXX_
  21
  22 #include "CanvasElement.hxx"
  23
  24 #include <list>
  25
  26 namespace simgear
  27 {
  28 namespace canvas
  29 {
  30
  31   typedef std::map<std::string, ElementFactory> ElementFactories;
  32
  33   class Group:
  34     public Element
  35   {
  36     public:
  37       static const std::string TYPE_NAME;
  38
  39       typedef std::list< std::pair< const SGPropertyNode*,
  40                                     ElementPtr
  41                                   >
  42                        > ChildList;
  43
  44       Group( const CanvasWeakPtr& canvas,
  45              const SGPropertyNode_ptr& node,
  46              const Style& parent_style = Style(),
  47              Element* parent = 0 );
  48       virtual ~Group();
  49
  50       ElementPtr createChild( const std::string& type,
  51                               const std::string& id = "" );
  52       ElementPtr getChild(const SGPropertyNode* node);
  53       ElementPtr getChild(const std::string& id);
  54       ElementPtr getOrCreateChild( const std::string& type,
  55                                    const std::string& id );
  56
  57       template<class T>
  58       boost::shared_ptr<T> createChild(const std::string& id = "")
  59       {
  60         return boost::dynamic_pointer_cast<T>( createChild(T::TYPE_NAME, id) );
  61       }
  62
  63       template<class T>
  64       boost::shared_ptr<T> getChild(const SGPropertyNode* node)
  65       {
  66         return boost::dynamic_pointer_cast<T>( getChild(node) );
  67       }
  68
  69       template<class T>
  70       boost::shared_ptr<T> getChild(const std::string& id)
  71       {
  72         return boost::dynamic_pointer_cast<T>( getChild(id) );
  73       }
  74
  75       template<class T>
  76       boost::shared_ptr<T> getOrCreateChild(const std::string& id)
  77       {
  78         return
  79           boost::dynamic_pointer_cast<T>( getOrCreateChild(T::TYPE_NAME, id) );
  80       }
  81
  82       /**
  83        * Get first child with given id (breadth-first search)
  84        *
  85        * @param id  Id (value if property node 'id') of element
  86        */
  87       ElementPtr getElementById(const std::string& id);
  88
  89       virtual void clearEventListener();
  90
  91       virtual void update(double dt);
  92
  93       virtual bool traverse(EventVisitor& visitor);
  94
  95       virtual bool setStyle(const SGPropertyNode* child);
  96
  97       virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
  98
  99     protected:
 100
 101       static ElementFactories   _child_factories;
 102
 103       /**
 104        * Overload in derived classes to allow for more/other types of elements
 105        * to be managed.
 106        */
 107       virtual ElementFactory getChildFactory(const std::string& type) const;
 108
 109       virtual void childAdded(SGPropertyNode * child);
 110       virtual void childRemoved(SGPropertyNode * child);
 111       virtual void childChanged(SGPropertyNode * child);
 112
 113       void handleZIndexChanged(ElementPtr child, int z_index = 0);
 114
 115       ElementPtr getChildByIndex(size_t index) const;
 116       ElementPtr findChild( const SGPropertyNode* node,
 117                             const std::string& id ) const;
 118   };
 119
 120 } // namespace canvas
 121 } // namespace simgear
 122
 123 #endif /* CANVAS_GROUP_HXX_ */