YiTextSceneNode.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_TEXT_SCENE_NODE_H_
#define _YI_TEXT_SCENE_NODE_H_

#include "scenetree/YiSceneNode.h"
#include "graphics/YiTextEngine.h"
#include "utility/YiColor.h"

class CYICustomMarkupTagsProvider;
class CYITextMarkupParser;

class CYITextSceneNode : public CYISceneNode
{
public:
    enum X_JUSTIFY
    {
        X_JUSTIFY_LEFT,         
        X_JUSTIFY_RIGHT,        
        X_JUSTIFY_CENTER        
    };

    struct YI_TEXT_STYLE_DEF
    {
        YI_TEXT_STYLE_DEF();

        bool operator==(const YI_TEXT_STYLE_DEF &other) const;
        bool operator!=(const YI_TEXT_STYLE_DEF &other) const;

        ssize_t m_nFontID; 
        int32_t m_nFontSize; 
        int32_t m_nLeading; 
        bool                            m_bIsAllCaps;           
        YI_TEXT_LINE_STYLE              m_eTextLineStyle;       
        YI_SCRIPT_MODE                  m_eScriptMode;          
        int32_t m_nBaselineShift; 
        int32_t m_nTracking; 
        int32_t m_nKerning; 
        CYIColor                        m_Color;
        uint32_t m_uLastCodepointIndex; 
    };

    struct YI_TEXT_DEF
    {
        YI_TEXT_DEF();

        CYIString                       m_text;                     
        int32_t m_nLength; 
        X_JUSTIFY                       m_XJustify;                 
        bool                            m_bMultiline;               
        bool                            m_bEllipses;                
        bool                            m_bUserSpecifiedWidth;      
        std::vector<YI_TEXT_STYLE_DEF>  m_styles;                   
    };

    CYITextSceneNode();
    virtual ~CYITextSceneNode();

    float GetTextWidth();

    float GetTextHeight();

    YI_FLOAT_RECT CalculateTightTextRect();

    virtual YI_FLOAT_RECT_REL CalculateGlyphBox();

    void SetTextOffsetX(float fTextOffsetX);

    void SetTextMaxWidth(float fMaxWidth);

