Text.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//

#ifndef SFML_TEXT_HPP
#define SFML_TEXT_HPP

// Headers
#include <SFML/Graphics/Export.hpp>
#include <SFML/Graphics/Drawable.hpp>
#include <SFML/Graphics/Transformable.hpp>
#include <SFML/Graphics/Font.hpp>
#include <SFML/Graphics/Rect.hpp>
#include <SFML/Graphics/VertexArray.hpp>
#include <SFML/System/String.hpp>
#include <string>
#include <vector>


namespace sf
{
class SFML_GRAPHICS_API Text : public Drawable, public Transformable
{
public:

    enum Style
    {
        Regular       = 0,      
        Bold          = 1 << 0, 
        Italic        = 1 << 1, 
        Underlined    = 1 << 2, 
        StrikeThrough = 1 << 3  
    };

    Text();

    Text(const String& string, const Font& font, unsigned int characterSize = 30);

    void setString(const String& string);

    void setFont(const Font& font);

    void setCharacterSize(unsigned int size);

    void setLineSpacing(float spacingFactor);

    void setLetterSpacing(float spacingFactor);

    void setStyle(Uint32 style);

    SFML_DEPRECATED void setColor(const Color& color);

    void setFillColor(const Color& color);

    void setOutlineColor(const Color& color);

    void setOutlineThickness(float thickness);

    const String& getString() const;

    const Font* getFont() const;

    unsigned int getCharacterSize() const;

    float getLetterSpacing() const;

    float getLineSpacing() const;

    Uint32 getStyle() const;

    SFML_DEPRECATED const Color& getColor() const;

    const Color& getFillColor() const;

    const Color& getOutlineColor() const;

    float getOutlineThickness() const;

    Vector2f findCharacterPos(std::size_t index) const;

    FloatRect getLocalBounds() const;

    FloatRect getGlobalBounds() const;

private:

    virtual void draw(RenderTarget& target, RenderStates states) const;

    void ensureGeometryUpdate() const;

    // Member data
    String              m_string;              
    const Font*         m_font;                
    unsigned int        m_characterSize;       
    float               m_letterSpacingFactor; 
    float               m_lineSpacingFactor;   
    Uint32              m_style;               
    Color               m_fillColor;           
    Color               m_outlineColor;        
    float               m_outlineThickness;    
    mutable VertexArray m_vertices;            
    mutable VertexArray m_outlineVertices;     
    mutable FloatRect   m_bounds;              
    mutable bool        m_geometryNeedUpdate;  
    mutable Uint64      m_fontTextureId;       
};

} // namespace sf


#endif // SFML_TEXT_HPP