StateImagery.h

/***********************************************************************
    created:    Mon Jun 13 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIFalStateImagery_h_
#define _CEGUIFalStateImagery_h_

#include "./LayerSpecification.h"
#include "../Window.h"
#include <set>

#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT StateImagery :
        public AllocatedObject<StateImagery>
    {
    public:
        typedef std::vector<LayerSpecification* 
            CEGUI_VECTOR_ALLOC(LayerSpecification*)> LayerSpecificationPointerList;

        StateImagery():
                d_clipToDisplay(false)
        {}

        StateImagery(const String& name);

        void render(Window& srcWindow, const ColourRect* modcols = 0, const Rectf* clipper = 0) const;

        void render(Window& srcWindow, const Rectf& baseRect, const ColourRect* modcols = 0, const Rectf* clipper = 0) const;

        void addLayer(const LayerSpecification& layer);

        void sort();

        void clearLayers();

        const String& getName() const;

        void setName(const String& name);

        bool isClippedToDisplay() const;

        void setClippedToDisplay(bool setting);

        void writeXMLToStream(XMLSerializer& xml_stream) const;


        LayerSpecificationPointerList getLayerSpecificationPointers();

    private:
        typedef std::multiset<LayerSpecification> LayersList;

        CEGUI::String   d_stateName;    
        LayersList      d_layers;       
        bool            d_clipToDisplay; 
    public:
        typedef ConstVectorIterator<LayersList> LayerIterator;

        LayerIterator getLayerIterator() const;

    };

} // End of  CEGUI namespace section


#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIFalStateImagery_h_