Crazy Eddies GUI System: CEGUIFalLayerSpecification.h Source File

Crazy Eddies GUI System 0.7.6

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

CEGUIFalLayerSpecification.h

    00001 /***********************************************************************
    00002     filename:   CEGUIFalLayerSpecification.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 _CEGUIFalLayerSpecification_h_
    00029 #define _CEGUIFalLayerSpecification_h_
    00030
    00031 #include "CEGUIFalSectionSpecification.h"
    00032 #include "../CEGUIWindow.h"
    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 LayerSpecification
    00047     {
    00048     public:
    00057         LayerSpecification(uint priority);
    00058
    00069         void render(Window& srcWindow, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
    00070
    00084         void render(Window& srcWindow, const Rect& baseRect, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
    00085
    00098         void addSectionSpecification(const SectionSpecification& section);
    00099
    00107         void clearSectionSpecifications();
    00108
    00116         uint getLayerPriority() const;
    00117
    00118         // required to sort layers according to priority
    00119         bool operator<(const LayerSpecification& other) const;
    00120
    00132         void writeXMLToStream(XMLSerializer& xml_stream) const;
    00133
    00134     private:
    00135         typedef std::vector<SectionSpecification> SectionList;
    00136
    00137         SectionList d_sections;
    00138         uint        d_layerPriority;
    00139     };
    00140
    00141 } // End of  CEGUI namespace section
    00142
    00143
    00144 #if defined(_MSC_VER)
    00145 #       pragma warning(pop)
    00146 #endif
    00147
    00148 #endif  // end of guard _CEGUIFalLayerSpecification_h_