Crazy Eddie's GUI System  0.8.4
LayerSpecification.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 _CEGUIFalLayerSpecification_h_
00028 #define _CEGUIFalLayerSpecification_h_
00029 
00030 #include "./SectionSpecification.h"
00031 #include "../Window.h"
00032 
00033 #if defined(_MSC_VER)
00034 #       pragma warning(push)
00035 #       pragma warning(disable : 4251)
00036 #endif
00037 
00038 // Start of CEGUI namespace section
00039 namespace CEGUI
00040 {
00045     class CEGUIEXPORT LayerSpecification :
00046         public AllocatedObject<LayerSpecification>
00047     {
00048     public:
00057         LayerSpecification(uint priority = 0);
00058 
00069         void render(Window& srcWindow, const ColourRect* modcols = 0, const Rectf* clipper = 0, bool clipToDisplay = false) const;
00070 
00084         void render(Window& srcWindow, const Rectf& baseRect, const ColourRect* modcols = 0, const Rectf* clipper = 0, bool clipToDisplay = false) const;
00085 
00098         void addSectionSpecification(const SectionSpecification& section);
00099 
00107         void clearSectionSpecifications();
00108 
00116         uint getLayerPriority() const;
00124         void setLayerPriority(uint priority);
00125 
00126         // required to sort layers according to priority
00127         bool operator<(const LayerSpecification& other) const;
00128 
00140         void writeXMLToStream(XMLSerializer& xml_stream) const;
00141 
00142     private:
00143         typedef std::vector<SectionSpecification
00144             CEGUI_VECTOR_ALLOC(SectionSpecification)> SectionList;
00145 
00146         SectionList d_sections;         
00147         uint        d_layerPriority;    
00148     public:
00149         typedef ConstVectorIterator<SectionList> SectionIterator;
00150 
00151         SectionIterator getSectionIterator() const;
00152     };
00153 
00154 } // End of  CEGUI namespace section
00155 
00156 
00157 #if defined(_MSC_VER)
00158 #       pragma warning(pop)
00159 #endif
00160 
00161 #endif  // end of guard _CEGUIFalLayerSpecification_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends