MaterialCachedData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Templates/SharedPointer.h"
#include "Materials/MaterialParameters.h"
#include "Materials/MaterialLayersFunctions.h"
#include "Misc/Guid.h"
#include "UObject/ObjectMacros.h"
#include "UObject/SoftObjectPtr.h"
#include "SceneTypes.h"
#include "MaterialCachedData.generated.h"
 
class UTexture;
class UTextureCollection;
class UCurveLinearColor;
class UCurveLinearColorAtlas;
class UFont;
class UMaterial;
class UMaterialExpression;
class UMaterialExpressionExternalCodeBase;
class UMaterialParameterCollection;
class URuntimeVirtualTexture;
class ULandscapeGrassType;
class UMaterialCacheVirtualTextureTag;
class UMaterialFunctionInterface;
class UMaterialInterface;
struct FStaticParameterSet;
class IMaterialEnumerationProvider;
 
USTRUCT()
struct FMaterialFunctionInfo
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    FGuid StateId;
 
    UPROPERTY()
    TObjectPtr<UMaterialFunctionInterface> Function = nullptr;
};
inline bool operator==(const FMaterialFunctionInfo& Lhs, const FMaterialFunctionInfo& Rhs)
{
    return Lhs.Function == Rhs.Function;
}
inline bool operator!=(const FMaterialFunctionInfo& Lhs, const FMaterialFunctionInfo& Rhs)
{
    return !operator==(Lhs, Rhs);
}
 
USTRUCT()
struct FMaterialParameterCollectionInfo
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    FGuid StateId;
 
    UPROPERTY()
    TObjectPtr<UMaterialParameterCollection> ParameterCollection = nullptr;
 
    bool operator==(const FMaterialParameterCollectionInfo& Other) const
    {
        return StateId == Other.StateId && ParameterCollection == Other.ParameterCollection;
    }
};
 
USTRUCT()
struct FMaterialCachedParameterEditorInfo
{
    GENERATED_USTRUCT_BODY()
 
    FMaterialCachedParameterEditorInfo() = default;
    FMaterialCachedParameterEditorInfo(const FGuid& InGuid) : ExpressionGuid(InGuid) {}
    FMaterialCachedParameterEditorInfo(const FGuid& InGuid, const FString& InDescription, const FName& InGroup, int32 InSortPriority, int32 InAssetIndex)
        : Description(InDescription)
        , Group(InGroup)
        , SortPriority(InSortPriority)
        , AssetIndex(InAssetIndex)
        , ExpressionGuid(InGuid)
    {}
 
    UPROPERTY()
    FString Description;
 
    UPROPERTY()
    FName Group;
 
    UPROPERTY()
    int32 SortPriority = 0;
 
    UPROPERTY()
    int32 AssetIndex = INDEX_NONE;
 
    UPROPERTY()
    FGuid ExpressionGuid;
};
 
USTRUCT()
struct FMaterialCachedParameterEntry
{
    GENERATED_USTRUCT_BODY()
 
    ENGINE_API static const FMaterialCachedParameterEntry EmptyData;
 
    // This is used to map FMaterialParameterInfos to indices, which are then used to index various TArrays containing values for each type of parameter
    // (ExpressionGuids and Overrides, along with ScalarValues, VectorValues, etc)
    UPROPERTY()
    TSet<FMaterialParameterInfo> ParameterInfoSet;
};
 
USTRUCT()
struct FMaterialCachedParameterEditorEntry
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY()
    TArray<FMaterialCachedParameterEditorInfo> EditorInfo;
};
 
struct FMaterialCachedExpressionContext
{
    const UMaterialFunctionInterface* CurrentFunction = nullptr;
    const FMaterialLayersFunctions* LayerOverrides = nullptr;
    bool bUpdateFunctionExpressions = true;
};
 
USTRUCT()
struct FMaterialCachedExpressionEditorOnlyData
{
    GENERATED_USTRUCT_BODY()
 
    ENGINE_API static const FMaterialCachedExpressionEditorOnlyData EmptyData;
 
