MaterialParameterCollectionInstance.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 "MaterialParameterCollectionInstance.generated.h"
 
struct FCollectionScalarParameter;
struct FCollectionVectorParameter;
class FMaterialParameterCollectionInstanceResource;
class UMaterialParameterCollection;
 
UCLASS(hidecategories=object, MinimalAPI)
class UMaterialParameterCollectionInstance : public UObject
{
    GENERATED_UCLASS_BODY()
 
    //~ Begin UObject Interface.
    ENGINE_API virtual void PostInitProperties() override;
    ENGINE_API virtual void FinishDestroy() override;
    //~ End UObject Interface.
 
    ENGINE_API void SetCollection(UMaterialParameterCollection* InCollection, UWorld* InWorld);
 
    bool IsCollectionValid() const { return Collection.IsValid(); }
 
    ENGINE_API bool SetScalarParameterValue(FName ParameterName, float ParameterValue);
    ENGINE_API bool SetVectorParameterValue(FName ParameterName, const FLinearColor& ParameterValue);
    bool SetVectorParameterValue(FName ParameterName, const FVector& ParameterValue) { return SetVectorParameterValue(ParameterName, FLinearColor(ParameterValue)); }
    bool SetVectorParameterValue(FName ParameterName, const FVector4& ParameterValue) { return SetVectorParameterValue(ParameterName, FLinearColor(ParameterValue)); }
 
    ENGINE_API bool GetScalarParameterValue(FName ParameterName, float& OutParameterValue) const;
    ENGINE_API bool GetVectorParameterValue(FName ParameterName, FLinearColor& OutParameterValue) const;
 
    ENGINE_API bool GetScalarParameterValue(const FCollectionScalarParameter& Parameter, float& OutParameterValue) const;
    ENGINE_API bool GetVectorParameterValue(const FCollectionVectorParameter& Parameter, FLinearColor& OutParameterValue) const;
 
    class FMaterialParameterCollectionInstanceResource* GetResource()
    {
        return Resource;
    }
 
    const UMaterialParameterCollection* GetCollection() const
    {
        return Collection.Get();
    }
 
    using ScalarParameterUpdate = TPair<FName, float>;
    DECLARE_MULTICAST_DELEGATE_OneParam(FOnScalarParameterUpdated, ScalarParameterUpdate);
    FOnScalarParameterUpdated& OnScalarParameterUpdated()
    {
        return ScalarParameterUpdatedDelegate;
    }
 
    using VectorParameterUpdate = TPair<FName, FLinearColor>;
    DECLARE_MULTICAST_DELEGATE_OneParam(FOnVectorParameterUpdated, VectorParameterUpdate);
    FOnVectorParameterUpdated& OnVectorParameterUpdated()
    {
        return VectorParameterUpdatedDelegate;
    }
 
    ENGINE_API void UpdateRenderState(bool bRecreateUniformBuffer);
 
    ENGINE_API void DeferredUpdateRenderState(bool bRecreateUniformBuffer);
 
    ENGINE_API void ForceReturnToDefaultValues();
 
    bool bLoggedMissingParameterWarning;
 
protected:
 
    UPROPERTY()
    TWeakObjectPtr<UMaterialParameterCollection> Collection;
 
    TWeakObjectPtr<UWorld> World;
 
    TMap<FName, float> ScalarParameterValues;
 
    TMap<FName, FLinearColor> VectorParameterValues;
 
    FMaterialParameterCollectionInstanceResource* Resource;
 
    FOnScalarParameterUpdated ScalarParameterUpdatedDelegate;
 
    FOnVectorParameterUpdated VectorParameterUpdatedDelegate;
 
    ENGINE_API void GetParameterData(TArray<FVector4f>& ParameterData) const;
    
    bool bNeedsRenderStateUpdate;
};