TextCache.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2018 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_TEXTCACHE_H
#define RAMSES_TEXTCACHE_H
 
#include "ramses-text-api/TextLine.h"
#include "ramses-text-api/FontInstanceOffsets.h"
#include <string>
 
namespace ramses
{
    class Scene;
    class Effect;
    class IFontAccessor;
    class TextCacheImpl;
 
    class RAMSES_API TextCache
    {
    public:
        TextCache(Scene& scene, IFontAccessor& fontAccessor, uint32_t atlasTextureWidth, uint32_t atlasTextureHeight);
 
        ~TextCache();
 
        GlyphMetricsVector      getPositionedGlyphs(const std::u32string& str, FontInstanceId font);
 
        GlyphMetricsVector      getPositionedGlyphs(const std::u32string& str, const FontInstanceOffsets& fontOffsets);
 
        TextLineId              createTextLine(const GlyphMetricsVector& glyphs, const Effect& effect);
 
        TextLine const*         getTextLine(TextLineId textId) const;
 
        TextLine*               getTextLine(TextLineId textId);
 
        bool                    deleteTextLine(TextLineId textId);
 
        static bool             ContainsRenderableGlyphs(const GlyphMetricsVector& glyphMetrics);
 
        static void             ApplyTrackingToGlyphs(GlyphMetricsVector& glyphMetrics, int32_t trackingFactor, int32_t fontSize);
 
        class TextCacheImpl* impl;
 
        TextCache(const TextCache& other) = delete;
 
        TextCache& operator=(const TextCache& other) = delete;
    };
}
 
#endif