    UPROPERTY()
    FMaterialCachedParameterEntry EditorOnlyEntries[NumMaterialEditorOnlyParameterTypes];
 
    UPROPERTY()
    FMaterialCachedParameterEditorEntry EditorEntries[NumMaterialParameterTypes];
 
    UPROPERTY()
    TArray<bool> StaticSwitchValues_DEPRECATED;
 
    UPROPERTY()
    TArray<FStaticComponentMaskValue> StaticComponentMaskValues;
 
    UPROPERTY()
    TArray<FVector2D> ScalarMinMaxValues;
 
    UPROPERTY()
    TArray<TSoftObjectPtr<UObject>> ScalarEnumerationValues;
    
    UPROPERTY()
    TArray<int32> ScalarEnumerationIndexValues;
 
    UPROPERTY()
    TArray<TSoftObjectPtr<UCurveLinearColor>> ScalarCurveValues;
 
    UPROPERTY()
    TArray<TSoftObjectPtr<UCurveLinearColorAtlas>> ScalarCurveAtlasValues;
 
    UPROPERTY()
    TArray<FParameterChannelNames> VectorChannelNameValues;
 
    UPROPERTY()
    TArray<bool> VectorUsedAsChannelMaskValues;
 
    UPROPERTY()
    TArray<FParameterChannelNames> TextureChannelNameValues;
 
    UPROPERTY()
    FMaterialLayersFunctionsEditorOnlyData MaterialLayers;
 
    UPROPERTY()
    TArray<FString> AssetPaths;
 
    UPROPERTY()
    TArray<FName> LandscapeLayerNames;
 
    UPROPERTY()
    TSet<FString> ExpressionIncludeFilePaths;
 
    UPROPERTY()
    TSet<FName> UserSceneTextureInputs;
 
    UPROPERTY()
    TArray<FName> ShaderTags;
};
 
USTRUCT()
struct FMaterialCachedExpressionData
{
    GENERATED_USTRUCT_BODY()
    
    ENGINE_API static const FMaterialCachedExpressionData EmptyData;
 
    ENGINE_API FMaterialCachedExpressionData();
 
#if WITH_EDITOR
    void UpdateForExpressions(const FMaterialCachedExpressionContext& Context, TConstArrayView<TObjectPtr<UMaterialExpression>> Expressions, EMaterialParameterAssociation Association, int32 ParameterIndex);
    void UpdateForFunction(const FMaterialCachedExpressionContext& Context, UMaterialFunctionInterface* Function, EMaterialParameterAssociation Association, int32 ParameterIndex);
    void UpdateForLayerFunctions(const FMaterialCachedExpressionContext& Context, const FMaterialLayersFunctions& LayerFunctions);
    void AnalyzeMaterial(UMaterial& Material);
 
    void Validate(const UMaterialInterface& Material);
 
    bool AddParameter(const FMaterialParameterInfo& ParameterInfo, const FMaterialParameterMetadata& ParameterMeta, UObject*& OutReferencedTexture, UTextureCollection*& OutReferencedTextureCollection, FText& OutErrorMessage);
 
    bool AddParameter(const FMaterialParameterInfo& ParameterInfo, const FMaterialParameterMetadata& ParameterMeta, UObject*& OutReferencedTexture, FText& OutErrorMessage)
    {
        UTextureCollection* UnusedReferencedTextureCollection = nullptr;
        return AddParameter(ParameterInfo, ParameterMeta, OutReferencedTexture, UnusedReferencedTextureCollection, OutErrorMessage);
    }
#endif // WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
    inline FMaterialCachedParameterEntry& GetParameterTypeEntry(EMaterialParameterType Type)
    {
        const int32 TypeIndex = (int32)Type;
        if (TypeIndex < NumMaterialRuntimeParameterTypes)
        {
            return RuntimeEntries[TypeIndex];
        }
        check(EditorOnlyData);
        return EditorOnlyData->EditorOnlyEntries[TypeIndex - NumMaterialRuntimeParameterTypes];
    }
    inline FMaterialCachedParameterEditorEntry& GetParameterEditorTypeEntry(EMaterialParameterType Type)
    {
        check(EditorOnlyData);
        return EditorOnlyData->EditorEntries[(int32)Type];
    }
 
