BasicText.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * 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.
 *
 * Part of this file comes from SFML, with the same license:
 * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
 */
#ifndef GF_BASIC_TEXT_H
#define GF_BASIC_TEXT_H

#include <string>

#include "Alignment.h"
#include "GraphicsApi.h"
#include "Vector.h"
#include "VertexArray.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class Font;
  class AlphaTexture;

  class GF_GRAPHICS_API BasicText {
  public:
    BasicText();

    BasicText(std::string string, Font& font, unsigned characterSize = 30);

    void setString(std::string string);

    const std::string& getString() const {
      return m_string;
    }

    void setCharacterSize(unsigned characterSize);

    unsigned getCharacterSize() const {
      return m_characterSize;
    }

    void setFont(Font& font);

    const Font *getFont() const {
      return m_font;
    }

    const AlphaTexture *getFontTexture();

    void setOutlineThickness(float thickness);

    float getOutlineThickness() {
      return m_outlineThickness;
    }

    void setLineSpacing(float spacingFactor);

    float getLineSpacing() const {
      return m_lineSpacingFactor;
    }

    void setLetterSpacing(float spacingFactor);

    float getLetterSpacing() const {
      return m_letterSpacingFactor;
    }

    void setParagraphWidth(float paragraphWidth);

    float getParagraphWidth() const {
      return m_paragraphWidth;
    }

    void setAlignment(Alignment align);

    Alignment getAlignment() const {
      return m_align;
    }

    RectF getLocalBounds() const {
      return m_bounds;
    }

    void updateGeometry(VertexArray& vertices, VertexArray& outlineVertices);

  private:
    std::string m_string;
    Font *m_font;

    unsigned m_characterSize;
    float m_outlineThickness;
    float m_lineSpacingFactor;
    float m_letterSpacingFactor;

    float m_paragraphWidth;
    Alignment m_align;

    RectF m_bounds;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_BASIC_TEXT_H