    bool SetFont(const CYIString &fontFamilyName, const CYIString &fontStyle, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetFontID(ssize_t nFontID, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    bool SetFontFamily(const CYIString &fontFamilyName, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    bool SetFontStyle(const CYIString &fontStyleName, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetFontSize(int32_t nFontSize, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetFontColor(const CYIColor &Color, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetAllCaps(bool bEnable, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetScriptMode(YI_SCRIPT_MODE eScriptMode, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetBaselineShift(int32_t nBaselineShift, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetTracking(int32_t nBaselineShift, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetKerning(int32_t nBaselineShift, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetLeading(int32_t uLeading, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    void SetEllipses(bool bEnable);

    void SetMultiline(bool bEnable);

    virtual void SetSize(const glm::vec3 &vSize, bool bDirtyLayout = true) override;

    void SetText(const CYIString &rText);

    void SetMarkedUpText(const CYIString &rMarkedUpText, CYITextMarkupParser *pMarkupParser = nullptr, const CYICustomMarkupTagsProvider *pExternalTagsProvider = nullptr);

    void SetXJustify(X_JUSTIFY eXJustify);
    
    void SetPointTypeOn(int32_t nWidth = 0);

    void SetBoxTypeOn(int32_t nBoxWidth, int32_t nBoxHeight);

    void SetLineStyle(YI_TEXT_LINE_STYLE eTextLineStyle, uint32_t uFirstCodepointIndex = 0, uint32_t uLength = std::numeric_limits<uint32_t>::max());

    float GetTextOffsetX() const;
    const CYIString &GetText() const;
    const CYIString &GetMarkedUpText() const;
    int32_t GetLength() const;
    X_JUSTIFY GetXJustify() const;
    bool GetMultiline() const;
    bool GetEllipses() const;

    ssize_t GetFontID(uint32_t uCodepointIndex = 0) const;
    const CYIString &GetFontFamily(uint32_t uCodepointIndex = 0) const;
    const CYIString &GetFontStyle(uint32_t uCodepointIndex = 0) const;
    int32_t GetFontSize(uint32_t uCodepointIndex = 0) const;
    const CYIColor &GetFontColor(uint32_t uCodepointIndex = 0) const;
    bool IsAllCaps(uint32_t uCodepointIndex = 0) const;
    YI_TEXT_LINE_STYLE GetLineStyle(uint32_t uCodepointIndex = 0) const;
    int32_t GetLeading(uint32_t uCodepointIndex = 0) const;
    YI_SCRIPT_MODE GetScriptMode(uint32_t uCodepointIndex = 0) const;
    int32_t GetBaselineShift(uint32_t uCodepointIndex = 0) const;
    int32_t GetTracking(uint32_t uCodepointIndex = 0) const;
    int32_t GetKerning(uint32_t uCodepointIndex = 0) const;

    const std::vector<YI_TEXT_STYLE_DEF> &GetTextStyles() const;

    const YI_TEXT_STYLE_DEF &GetTextStyle(uint32_t uCodepointIndex) const;

    void SetTextStyle(const YI_TEXT_STYLE_DEF &style, uint32_t uFirstCodepointIndex);

    void SetTextStyles(const std::vector<YI_TEXT_STYLE_DEF> &styles);

    void SetEllipsisStyle(const YI_TEXT_STYLE_DEF &style);

    void ResetPerCharacterStyles();

    int32_t GetBoxWidth() const;
    int32_t GetBoxHeight() const;

    void SetUseFontTables(bool bUseFontTables);
    
    bool IsUsingFontTables() const;

    bool IsBoxType() const;

    bool IsPointType() const;

    virtual YI_FLOAT_RECT GetRectForTextRange(int32_t nStartIndex, int32_t nEndIndex, float fHorizontalPixelRatio, float fVerticalPixelRatio);

    int32_t GetIndexOfPosition(float fX, float fY, float fHorizontalPixelRatio, float fVerticalPixelRatio);

    virtual void Measure(const MeasureSpec &widthSpec, const MeasureSpec &heightSpec, const MeasureSpec &depthSpec) override;
    virtual void ApplyMeasurements() override;

protected:
    const std::shared_ptr<const CYITextLayout> &GetTextLayout(const YI_TEXT_RENDER_INFO &textRenderInfo);

    YI_TEXT_RENDER_INFO CreateTextRenderInfo();
    YI_TEXT_RENDER_INFO CreateTextRenderInfo(const YI_RECT_REL &textRect);

    virtual YI_FLOAT_RECT_REL CalculateGlyphBox(const YI_RECT_REL &boxRect);

    YI_FLOAT_RECT_REL CalculateGlyphBox(const CYITextLayout *pLayout, const YI_RECT_REL &layoutRect) const;

    YI_FLOAT_RECT_REL CalculateGlyphBox(const CYITextLayout *pLayout, const YI_FLOAT_RECT_REL &layoutRect) const;

    virtual void PrepareToDraw() = 0;

    virtual void TransformUpdated() override;
    virtual void UpdateEnd() override;
    virtual void WorldSurfaceScaleUpdated() override;
    virtual CYIString GetDumpTreeString() const override;

    void SetTextDirty();

    static bool HasAllCaps(const YI_TEXT_DEF &rTextDef);

    static void UpdateTextForAllCaps(const YI_TEXT_DEF &rTextDef, CYIString &rText);

    virtual void UpdateTextRect();

    YI_TEXT_DEF  m_TextDef;                     
    CYIString m_markedUpText;                   
    YI_RECT_REL m_BoxRect;                      
    YI_RECT_REL m_LayoutRect;                   
    YI_RECT_REL m_MeasuredBoxRect;              
    YI_RECT_REL m_PreferredBoxRect;             
    float m_fTextMaxWidth; 
    bool m_bTextBufferDirty;                    
    bool m_bIsBoxType;                          
    bool m_bTextRectDirty;                      
    bool m_bUsesFontTables;                     
private:
    void CreateTextMesh();

    float m_fTextOffsetX;
    std::shared_ptr<const CYITextLayout> m_pCachedTextLayout;
    YI_TEXT_RENDER_INFO m_cachedTextRenderInfo;

    YI_TYPE_BASES(CYITextSceneNode, CYISceneNode)
};

#ifdef YI_FUNCTION_SPECIALIZATION_FULLY_SUPPORTED
template<>
inline const CYITextSceneNode *YiDynamicCast<CYITextSceneNode>(const CYISceneNode *pObject)
{
    return pObject ? (pObject->CanCastTo<CYITextSceneNode>() ? static_cast<const CYITextSceneNode *>(pObject) : nullptr) : nullptr;
}
#endif

#endif // _YI_TEXT_SCENE_NODE_H_