MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
layoutcontainer.h
1 //© Copyright 2010 - 2012 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _uilayoutcontainer_h
41 #define _uilayoutcontainer_h
42 
43 #include "UI/widget.h"
44 
45 namespace Mezzanine
46 {
47  namespace UI
48  {
49  ///////////////////////////////////////////////////////////////////////////////
50  /// @brief This is the base class for container objects that automatically position it's children.
51  /// @details The central concept to all layout containers is that the transforms on their children can be partially or
52  /// entirely generated automatically. Depending on the LayoutContainer implementation setting the transforms of children
53  /// will either be ignored, or cause errors. LayoutContainers are designed with an unknown amount of children in mind. @n @n
54  /// Also as a result of the level of control over the child transforms and the complexity of data that could go into generating
55  /// them, new LayoutStrategy classes are generally not defined for LayoutContainers. Attempting to do so would mean highly
56  /// specific implementations to handle each containers data which breaks the design intent of generic transform updates that
57  /// LayoutStrategy classes usually have, making sharing the logic impractical. Instead, parts of the layout logic is built
58  /// into the class implementation and other parts using specific methods on the LayoutStrategy base class. So sharing of
59  /// exact layout logic doesn't occur like it might in other widgets.
60  ///////////////////////////////////////
62  {
63  public:
64  /// @brief Basic container type for Visible @ref QuadRenderable storage by this class.
65  typedef std::vector<QuadRenderable*> VisibleChildContainer;
66  /// @brief Iterator type for Visible @ref QuadRenderable instances stored by this class.
67  typedef VisibleChildContainer::iterator VisibleChildIterator;
68  /// @brief Const Iterator type for Visible @ref QuadRenderable instances stored by this class.
69  typedef VisibleChildContainer::const_iterator ConstVisibleChildIterator;
70 
71  /// @brief String containing the type name for this class: "LayoutContainer".
72  static const String TypeName;
73  protected:
74  /// @internal
75  /// @brief A container of children that meet the criteria for rendering in this container.
77 
78  /// @internal
79  /// @brief The container specific logic for updating it's dimensions.
80  virtual void UpdateContainerDimensionsImpl(const Rect& OldSelfRect, const Rect& NewSelfRect) = 0;
81  public:
82  /// @brief Blank constructor.
83  /// @param Parent The parent Screen that created this widget.
84  LayoutContainer(Screen* Parent);
85  /// @brief Standard initialization constructor.
86  /// @param RendName The name to be given to this renderable.
87  /// @param Parent The parent Screen that created this widget.
88  LayoutContainer(const String& RendName, Screen* Parent);
89  /// @brief Rect constructor.
90  /// @param RendName The name to be given to this renderable.
91  /// @param RendRect The rect describing this widget's transform relative to it's parent.
92  /// @param Parent The parent screen that created this renderable.
93  LayoutContainer(const String& RendName, const UnifiedRect& RendRect, Screen* Parent);
94  /// @brief Class destructor.
95  virtual ~LayoutContainer();
96 
97  ///////////////////////////////////////////////////////////////////////////////
98  // Utility
99 
100  /// @copydoc QuadRenderable::UpdateDimensions(const Rect&, const Rect&)
101  virtual void UpdateDimensions(const Rect& OldSelfRect, const Rect& NewSelfRect);
102 
103  ///////////////////////////////////////////////////////////////////////////////
104  // Child Management
105 
106  ///////////////////////////////////////////////////////////////////////////////
107  // Serialization
108 
109  /// @copydoc Renderable::ProtoSerializeProperties(XML::Node&) const
110  virtual void ProtoSerializeProperties(XML::Node& SelfRoot) const;
111  /// @copydoc Renderable::ProtoDeSerializeProperties(const XML::Node&)
112  virtual void ProtoDeSerializeProperties(const XML::Node& SelfRoot);
113 
114  /// @copydoc Renderable::GetSerializableName()
115  static String GetSerializableName();
116 
117  ///////////////////////////////////////////////////////////////////////////////
118  // Internal Methods
119 
120  /// @copydoc QuadRenderable::_AppendRenderDataCascading(ScreenRenderData&)
121  virtual void _AppendRenderDataCascading(ScreenRenderData& RenderData);
122  };//LayoutContainer
123  }//UI
124 }//Mezzanine
125 
126 #endif