MaterialParameterCollection.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "HAL/ThreadSafeBool.h"
#include "Misc/Guid.h"
#include "Templates/UniquePtr.h"
#include "RenderCommandFence.h"
#include "MaterialParameterCollection.generated.h"
 
class FShaderParametersMetadata;
struct FPropertyChangedEvent;
 
USTRUCT()
struct FCollectionParameterBase
{
    GENERATED_USTRUCT_BODY()
    
    FCollectionParameterBase()
    {
        FPlatformMisc::CreateGuid(Id);
    }
    
    UPROPERTY(EditAnywhere, Category=Parameter)
    FName ParameterName;
 
    UPROPERTY(meta = (IgnoreForMemberInitializationTest))
    FGuid Id;
};
 
USTRUCT()
struct FCollectionScalarParameter : public FCollectionParameterBase
{
    GENERATED_USTRUCT_BODY()
 
    FCollectionScalarParameter()
        : DefaultValue(0.0f)
    {
        ParameterName = FName(TEXT("Scalar"));
    }
 
    UPROPERTY(EditAnywhere, Category=Parameter)
    float DefaultValue;
};
 
USTRUCT()
struct FCollectionVectorParameter : public FCollectionParameterBase
{
    GENERATED_USTRUCT_BODY()
    
    FCollectionVectorParameter()
        : DefaultValue(ForceInitToZero)
    {
        ParameterName = FName(TEXT("Vector"));
    }
    
    UPROPERTY(EditAnywhere, Category=Parameter)
    FLinearColor DefaultValue;
};
 
UCLASS(hidecategories=object, MinimalAPI, BlueprintType)
class UMaterialParameterCollection : public UObject
{
    GENERATED_UCLASS_BODY()
 
    friend class FMaterialParameterCollectionDetails;
 
public:
 
    UPROPERTY(duplicatetransient)
    FGuid StateId;
 
    UPROPERTY(EditAnywhere, Category=Material, Meta = (TitleProperty = "ParameterName"))
    TArray<FCollectionScalarParameter> ScalarParameters;
 
    UPROPERTY(EditAnywhere, Category=Material, Meta = (TitleProperty = "ParameterName"))
    TArray<FCollectionVectorParameter> VectorParameters;
    
#if WITH_EDITOR
    bool SetScalarParameterDefaultValueByInfo(FCollectionScalarParameter ScalarParameter);
 
    bool SetScalarParameterDefaultValue(FName ParameterName, const float Value);
 
    bool SetVectorParameterDefaultValueByInfo(FCollectionVectorParameter VectorParameter);
    
    bool SetVectorParameterDefaultValue(FName ParameterName, const FLinearColor& Value);
#endif // WITH_EDITOR
 
    int32 GetScalarParameterIndexByName(FName ParameterName) const;
 
    int32 GetVectorParameterIndexByName(FName ParameterName) const;
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Material", meta=(Keywords="GetScalarParameterNames"))
    ENGINE_API TArray<FName> GetScalarParameterNames() const;
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Material", meta=(Keywords="GetVectorParameterNames"))
    ENGINE_API TArray<FName> GetVectorParameterNames() const;
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Material", meta=(Keywords="GetFloatParameterDefaultValue"))
    ENGINE_API float GetScalarParameterDefaultValue(FName ParameterName, bool& bParameterFound) const;
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Material", meta=(Keywords="GetFloatParameterDefaultValue"))
    ENGINE_API FLinearColor GetVectorParameterDefaultValue(FName ParameterName, bool& bParameterFound) const;
    
    UFUNCTION(BlueprintCallable, Category="Rendering|Material")
    ENGINE_API UMaterialParameterCollection* GetBaseParameterCollection() const;
 
    //~ Begin UObject Interface.
#if WITH_EDITOR
    using Super::PreEditChange;
    virtual void PreEditChange(FProperty* PropertyThatWillChange) override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    virtual void PostInitProperties() override;
    virtual void PostLoad() override;
    virtual void BeginDestroy() override;
    virtual bool CanBeInCluster() const override { return false; }
    //~ End UObject Interface.
 
    ENGINE_API FName GetParameterName(const FGuid& Id) const;
 
    ENGINE_API FGuid GetParameterId(FName ParameterName) const;
 
    ENGINE_API void GetParameterIndex(const FGuid& Id, int32& OutIndex, int32& OutComponentIndex) const;
 
    ENGINE_API int32 GetTotalVectorStorage() const;
 
    ENGINE_API void GetParameterNames(TArray<FName>& OutParameterNames, bool bVectorParameters) const;
 
    ENGINE_API const FCollectionScalarParameter* GetScalarParameterByName(FName ParameterName) const;
 
    ENGINE_API const FCollectionVectorParameter* GetVectorParameterByName(FName ParameterName) const;
 
    const FShaderParametersMetadata& GetUniformBufferStruct() const
    {
        check(UniformBufferStruct);
        return *UniformBufferStruct;
    }
 
    bool HasValidUniformBufferStruct() const
    {
        return UniformBufferStruct.IsValid();
    }
 
    ENGINE_API void SetupWorldParameterCollectionInstances();
 
    ENGINE_API void GetParameterData(TArray<FVector4f>& ParameterData, const TMap<FName, float>* ScalarParameterInstanceOverrides, const TMap<FName, FLinearColor>* VectorParameterInstanceOverrides) const;
 
    ENGINE_API bool IsInstanceOf(const FGuid& CollectionStateId) const;
 
#if WITH_EDITOR
    static ENGINE_API FName GetBaseParameterCollectionMemberName();
 
    DECLARE_MULTICAST_DELEGATE(FOnCollectionChanged);
    FOnCollectionChanged& OnCollectionChanged() const
    {
        return CollectionChangedDelegate;
    }
#endif
 
private:
    virtual ENGINE_API void FinishDestroy() override;
    virtual ENGINE_API bool IsReadyForFinishDestroy() override;
 
    template<typename FCollectionParameterType>
    void SanitizeParameters(TArray<FCollectionParameterType> UMaterialParameterCollection::* CollectionParameters);
 
    bool UpdateOverrides(UMaterialParameterCollection* BaseCollection);
 
    UPROPERTY(EditAnywhere, Category=Material, AssetRegistrySearchable)
    TObjectPtr<UMaterialParameterCollection> Base;
 
    UPROPERTY()
    FGuid BaseStateId;
 
    UPROPERTY()
    TMap<FGuid, float> ScalarParameterBaseOverrides;
 
    UPROPERTY()
    TMap<FGuid, FLinearColor> VectorParameterBaseOverrides;
 
    FThreadSafeBool ReleasedByRT;
 
    class FMaterialParameterCollectionInstanceResource* DefaultResource;
 
    TUniquePtr<FShaderParametersMetadata> UniformBufferStruct;
 
#if WITH_EDITOR
    mutable FOnCollectionChanged CollectionChangedDelegate;
#endif
 
    void CreateBufferStruct();
 
    void GetDefaultParameterData(TArray<FVector4f>& ParameterData) const;
 
    void UpdateDefaultResource(bool bRecreateUniformBuffer);
};