MaterialAttributeDefinitionMap.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/UnrealString.h"
#include "MaterialValueType.h"
#include "Math/Vector4.h"
#include "Misc/Guid.h"
 
enum EMaterialProperty : int;
enum EMaterialShadingModel : int;
enum EShaderFrequency : uint8;
 
class FMaterialCompiler;
class FShaderKeyGenerator;
class UMaterial;
 
struct FMaterialShadingModelField;
 
typedef int32(*MaterialAttributeBlendFunction)(FMaterialCompiler* Compiler, int32 A, int32 B, int32 Alpha);
 
class FMaterialAttributeDefintion
{
public:
    FMaterialAttributeDefintion(const FGuid& InGUID, const FString& AttributeName, EMaterialProperty InProperty,
        EMaterialValueType InValueType, const FVector4& InDefaultValue, EShaderFrequency InShaderFrequency,
        int32 InTexCoordIndex = INDEX_NONE, bool bInIsHidden = false, MaterialAttributeBlendFunction InBlendFunction = nullptr);
 
    ENGINE_API int32 CompileDefaultValue(FMaterialCompiler* Compiler) const;
 
    bool operator==(const FMaterialAttributeDefintion& Other) const
    {
        return (AttributeID == Other.AttributeID);
    }
 
    FGuid               AttributeID;
    FVector4            DefaultValue;
    FString             AttributeName;
    EMaterialProperty   Property;
    EMaterialValueType  ValueType;
    EShaderFrequency    ShaderFrequency;
    int32               TexCoordIndex;
 
    // Optional function pointer for custom blend behavior
    MaterialAttributeBlendFunction BlendFunction;
 
    // Hidden from auto-generated lists but valid for manual material creation
    bool                bIsHidden;
};
 
class FMaterialCustomOutputAttributeDefintion : public FMaterialAttributeDefintion
{
public:
    FMaterialCustomOutputAttributeDefintion(const FGuid& InGUID, UClass* InExpressionClass, const FString& InAttributeName, const FString& InFunctionName, int32 InOutputIndex, bool bInNeedsPreviousFrameEvaluation, EMaterialProperty InProperty,
        EMaterialValueType InValueType, const FVector4& InDefaultValue, EShaderFrequency InShaderFrequency, MaterialAttributeBlendFunction InBlendFunction = nullptr);
 
    bool operator==(const FMaterialCustomOutputAttributeDefintion& Other) const
    {
        return (AttributeID == Other.AttributeID);
    }
 
    UClass*             CustomOutputExpressionStaticClass;
    FString             FunctionName; // Name of function used to access attribute in shader code
    int32               OutputIndex;
    bool                bNeedsPreviousFrameEvaluation;
};
 
class FMaterialAttributeDefinitionMap
{
public:
    ENGINE_API FMaterialAttributeDefinitionMap();
 
    static ENGINE_API int32 CompileDefaultExpression(FMaterialCompiler* Compiler, EMaterialProperty Property);
 
    static ENGINE_API int32 CompileDefaultExpression(FMaterialCompiler* Compiler, const FGuid& AttributeID);
 
    static ENGINE_API const FString& GetAttributeName(EMaterialProperty Property);
 
    static ENGINE_API const FString& GetAttributeName(const FGuid& AttributeID);
 
    static ENGINE_API FText GetDisplayNameForMaterial(EMaterialProperty Property, UMaterial* Material);
 
    static ENGINE_API FText GetDisplayNameForMaterial(const FGuid& AttributeID, UMaterial* Material);
 
    static ENGINE_API EMaterialValueType GetValueType(EMaterialProperty Property);
 
    static ENGINE_API EMaterialValueType GetValueType(const FGuid& AttributeID);
 
    static ENGINE_API FVector4f GetDefaultValue(EMaterialProperty Property);
 
    static ENGINE_API FVector4f GetDefaultValue(const FGuid& AttributeID);
 
    static ENGINE_API EShaderFrequency GetShaderFrequency(EMaterialProperty Property);
 
    static ENGINE_API EShaderFrequency GetShaderFrequency(const FGuid& AttributeID);
 
    static ENGINE_API int32 GetIndex(EMaterialProperty Property);
 
    static ENGINE_API int32 GetIndex(const FGuid& AttributeID);
 
    static ENGINE_API uint64 GetBitmask(EMaterialProperty Property);
 
    static ENGINE_API uint64 GetBitmask(const FGuid& AttributeID);
 
