Crazy Eddies GUI System  0.7.0
CEGUIFalStateImagery.h
1 /***********************************************************************
2  filename: CEGUIFalStateImagery.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 "CEGUIFalLayerSpecification.h"
32 #include "../CEGUIWindow.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  {
49  public:
55 
63  StateImagery(const String& name);
64 
75  void render(Window& srcWindow, const ColourRect* modcols = 0, const Rect* clipper = 0) const;
76 
90  void render(Window& srcWindow, const Rect& baseRect, const ColourRect* modcols = 0, const Rect* clipper = 0) const;
91 
102  void addLayer(const LayerSpecification& layer);
103 
111  void clearLayers();
112 
120  const String& getName() const;
121 
132  bool isClippedToDisplay() const;
133 
147  void setClippedToDisplay(bool setting);
148 
160  void writeXMLToStream(XMLSerializer& xml_stream) const;
161 
162  private:
163  typedef std::multiset<LayerSpecification> LayersList;
164 
165  CEGUI::String d_stateName;
166  LayersList d_layers;
167  bool d_clipToDisplay;
168  };
169 
170 } // End of CEGUI namespace section
171 
172 
173 #if defined(_MSC_VER)
174 # pragma warning(pop)
175 #endif
176 
177 #endif // end of guard _CEGUIFalStateImagery_h_