CEGUIRenderedString.h

/***********************************************************************
    filename:   CEGUIRenderedString.h
    created:    25/05/2009
    author:     Paul Turner
 *************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 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 _CEGUIRenderedString_h_
#define _CEGUIRenderedString_h_

#include "CEGUISize.h"
#include <vector>
#include <utility>

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

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT RenderedString
{
public:
    RenderedString();

    virtual ~RenderedString();

    void draw(const size_t line, GeometryBuffer& buffer, const Vector2& position,
              const ColourRect* mod_colours, const Rect* clip_rect,
              const float space_extra) const;


    Size getPixelSize(const size_t line) const;

    float getHorizontalExtent() const;

    float getVerticalExtent() const;

    void appendComponent(const RenderedStringComponent& component);

    void clearComponents();

    size_t getComponentCount() const;

    void split(const size_t line, float split_point, RenderedString& left);

    size_t getSpaceCount(const size_t line) const;

    void appendLineBreak();

    size_t getLineCount() const;

    RenderedString(const RenderedString& other);
    RenderedString& operator=(const RenderedString& rhs);

protected:
    typedef std::vector<RenderedStringComponent*> ComponentList;
    ComponentList d_components;
    typedef std::pair<size_t, size_t> LineInfo;
    typedef std::vector<LineInfo> LineList;
    LineList d_lines;
    void cloneComponentList(const ComponentList& list);
    static void clearComponentList(ComponentList& list);
};

} // End of  CEGUI namespace section

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

#endif // end of guard _CEGUIRenderedString_h_