    static ENGINE_API bool IsAttributeInBitmask(uint64 Bitmask, EMaterialProperty Property);
 
    static ENGINE_API bool IsAttributeInBitmask(uint64 Bitmask, const FGuid& AttributeID);
 
    static ENGINE_API FGuid GetID(EMaterialProperty Property);
 
    static ENGINE_API EMaterialProperty GetProperty(const FGuid& AttributeID);
 
    static ENGINE_API MaterialAttributeBlendFunction GetBlendFunction(const FGuid& AttributeID);
 
    static ENGINE_API FGuid GetDefaultID();
 
    static ENGINE_API void AppendDDCKeyString(FString& String);
    static ENGINE_API void AppendDDCKey(FShaderKeyGenerator& KeyGen);
 
    static ENGINE_API void AddCustomAttribute(const FGuid& AttributeID, UClass* ExpressionClass, const FString& AttributeName, const FString& FunctionName, int32 OutputIndex, EMaterialValueType ValueType, const FVector4& DefaultValue, EShaderFrequency ShaderFrequency, bool bNeedsPreviousFrameEvaluation = false, MaterialAttributeBlendFunction BlendFunction = nullptr);
 
    static ENGINE_API FGuid GetCustomAttributeID(const FString& AttributeName);
 
    static ENGINE_API const FMaterialCustomOutputAttributeDefintion* GetCustomAttribute(const FString& AttributeName);
 
    static ENGINE_API const FMaterialCustomOutputAttributeDefintion* GetCustomAttribute(const FGuid& AttributeID);
 
    static ENGINE_API void GetCustomAttributeList(TArray<FMaterialCustomOutputAttributeDefintion>& CustomAttributeList);
 
    static const TArray<FGuid>& GetOrderedVisibleAttributeList()
    {
        return GMaterialPropertyAttributesMap.OrderedVisibleAttributeList;
    }
 
#if WITH_EDITOR
    static ENGINE_API uint64 GetConnectedMaterialAttributesBitmask(TConstArrayView<TObjectPtr<class UMaterialExpression>> Expressions);
    static ENGINE_API uint64 GetConnectedMaterialAttributesBitmask(TConstArrayView<class UMaterialExpression*> Expressions);
    static ENGINE_API uint64 GetCustomOutputNodesBitmask(TConstArrayView<class UMaterialExpressionCustomOutput*> Expressions);
#endif
 
private:
    // Customization class for displaying data in the material editor
    friend class FMaterialAttributePropertyDetails;
 
    static ENGINE_API void GetAttributeNameToIDList(TArray<TPair<FString, FGuid>>& NameToIDList);
 
    // Internal map management
    ENGINE_API void InitializeAttributeMap();
 
    ENGINE_API void Add(const FGuid& AttributeID, const FString& AttributeName, EMaterialProperty Property,
        EMaterialValueType ValueType, const FVector4& DefaultValue, EShaderFrequency ShaderFrequency,
        int32 TexCoordIndex = INDEX_NONE, bool bIsHidden = false, MaterialAttributeBlendFunction BlendFunction = nullptr);
 
    ENGINE_API FMaterialAttributeDefintion* Find(const FGuid& AttributeID);
    ENGINE_API FMaterialAttributeDefintion* Find(EMaterialProperty Property);
 
    // Helper functions to determine display name based on shader model, material domain, etc.
    static ENGINE_API FText GetAttributeOverrideForMaterial(const FGuid& AttributeID, UMaterial* Material);
    static ENGINE_API FString GetPinNameFromShadingModelField(FMaterialShadingModelField InShadingModels, const TArray<TKeyValuePair<EMaterialShadingModel, FString>>& InCustomShadingModelPinNames, const FString& InDefaultPinName);
 
#if WITH_EDITOR
    template<typename ExpressionsArrayType>
    static ENGINE_API uint64 GetConnectedMaterialAttributesBitmask_Internal(const ExpressionsArrayType& Expressions);
#endif
 
    static ENGINE_API FMaterialAttributeDefinitionMap GMaterialPropertyAttributesMap;
 
    TMap<EMaterialProperty, FMaterialAttributeDefintion>    AttributeMap; // Fixed map of compile-time definitions
    TArray<FMaterialCustomOutputAttributeDefintion>         CustomAttributes; // Array of custom output definitions
    TArray<FGuid>                                           OrderedVisibleAttributeList; // List used for consistency with e.g. combobox filling
 
    FString                                                 AttributeDDCString;
    bool bIsInitialized;
};