Magic_Game/src/kiwano/render/TextLayout.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// 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.

#pragma once
#include <kiwano/math/Math.h>
#include <kiwano/render/TextStyle.hpp>

namespace kiwano
{
class RenderContext;
class Renderer;

/**
 * \addtogroup Render
 * @{
 */

/// \~chinese
/// @brief <20>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
class KGE_API TextLayout
{
    friend class RenderContext;
    friend class Renderer;

public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>յ<EFBFBD><D5B5>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    TextLayout();

    /// \~chinese
    /// @brief <20>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><C7B7><EFBFBD>Ч
    bool IsValid() const;

    /// \~chinese
    /// @brief <20>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><C7B7>¾<EFBFBD>
    bool IsDirty() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    /// @note <20>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>µģ<C2B5><C4A3><EFBFBD><EFBFBD>޸<EFBFBD><DEB8>ı<EFBFBD><C4B1><EFBFBD><EFBFBD>ֵ<EFBFBD><D6B5><EFBFBD><EFBFBD>Ժ<EFBFBD><D4BA><EFBFBD>Ҫ<EFBFBD>ֶ<EFBFBD><D6B6><EFBFBD><EFBFBD><EFBFBD>
    void Update();

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>ı<EFBFBD>
    const String& GetText() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>ı<EFBFBD><C4B1><EFBFBD>ʽ
    const TextStyle& GetStyle() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD><EFBFBD>
    uint32_t GetLineCount() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>ı<EFBFBD><C4B1><EFBFBD><EFBFBD>ִ<EFBFBD>С
    Size GetLayoutSize() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>仭ˢ
    BrushPtr GetFillBrush() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>߻<EFBFBD>ˢ
    BrushPtr GetOutlineBrush() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD>
    void SetText(const String& text);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1><EFBFBD>ʽ
    void SetStyle(const TextStyle& style);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void SetFont(FontPtr font);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void SetFontFamily(String const& family);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ֺţ<D6BA>Ĭ<EFBFBD><C4AC>ֵΪ 18<31><38>
    void SetFontSize(float size);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ϸֵ<CFB8><D6B5>Ĭ<EFBFBD><C4AC>ֵΪ FontWeight::Normal<61><6C>
    void SetFontWeight(uint32_t weight);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>仭ˢ
    void SetFillBrush(BrushPtr brush);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>б<EFBFBD>壨Ĭ<E5A3A8><C4AC>ֵΪ false<73><65>
    void SetItalic(bool italic);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ı<EFBFBD><C4B1>Զ<EFBFBD><D4B6><EFBFBD><EFBFBD>еĿ<D0B5><C4BF><EFBFBD>
    void SetWrapWidth(float wrap_width);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>м<EFBFBD><D0BC>ࣨĬ<E0A3A8><C4AC>Ϊ 0<><30>
    void SetLineSpacing(float line_spacing);

    /// \~chinese
    /// @brief <20><><EFBFBD>ö<EFBFBD><C3B6>뷽ʽ
    void SetAlignment(TextAlign align);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>߻<EFBFBD>ˢ
    void SetOutlineBrush(BrushPtr brush);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>߿<EFBFBD>
    void SetOutlineWidth(float outline_width);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ཻ<EFBFBD><E0BDBB>ʽ
    void SetOutlineStroke(StrokeStylePtr outline_stroke);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>»<EFBFBD><C2BB><EFBFBD>
    /// @param enable <20>Ƿ<EFBFBD><C7B7><EFBFBD>ʾ<EFBFBD>»<EFBFBD><C2BB><EFBFBD>
    /// @param start <20><>ʼλ<CABC><CEBB>
    /// @param length <20><><EFBFBD><EFBFBD>
    void SetUnderline(bool enable, uint32_t start, uint32_t length);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>ɾ<EFBFBD><C9BE><EFBFBD><EFBFBD>
    /// @param enable <20>Ƿ<EFBFBD><C7B7><EFBFBD>ʾɾ<CABE><C9BE><EFBFBD><EFBFBD>
    /// @param start <20><>ʼλ<CABC><CEBB>
    /// @param length <20><><EFBFBD><EFBFBD>
    void SetStrikethrough(bool enable, uint32_t start, uint32_t length);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>ݱ<EFBFBD>־
    enum DirtyFlag : uint8_t
    {
        Clean       = 0,       ///< <20>ɾ<EFBFBD><C9BE><EFBFBD><EFBFBD><EFBFBD>
        DirtyFormat = 1,       ///< <20><><EFBFBD>ָ<EFBFBD>ʽ<EFBFBD><CABD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
        DirtyLayout = 1 << 1,  ///< <20><><EFBFBD>ֲ<EFBFBD><D6B2>ִ<EFBFBD><D6B4><EFBFBD><EFBFBD><EFBFBD>
        Updated     = 1 << 2,  ///< <20><><EFBFBD><EFBFBD><EFBFBD>Ѹ<EFBFBD><D1B8><EFBFBD>
    };

    uint8_t GetDirtyFlag() const;

    void SetDirtyFlag(uint8_t flag);

private:
    ComPtr<IDWriteTextFormat> GetTextFormat() const;

    void SetTextFormat(ComPtr<IDWriteTextFormat> format);

    ComPtr<IDWriteTextLayout> GetTextLayout() const;

    void SetTextLayout(ComPtr<IDWriteTextLayout> layout);

private:
    uint8_t dirty_flag_;

    ComPtr<IDWriteTextFormat> text_format_;
    ComPtr<IDWriteTextLayout> text_layout_;

    String    text_;
    TextStyle style_;
};

/** @} */

inline bool TextLayout::IsValid() const
{
    return text_layout_ != nullptr;
}

inline bool TextLayout::IsDirty() const
{
    return dirty_flag_ != DirtyFlag::Clean;
}

inline const String& TextLayout::GetText() const
{
    return text_;
}

inline const TextStyle& TextLayout::GetStyle() const
{
    return style_;
}

inline uint8_t TextLayout::GetDirtyFlag() const
{
    return dirty_flag_;
}

inline void TextLayout::SetDirtyFlag(uint8_t flag)
{
    dirty_flag_ = flag;
}

inline ComPtr<IDWriteTextFormat> TextLayout::GetTextFormat() const
{
    return text_format_;
}

inline ComPtr<IDWriteTextLayout> TextLayout::GetTextLayout() const
{
    return text_layout_;
}

inline BrushPtr TextLayout::GetFillBrush() const
{
    return style_.fill_brush;
}

inline BrushPtr TextLayout::GetOutlineBrush() const
{
    return style_.outline_brush;
}

inline void TextLayout::SetFillBrush(BrushPtr brush)
{
    style_.fill_brush = brush;
}

inline void TextLayout::SetTextFormat(ComPtr<IDWriteTextFormat> format)
{
    text_format_ = format;
}

inline void TextLayout::SetTextLayout(ComPtr<IDWriteTextLayout> layout)
{
    text_layout_ = layout;
}

inline void TextLayout::SetOutlineBrush(BrushPtr brush)
{
    style_.outline_brush = brush;
}

inline void TextLayout::SetOutlineWidth(float outline_width)
{
    style_.outline_width = outline_width;
}

inline void TextLayout::SetOutlineStroke(StrokeStylePtr outline_stroke)
{
    style_.outline_stroke = outline_stroke;
}
}  // namespace kiwano