Crazy Eddie's GUI System  0.8.4
StateImagery.h
00001 /***********************************************************************
00002     created:    Mon Jun 13 2005
00003     author:     Paul D Turner <paul@cegui.org.uk>
00004 *************************************************************************/
00005 /***************************************************************************
00006  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00007  *
00008  *   Permission is hereby granted, free of charge, to any person obtaining
00009  *   a copy of this software and associated documentation files (the
00010  *   "Software"), to deal in the Software without restriction, including
00011  *   without limitation the rights to use, copy, modify, merge, publish,
00012  *   distribute, sublicense, and/or sell copies of the Software, and to
00013  *   permit persons to whom the Software is furnished to do so, subject to
00014  *   the following conditions:
00015  *
00016  *   The above copyright notice and this permission notice shall be
00017  *   included in all copies or substantial portions of the Software.
00018  *
00019  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00020  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00021  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00022  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00023  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00024  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00025  *   OTHER DEALINGS IN THE SOFTWARE.
00026  ***************************************************************************/
00027 #ifndef _CEGUIFalStateImagery_h_
00028 #define _CEGUIFalStateImagery_h_
00029 
00030 #include "./LayerSpecification.h"
00031 #include "../Window.h"
00032 #include <set>
00033 
00034 #if defined(_MSC_VER)
00035 #       pragma warning(push)
00036 #       pragma warning(disable : 4251)
00037 #endif
00038 
00039 // Start of CEGUI namespace section
00040 namespace CEGUI
00041 {
00046     class CEGUIEXPORT StateImagery :
00047         public AllocatedObject<StateImagery>
00048     {
00049     public:
00054         StateImagery():
00055                 d_clipToDisplay(false)
00056         {}
00057 
00065         StateImagery(const String& name);
00066 
00077         void render(Window& srcWindow, const ColourRect* modcols = 0, const Rectf* clipper = 0) const;
00078 
00092         void render(Window& srcWindow, const Rectf& baseRect, const ColourRect* modcols = 0, const Rectf* clipper = 0) const;
00093 
00104         void addLayer(const LayerSpecification& layer);
00105 
00113         void clearLayers();
00114 
00122         const String& getName() const;
00123 
00131         void setName(const String& name);
00132 
00143         bool isClippedToDisplay() const;
00144 
00158         void setClippedToDisplay(bool setting);
00159 
00171         void writeXMLToStream(XMLSerializer& xml_stream) const;
00172 
00173     private:
00174         typedef std::multiset<LayerSpecification> LayersList;
00175 
00176         CEGUI::String   d_stateName;    
00177         LayersList      d_layers;       
00178         bool            d_clipToDisplay; 
00179     public:
00180         typedef ConstVectorIterator<LayersList> LayerIterator;
00181 
00182         LayerIterator getLayerIterator() const;
00183 
00184     };
00185 
00186 } // End of  CEGUI namespace section
00187 
00188 
00189 #if defined(_MSC_VER)
00190 #       pragma warning(pop)
00191 #endif
00192 
00193 #endif  // end of guard _CEGUIFalStateImagery_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends