Crazy Eddies GUI System 0.7.5
CEGUIFalStateImagery.h
00001 /***********************************************************************
00002     filename:   CEGUIFalStateImagery.h
00003     created:    Mon Jun 13 2005
00004     author:     Paul D Turner <paul@cegui.org.uk>
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUIFalStateImagery_h_
00029 #define _CEGUIFalStateImagery_h_
00030 
00031 #include "CEGUIFalLayerSpecification.h"
00032 #include "../CEGUIWindow.h"
00033 #include <set>
00034 
00035 #if defined(_MSC_VER)
00036 #       pragma warning(push)
00037 #       pragma warning(disable : 4251)
00038 #endif
00039 
00040 // Start of CEGUI namespace section
00041 namespace CEGUI
00042 {
00047     class CEGUIEXPORT StateImagery
00048     {
00049     public:
00054         StateImagery() {}
00055 
00063         StateImagery(const String& name);
00064 
00075         void render(Window& srcWindow, const ColourRect* modcols = 0, const Rect* clipper = 0) const;
00076 
00090         void render(Window& srcWindow, const Rect& baseRect, const ColourRect* modcols = 0, const Rect* clipper = 0) const;
00091 
00102         void addLayer(const LayerSpecification& layer);
00103 
00111         void clearLayers();
00112 
00120         const String& getName() const;
00121 
00132         bool isClippedToDisplay() const;
00133 
00147         void setClippedToDisplay(bool setting);
00148 
00160         void writeXMLToStream(XMLSerializer& xml_stream) const;
00161 
00162     private:
00163         typedef std::multiset<LayerSpecification> LayersList;
00164 
00165         CEGUI::String   d_stateName;    
00166         LayersList      d_layers;       
00167         bool            d_clipToDisplay; 
00168     };
00169 
00170 } // End of  CEGUI namespace section
00171 
00172 
00173 #if defined(_MSC_VER)
00174 #       pragma warning(pop)
00175 #endif
00176 
00177 #endif  // end of guard _CEGUIFalStateImagery_h_