font.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GRAPHICS_FONT_H
#define GRAPHICS_FONT_H

#include <vector>

#include "glm/mat4x4.hpp"

#include "src/common/ustring.h"

#include "src/graphics/types.h"

namespace Graphics {

class Font {
public:
    Font();
    virtual ~Font();

    virtual float getWidth (uint32 c) const = 0;
    virtual float getHeight()         const = 0;

    virtual float getLineSpacing() const;

    size_t getLineCount(const Common::UString &text, float maxWidth = 0.0f, float maxHeight = 0.0f) const;

    float getWidth (const Common::UString &text, float maxWidth = 0.0f) const;
    float getHeight(const Common::UString &text, float maxWidth = 0.0f, float maxHeight = 0.0f) const;
    float getLineWidth(const Common::UString &text) const;

    virtual void buildChars(const Common::UString &str);

    virtual void draw(uint32 c) const = 0;

    virtual void renderBind(const glm::mat4 &UNUSED(transform)) const {}
    virtual void render(uint32 UNUSED(c), float &UNUSED(x), float &UNUSED(y), float *UNUSED(rgba)) const {}
    virtual void renderUnbind() const {}

    float split(const Common::UString &line, std::vector<Common::UString> &lines,
                float maxWidth = 0.0f, float maxHeight = 0.0f, bool trim = true) const;
    float split(Common::UString &line, float maxWidth, float maxHeight = 0.0f, bool trim = true) const;
    float split(const Common::UString &line, Common::UString &lines, float maxWidth, float maxHeight = 0.0f, bool trim = true) const;

private:
    bool addLine(std::vector<Common::UString> &lines, const Common::UString &newLine, float maxHeight) const;
};

} // End of namespace Graphics

#endif // GRAPHICS_FONT_H