    inline const FMaterialCachedParameterEntry& GetParameterTypeEntry(EMaterialParameterType Type) const
    {
        return const_cast<FMaterialCachedExpressionData*>(this)->GetParameterTypeEntry(Type);
    }
    inline const FMaterialCachedParameterEditorEntry& GetParameterEditorTypeEntry(EMaterialParameterType Type) const
    {
        check(EditorOnlyData);
        return EditorOnlyData->EditorEntries[(int32)Type];
    }
#else
    inline const FMaterialCachedParameterEntry& GetParameterTypeEntry(EMaterialParameterType Type) const { return Type >= EMaterialParameterType::NumRuntime ? FMaterialCachedParameterEntry::EmptyData : RuntimeEntries[static_cast<int32>(Type)]; }
#endif
 
    inline int32 GetNumParameters(EMaterialParameterType Type) const { return GetParameterTypeEntry(Type).ParameterInfoSet.Num(); }
    int32 FindParameterIndex(EMaterialParameterType Type, const FMemoryImageMaterialParameterInfo& HashedParameterInfo) const;
    ENGINE_API bool GetParameterValue(EMaterialParameterType Type, const FMemoryImageMaterialParameterInfo& ParameterInfo, FMaterialParameterMetadata& OutResult) const;
    void GetParameterValueByIndex(EMaterialParameterType Type, int32 ParameterIndex, FMaterialParameterMetadata& OutResult) const;
    const FGuid& GetExpressionGuid(EMaterialParameterType Type, int32 Index) const;
    void GetAllParametersOfType(EMaterialParameterType Type, TMap<FMaterialParameterInfo, FMaterialParameterMetadata>& OutParameters) const;
    void GetAllParameterInfoOfType(EMaterialParameterType Type, TArray<FMaterialParameterInfo>& OutParameterInfo, TArray<FGuid>& OutParameterIds) const;
    void GetAllGlobalParametersOfType(EMaterialParameterType Type, TMap<FMaterialParameterInfo, FMaterialParameterMetadata>& OutParameters) const;
    void GetAllGlobalParameterInfoOfType(EMaterialParameterType Type, TArray<FMaterialParameterInfo>& OutParameterInfo, TArray<FGuid>& OutParameterIds) const;
 
    ENGINE_API void AddReferencedObjects(FReferenceCollector& Collector);
 
    void AppendReferencedFunctionIdsTo(TArray<FGuid>& OutIds) const;
 
    void AppendReferencedParameterCollectionIdsTo(TArray<FGuid>& OutIds) const;
 
    void GetExternalCodeReferencesHash(FSHAHash& OutHash) const;
 
    bool IsPropertyConnected(EMaterialProperty Property) const
    {
        return ((PropertyConnectedMask >> (uint64)Property) & 0x1) != 0;
    }
 
    void SetPropertyConnected(EMaterialProperty Property)
    {
        PropertyConnectedMask |= (1ull << (uint64)Property);
    }
 
    bool Serialize(FArchive& Ar);
    void PostSerialize(const FArchive& Ar);
 
#if WITH_EDITORONLY_DATA
    TSharedPtr<FMaterialCachedExpressionEditorOnlyData> EditorOnlyData;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY()
    FMaterialCachedParameterEntry RuntimeEntries[NumMaterialRuntimeParameterTypes];
 
    UPROPERTY()
    TArray<int32> ScalarPrimitiveDataIndexValues;
 
    UPROPERTY()
    TArray<int32> VectorPrimitiveDataIndexValues;
 
    UPROPERTY()
    TArray<float> ScalarValues;
 
    UPROPERTY()
    TArray<bool> StaticSwitchValues;
 
    UPROPERTY()
    TArray<bool> DynamicSwitchValues;
    
    UPROPERTY()
    TArray<FLinearColor> VectorValues;
 
