]> git.mxchange.org Git - simgear.git/blob - simgear/canvas/elements/CanvasGroup.hxx
CanvasGroup: Fix handling z-index while moving child to front.
[simgear.git] / 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       typedef std::list< std::pair< const SGPropertyNode*,
38                                     ElementPtr
39                                   >
40                        > ChildList;
41
42       Group( const CanvasWeakPtr& canvas,
43              const SGPropertyNode_ptr& node,
44              const Style& parent_style = Style(),
45              Element* parent = 0 );
46       virtual ~Group();
47
48       ElementPtr createChild( const std::string& type,
49                               const std::string& id = "" );
50       ElementPtr getChild(const SGPropertyNode* node);
51       ElementPtr getChild(const std::string& id);
52
53       /**
54        * Get first child with given id (breadth-first search)
55        *
56        * @param id  Id (value if property node 'id') of element
57        */
58       ElementPtr getElementById(const std::string& id);
59
60       virtual void clearEventListener();
61
62       virtual void update(double dt);
63
64       virtual bool traverse(EventVisitor& visitor);
65
66       virtual bool setStyle(const SGPropertyNode* child);
67
68       virtual osg::BoundingBox getTransformedBounds(const osg::Matrix& m) const;
69
70     protected:
71
72       static ElementFactories   _child_factories;
73       ChildList                 _children;
74
75       virtual void childAdded(SGPropertyNode * child);
76       virtual void childRemoved(SGPropertyNode * child);
77       virtual void childChanged(SGPropertyNode * child);
78
79       void handleZIndexChanged(ChildList::iterator child, int z_index = 0);
80
81       ChildList::iterator findChild(const SGPropertyNode* node);
82   };
83
84 } // namespace canvas
85 } // namespace simgear
86
87 #endif /* CANVAS_GROUP_HXX_ */