Crazy Eddies GUI System  0.7.6
CEGUIRenderedString.h
00001 /***********************************************************************
00002     filename:   CEGUIRenderedString.h
00003     created:    25/05/2009
00004     author:     Paul Turner
00005  *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2009 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 _CEGUIRenderedString_h_
00029 #define _CEGUIRenderedString_h_
00030 
00031 #include "CEGUISize.h"
00032 #include <vector>
00033 #include <utility>
00034 
00035 #if defined(_MSC_VER)
00036 #       pragma warning(push)
00037 #       pragma warning(disable : 4251)
00038 #endif
00039 
00040 // Start of CEGUI namespace section
00041 namespace CEGUI
00042 {
00050 class CEGUIEXPORT RenderedString
00051 {
00052 public:
00054     RenderedString();
00055 
00057     virtual ~RenderedString();
00058 
00095     void draw(const size_t line, GeometryBuffer& buffer, const Vector2& position,
00096               const ColourRect* mod_colours, const Rect* clip_rect,
00097               const float space_extra) const;
00098 
00100 
00114     Size getPixelSize(const size_t line) const;
00115 
00117     void appendComponent(const RenderedStringComponent& component);
00118 
00120     void clearComponents();
00121 
00123     size_t getComponentCount() const;
00124 
00148     void split(const size_t line, float split_point, RenderedString& left);
00149 
00151     size_t getSpaceCount(const size_t line) const;
00152 
00154     void appendLineBreak();
00155 
00157     size_t getLineCount() const;
00158 
00160     RenderedString(const RenderedString& other);
00162     RenderedString& operator=(const RenderedString& rhs);
00163 
00164 protected:
00166     typedef std::vector<RenderedStringComponent*> ComponentList;
00168     ComponentList d_components;
00170     typedef std::pair<size_t, size_t> LineInfo;
00172     typedef std::vector<LineInfo> LineList;
00174     LineList d_lines;
00176     void cloneComponentList(const ComponentList& list);
00178     static void clearComponentList(ComponentList& list);
00179 };
00180 
00181 } // End of  CEGUI namespace section
00182 
00183 #if defined(_MSC_VER)
00184 #       pragma warning(pop)
00185 #endif
00186 
00187 #endif // end of guard _CEGUIRenderedString_h_