    UPROPERTY()
    TArray<FVector4d> DoubleVectorValues;
 
    UPROPERTY()
    TArray<TSoftObjectPtr<UTexture>> TextureValues;
 
    UPROPERTY()
    TArray<TSoftObjectPtr<UTextureCollection>> TextureCollectionValues;
 
    UPROPERTY()
    TArray<TSoftObjectPtr<UMaterialParameterCollection>> ParameterCollectionValues;
 
    UPROPERTY()
    TArray<TSoftObjectPtr<UFont>> FontValues;
 
    UPROPERTY()
    TArray<int32> FontPageValues;
    
    UPROPERTY()
    TArray<TSoftObjectPtr<URuntimeVirtualTexture>> RuntimeVirtualTextureValues;
 
    UPROPERTY()
    TArray<TSoftObjectPtr<USparseVolumeTexture>> SparseVolumeTextureValues;
 
    UPROPERTY()
    TArray<TObjectPtr<UObject>> ReferencedTextures;
 
    UPROPERTY()
    TArray<TObjectPtr<UTextureCollection>> ReferencedTextureCollections;
 
    UPROPERTY()
    TArray<TObjectPtr<UClass>> ReferencedExternalCodeExpressionClasses;
 
    UPROPERTY()
    TArray<FMaterialFunctionInfo> FunctionInfos;
 
    UPROPERTY()
    uint32 FunctionInfosStateCRC;
 
    UPROPERTY()
    TArray<FMaterialParameterCollectionInfo> ParameterCollectionInfos;
 
    UPROPERTY()
    TArray<TObjectPtr<ULandscapeGrassType>> GrassTypes;
    
    UPROPERTY()
    TArray<TObjectPtr<UMaterialCacheVirtualTextureTag>> MaterialCacheTags;
 
    UPROPERTY()
    FMaterialLayersFunctionsRuntimeData MaterialLayers;
 
    UPROPERTY()
    TArray<FName> DynamicParameterNames;
 
    UPROPERTY()
    TArray<bool> QualityLevelsUsed;
 
    UPROPERTY()
    uint64 MaterialCacheUVCoordinatesUsedMask = 0x0;
 
    UPROPERTY()
    uint32 bHasMaterialLayers : 1;
 
    UPROPERTY()
    uint32 bHasRuntimeVirtualTextureOutput : 1;
 
    UPROPERTY()
    uint32 bHasFirstPersonOutput : 1;
 
    UPROPERTY()
    uint32 bUsesTemporalResponsiveness : 1;
 
    UPROPERTY()
    uint32 bUsesMotionVectorWorldOffset : 1;
 
    UPROPERTY()
    uint32 bSamplesMaterialCache : 1;
 
    UPROPERTY()
    uint32 bHasMaterialCacheOutput : 1;
 
    UPROPERTY()
    uint32 bMaterialCacheHasNonUVDerivedExpression : 1;
 
    UPROPERTY()
    uint32 bHasSceneColor : 1;
 
    UPROPERTY()
    uint32 bHasPerInstanceCustomData : 1;
 
    UPROPERTY()
    uint32 bHasPerInstanceRandom : 1;
 
    UPROPERTY()
    uint32 bHasVertexInterpolator : 1;
 
    UPROPERTY()
    uint32 bHasCustomizedUVs : 1;
 
    UPROPERTY()
    uint32 bHasMeshPaintTexture : 1;
 
    UPROPERTY()
    uint32 bHasWorldPosition : 1;
 
    UPROPERTY()
    uint32 PropertyConnectedBitmask_DEPRECATED = 0;
 
    UPROPERTY()
    uint64 PropertyConnectedMask = 0;
 
#if WITH_EDITOR
    TArray<TPair<TObjectPtr<class UMaterialExpression>, FString>> DuplicateParameterErrors;
#endif
};
 
template<>
struct TStructOpsTypeTraits<FMaterialCachedExpressionData> : public TStructOpsTypeTraitsBase2<FMaterialCachedExpressionData>
{
    enum
    {
        WithSerializer = true,
        WithPostSerialize = true,
    };
};