Crazy Eddie's GUI System  0.8.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
StateImagery.h
1 /***********************************************************************
2  filename: CEGUIStateImagery.h
3  created: Mon Jun 13 2005
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIFalStateImagery_h_
29 #define _CEGUIFalStateImagery_h_
30 
31 #include "./LayerSpecification.h"
32 #include "../Window.h"
33 #include <set>
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 // Start of CEGUI namespace section
41 namespace CEGUI
42 {
47  class CEGUIEXPORT StateImagery :
48  public AllocatedObject<StateImagery>
49  {
50  public:
56  d_clipToDisplay(false)
57  {}
58 
66  StateImagery(const String& name);
67 
78  void render(Window& srcWindow, const ColourRect* modcols = 0, const Rectf* clipper = 0) const;
79 
93  void render(Window& srcWindow, const Rectf& baseRect, const ColourRect* modcols = 0, const Rectf* clipper = 0) const;
94 
105  void addLayer(const LayerSpecification& layer);
106 
114  void clearLayers();
115 
123  const String& getName() const;
124 
132  void setName(const String& name);
133 
144  bool isClippedToDisplay() const;
145 
159  void setClippedToDisplay(bool setting);
160 
172  void writeXMLToStream(XMLSerializer& xml_stream) const;
173 
174  private:
175  typedef std::multiset<LayerSpecification> LayersList;
176 
177  CEGUI::String d_stateName;
178  LayersList d_layers;
179  bool d_clipToDisplay;
180  public:
181  typedef ConstVectorIterator<LayersList> LayerIterator;
182 
183  LayerIterator getLayerIterator() const;
184 
185  };
186 
187 } // End of CEGUI namespace section
188 
189 
190 #if defined(_MSC_VER)
191 # pragma warning(pop)
192 #endif
193 
194 #endif // end of guard _CEGUIFalStateImagery_h_