TextActor.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/2d/Actor.h>
#include <kiwano/render/Color.h>
#include <kiwano/render/TextLayout.h>
 
namespace kiwano
{
 
class KGE_API TextActor : public Actor
{
public:
    TextActor();
 
    TextActor(StringView text, const TextStyle& style = TextStyle());
 
    virtual ~TextActor();
 
    StringView GetText() const;
 
    TextStyle GetStyle() const;
 
    RefPtr<TextLayout> GetLayout() const;
 
    Size GetSize() const override;
 
    RefPtr<Brush> GetFillBrush() const;
 
    RefPtr<Brush> GetOutlineBrush() const;
 
    RefPtr<StrokeStyle> GetOutlineStrokeStyle() const;
 
    const Font& GetFont() const;
 
    void SetText(StringView text);
 
    void SetStyle(const TextStyle& style);
 
    void SetFont(const Font& font);
 
    void SetFillBrush(RefPtr<Brush> brush);
 
    void SetFillColor(const Color& color);
 
    void SetWrapWidth(float wrap_width);
 
    void SetLineSpacing(float line_spacing);
 
    void SetAlignment(TextAlign align);
 
    void SetOutlineBrush(RefPtr<Brush> brush);
 
    void SetOutlineColor(const Color& outline_color);
 
    void SetOutlineStrokeStyle(RefPtr<StrokeStyle> stroke);
 
    void SetUnderline(bool enable);
 
    void SetStrikethrough(bool enable);
 
    void SetTextLayout(RefPtr<TextLayout> layout);
 
    void UpdateDirtyLayout();
 
    void ForceUpdateLayout();
 
    void OnRender(RenderContext& ctx) override;
 
protected:
    void Update(Duration dt) override;
 
    bool CheckVisibility(RenderContext& ctx) const override;
 
    void UpdateCachedBitmap();
 
    void SetPreRenderEnabled(bool enable);
 
private:
    bool                  is_cache_dirty_;
    String                content_;
    TextStyle             style_;
    RefPtr<TextLayout>    layout_;
    RefPtr<Brush>         fill_brush_;
    RefPtr<Brush>         outline_brush_;
    RefPtr<StrokeStyle>   outline_stroke_;
    RefPtr<Bitmap>        cached_bitmap_;
    RefPtr<RenderContext> render_ctx_;
};
 
inline StringView TextActor::GetText() const
{
    return content_;
}
 
inline const Font& TextActor::GetFont() const
{
    return style_.font;
}
 
inline TextStyle TextActor::GetStyle() const
{
    return style_;
}
 
inline RefPtr<TextLayout> TextActor::GetLayout() const
{
    return layout_;
}
 
inline RefPtr<Brush> TextActor::GetFillBrush() const
{
    return fill_brush_;
}
 
inline RefPtr<Brush> TextActor::GetOutlineBrush() const
{
    return outline_brush_;
}
 
inline RefPtr<StrokeStyle> TextActor::GetOutlineStrokeStyle() const
{
    return outline_stroke_;
}
 
}  // namespace kiwano