Crazy Eddies GUI System: CEGUIFalImagerySection.h Source File

Crazy Eddies GUI System 0.7.6

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

- File List

CEGUIFalImagerySection.h

    00001 /***********************************************************************
    00002     filename:   CEGUIFalImagerySection.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 _CEGUIFalImagerySection_h_
    00029 #define _CEGUIFalImagerySection_h_
    00030
    00031 #include "CEGUIFalImageryComponent.h"
    00032 #include "CEGUIFalTextComponent.h"
    00033 #include "CEGUIFalFrameComponent.h"
    00034 #include "../CEGUIXMLSerializer.h"
    00035
    00036 #if defined(_MSC_VER)
    00037 #       pragma warning(push)
    00038 #       pragma warning(disable : 4251)
    00039 #endif
    00040
    00041 // Start of CEGUI namespace section
    00042 namespace CEGUI
    00043 {
    00048     class CEGUIEXPORT ImagerySection
    00049     {
    00050     public:
    00055         ImagerySection();
    00056
    00064         ImagerySection(const String& name);
    00065
    00079         void render(Window& srcWindow, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
    00080
    00097         void render(Window& srcWindow, const Rect& baseRect, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
    00098
    00109         void addImageryComponent(const ImageryComponent& img);
    00110
    00118         void clearImageryComponents();
    00119
    00130         void addTextComponent(const TextComponent& text);
    00131
    00139         void clearTextComponents();
    00140
    00148         void clearFrameComponents();
    00149
    00160         void addFrameComponent(const FrameComponent& frame);
    00161
    00169         const ColourRect& getMasterColours() const;
    00170
    00181         void setMasterColours(const ColourRect& cols);
    00182
    00190         const String& getName() const;
    00191
    00202         void setMasterColoursPropertySource(const String& property);
    00203
    00215         void setMasterColoursPropertyIsColourRect(bool setting = true);
    00216
    00221         Rect getBoundingRect(const Window& wnd) const;
    00222
    00227         Rect getBoundingRect(const Window& wnd, const Rect& rect) const;
    00228
    00240         void writeXMLToStream(XMLSerializer& xml_stream) const;
    00241
    00242
    00244         size_t getTextComponentCount() const;
    00245
    00247         const TextComponent& getTextComponent(const size_t idx) const;
    00248
    00249     protected:
    00259         void initMasterColourRect(const Window& wnd, ColourRect& cr) const;
    00260
    00261     private:
    00262         typedef std::vector<ImageryComponent> ImageryList;
    00263         typedef std::vector<TextComponent> TextList;
    00264         typedef std::vector<FrameComponent> FrameList;
    00265
    00266         CEGUI::String       d_name;
    00267         CEGUI::ColourRect   d_masterColours;
    00268         FrameList           d_frames;
    00269         ImageryList         d_images;
    00270         TextList            d_texts;
    00271         String              d_colourPropertyName;
    00272         bool                d_colourProperyIsRect;
    00273     };
    00274
    00275 } // End of  CEGUI namespace section
    00276
    00277
    00278 #if defined(_MSC_VER)
    00279 #       pragma warning(pop)
    00280 #endif
    00281
    00282 #endif  // end of guard _CEGUIFalImagerySection_h_