TextLayoutManager.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/RenderAPI/Forward.hpp"
 
#include "TextLayout.hpp"
#include "TextStorage.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/Flags.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
 
#include "CeresEngine/Math/Rect.hpp"
#include "CeresEngine/Mesh/Mesh.hpp"
#include "CeresEngine/Texture/Texture.hpp"
 
namespace CeresEngine {
 
    struct TextContainer;
    class TextStorage;
 
    enum class TextLayoutManagerState : UInt64 {
        ShowsInvisibleCharacters = 1u << 0u,
        ShowsControlCharacters = 1u << 1u,
        UsesFontLeading = 1u << 2u,
        UsesDefaultHyphenation = 1u << 3u,
 
        NeedsLayout = 1ull << 32,
    };
 
    using TextLayoutManagerStateFlags = Flags<TextLayoutManagerState>;
    CE_FLAGS_OPERATORS(TextLayoutManagerState);
 
    class TextLayoutManager {
    private:
        TextStorage mStorage;
 
        Vector<TextContainer> mContainers;
 
        Vector<TextLayout> mLayouts;
 
        TextLayoutManagerStateFlags mFlags;
 
    public:
        [[nodiscard]] const TextStorage& getTextStorage() const { return mStorage; }
 
        void setTextStorage(const TextStorage& textStorage);
 
    public: // Managing the Text Containers
        [[nodiscard]] const Vector<TextContainer>& getTextContainers() const { return mContainers; }
 
        void setTextContainers(const Vector<TextContainer>& containers);
 
        void setTextContainer(const TextContainer& container);
 
        void addTextContainer(const TextContainer& aTextContainer);
 
        void insertTextContainer(const TextContainer& aTextContainer, UInt32 index);
 
        void removeTextContainer(UInt32 index);
 
        [[nodiscard]] const TextContainer* getTextContainerForGlyph(UInt32 glyphIndex);
 
    public: // Configuring the Global Layout Manager Options
        [[nodiscard]] bool getShowsInvisibleCharacters() const { return mFlags.isSet(TextLayoutManagerState::ShowsInvisibleCharacters); }
 
        void setShowsInvisibleCharacters(const bool showsInvisibleCharacters) {
            mFlags.set(TextLayoutManagerState::ShowsInvisibleCharacters, showsInvisibleCharacters);
        }
 
        [[nodiscard]] bool getShowsControlCharacters() const { return mFlags.isSet(TextLayoutManagerState::ShowsControlCharacters); }
 
        void setShowsControlCharacters(const bool showsControlCharacters) { mFlags.set(TextLayoutManagerState::ShowsControlCharacters, showsControlCharacters); }
 
        [[nodiscard]] bool getUsesFontLeading() const { return mFlags.isSet(TextLayoutManagerState::UsesFontLeading); }
 
        void setUsesFontLeading(const bool usesFontLeading) { mFlags.set(TextLayoutManagerState::UsesFontLeading, usesFontLeading); }
 
        [[nodiscard]] bool getUsesDefaultHyphenation() const { return mFlags.isSet(TextLayoutManagerState::UsesDefaultHyphenation); }
 
        void setUsesDefaultHyphenation(const bool usesDefaultHyphenation) { mFlags.set(TextLayoutManagerState::UsesDefaultHyphenation, usesDefaultHyphenation); }
 
    public:
        [[nodiscard]] bool getNeedsLayout() const;
 
        void setNeedsLayout();
 
        void setNeedsLayout(bool state);
 
        void layout();
 
        void layoutIfNeeded();
 
        [[nodiscard]] const Vector<TextLayout>& getLayout() const { return mLayouts; }
 
        SPtr<Texture> createTexture();
    };
 
} // namespace CeresEngine