EdGraphNodeUtils.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "EdGraph/EdGraphSchema.h"
#include "Misc/ConfigCacheIni.h"
 
#if WITH_EDITOR
 
/*******************************************************************************
 * FNodeTextCache
 ******************************************************************************/
 
struct FNodeTextCache
{
public:
    FNodeTextCache() :
        CacheRefreshID(0)
    {}
 
    inline bool IsOutOfDate(const UEdGraphNode* InOwningNode) const
    {
        return CachedText.IsEmpty() || (InOwningNode && InOwningNode->GetGraph() && InOwningNode->GetSchema()->IsCacheVisualizationOutOfDate(CacheRefreshID));
    }
 
    inline bool IsOutOfDate(const UEdGraphSchema* InSchema) const
    {
        return CachedText.IsEmpty() || (InSchema && InSchema->IsCacheVisualizationOutOfDate(CacheRefreshID));
    }
 
    inline void SetCachedText(FText const& InText, const UEdGraphNode* InOwningNode) const
    {
        UpdateCacheIternal(InText);
 
        if (InOwningNode && InOwningNode->GetGraph())
        {
            // Update the CacheRefreshID, whenever these values do not match the cached value is out of date
            CacheRefreshID = InOwningNode->GetSchema()->GetCurrentVisualizationCacheID();
        }
    }
 
    inline void SetCachedText(FText const& InText, const UEdGraphSchema* InSchema) const
    {
        UpdateCacheIternal(InText);
 
        if (InSchema)
        {
            // Update the CacheRefreshID, whenever these values do not match the cached value is out of date
            CacheRefreshID = InSchema->GetCurrentVisualizationCacheID();
        }
    }
 
    inline FText& GetCachedText() const
    {
        return CachedText;
    }
 
    inline void MarkDirty() const
    {
        Clear();
        CacheRefreshID = 0;
    }
 
    inline void Clear() const
    {
        CachedText = FText::GetEmpty();
    }
 
    inline operator FText&() const
    {
        return GetCachedText();
    }
 
private:
    inline void UpdateCacheIternal(FText const& InText) const
    {
        bool bShouldUseLocalizedNodeAndPinNames = false;
        GConfig->GetBool( TEXT("Internationalization"), TEXT("ShouldUseLocalizedNodeAndPinNames"), bShouldUseLocalizedNodeAndPinNames, GEditorSettingsIni );
 
        if (bShouldUseLocalizedNodeAndPinNames)
        {
            CachedText = InText;
        }
        else
        {
            CachedText = FText::FromString(InText.BuildSourceString());
        }
    }
 
private:
    mutable FText CachedText;
 
    mutable int32 CacheRefreshID;
};
 
/*******************************************************************************
 * FNodeTitleTextTable
 ******************************************************************************/
 
struct FNodeTitleTextTable
{
public:
    inline bool IsTitleCached(ENodeTitleType::Type InTitleType, const UEdGraphNode* InOwningNode) const
    {
        return !CachedNodeTitles[InTitleType].IsOutOfDate(InOwningNode);
    }
 
    inline void SetCachedTitle(ENodeTitleType::Type InTitleType, FText const& InText, const UEdGraphNode* InOwningNode) const
    {
        CachedNodeTitles[InTitleType].SetCachedText(InText, InOwningNode);
    }
 
    inline FText& GetCachedTitle(ENodeTitleType::Type TitleType) const
    {
        return CachedNodeTitles[TitleType].GetCachedText();
    }
 
    inline void MarkDirty() const
    {
        for (uint32 TitleIndex = 0; TitleIndex < ENodeTitleType::MAX_TitleTypes; ++TitleIndex)
        {
            CachedNodeTitles[TitleIndex].MarkDirty();
        }
    }
 
    inline FText& operator[](ENodeTitleType::Type TitleIndex) const
    {
        return GetCachedTitle(TitleIndex);
    }
 
private:
    FNodeTextCache CachedNodeTitles[ENodeTitleType::MAX_TitleTypes];
};
 
/*******************************************************************************
* FNodeTextTable
******************************************************************************/
 
struct FNodeTextTable : FNodeTitleTextTable
{
public:
    inline bool IsTooltipCached(const UEdGraphNode* InOwningNode) const
    {
        const UEdGraphSchema* NullSchema = nullptr;
        return !CachedTooltip.IsOutOfDate(NullSchema);
    }
 
    inline void SetCachedTooltip(FText const& InText, const UEdGraphNode* InOwningNode) const
    {
        const UEdGraphSchema* NullSchema = nullptr;
        CachedTooltip.SetCachedText(InText, NullSchema);
    }
 
    inline FText GetCachedTooltip() const
    {
        return CachedTooltip.GetCachedText();
    }
 
    inline void MarkDirty() const
    {
        FNodeTitleTextTable::MarkDirty();
        CachedTooltip.MarkDirty();
    }
 
private:
    FNodeTextCache CachedTooltip;
};
 
#endif