magnum/src/MagnumPlugins/MagnumFont/MagnumFont.h

#ifndef Magnum_Text_MagnumFont_h
#define Magnum_Text_MagnumFont_h
/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014
              Vladimír Vondruš <mosra@centrum.cz>

    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 OR COPYRIGHT HOLDERS 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.
*/

/** @file
 * @brief Class Magnum::Text::MagnumFont
 */

#include "Magnum/Text/AbstractFont.h"
#include "Magnum/Trade/Trade.h"

namespace Magnum { namespace Text {

/**
@brief Simple bitmap font plugin

This plugin depends on @ref Trade::TgaImporter "TgaImporter" plugin and is
built if `WITH_MAGNUMFONT` is enabled when building %Magnum. To use dynamic
plugin, you need to load `%MagnumFont` plugin from `MAGNUM_PLUGINS_FONT_DIR`.
To use static plugin or use this as a dependency of another plugin, you need to
request `%MagnumFont` component of `%Magnum` package in CMake and link to
`${MAGNUM_MAGNUMFONT_LIBRARIES}`. See @ref building, @ref cmake and
@ref plugins for more information.

The font consists of two files, one text file containing character and glyph
info and one TGA file containing the glyphs in distance field format. The font
can be conveniently created from any other format using MagnumFontConverter.
The file syntax is as in following:

    # Font image filename
    image=font.tga

    # Size of unscaled font image
    originalImageSize=1536 1536

    # Glyph padding
    padding=9

    # Font size
    fontSize=128

    # Character
    [char]

    # UTF-32 codepoint ('a')
    unicode=0061

    # Glyph ID
    glyph=1

    # Advance to next character in pixels (i.e. on unscaled font image)
    advance=45 0

    # Another character
    [char]
    unicode=0062
    glyph=2
    advance=42 0

    # ...

    # Glyph 0, a.k.a. "Not Found" glyph
    [glyph]

    # Glyph texture position relative to baseline, in pixels
    position=5 -1

    # Glyph rectangle in font image, in pixels (left, bottom, right, top)
    rectangle=0 0 42 25

    # Glyph 1
    [glyph]
    position=0 0
    rectangle=45 0 44 25

    # ...

@see Trade::TgaImporter
*/
class MagnumFont: public AbstractFont {
    public:
        /** @brief Default constructor */
        explicit MagnumFont();

        /** @brief Plugin manager constructor */
        explicit MagnumFont(PluginManager::AbstractManager& manager, std::string plugin);

        ~MagnumFont();

    private:
        struct Data;

        Features doFeatures() const override;

        bool doIsOpened() const override;

        std::pair<Float, Float> doOpenData(const std::vector<std::pair<std::string, Containers::ArrayReference<const unsigned char>>>& data, Float) override;

        std::pair<Float, Float> doOpenFile(const std::string& filename, Float) override;

        void doClose() override;

        UnsignedInt doGlyphId(char32_t character) override;

        Vector2 doGlyphAdvance(UnsignedInt glyph) override;

        std::unique_ptr<GlyphCache> doCreateGlyphCache() override;

        std::unique_ptr<AbstractLayouter> doLayout(const GlyphCache& cache, Float size, const std::string& text) override;

        std::pair<Float, Float> openInternal(Utility::Configuration&& conf, Trade::ImageData2D&& image);

        Data* _opened;
};

}}

#endif