MaterialExpressionMaterialFunctionCall.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 "Misc/Guid.h"
#include "MaterialExpressionIO.h"
#include "Materials/MaterialParameters.h"
#include "Materials/MaterialExpression.h"
#include "MaterialExpressionMaterialFunctionCall.generated.h"
 
class UMaterialFunction;
class FMaterialFunctionCompileState;
struct FPropertyChangedEvent;
 
USTRUCT()
struct FFunctionExpressionInput
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(transient)
    TObjectPtr<class UMaterialExpressionFunctionInput> ExpressionInput;
 
    UPROPERTY()
    FGuid ExpressionInputId;
 
    UPROPERTY()
    FExpressionInput Input;
 
 
    FFunctionExpressionInput()
        : ExpressionInput(NULL)
    {
    }
 
};
 
USTRUCT()
struct FFunctionExpressionOutput
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(transient)
    TObjectPtr<class UMaterialExpressionFunctionOutput> ExpressionOutput;
 
    UPROPERTY()
    FGuid ExpressionOutputId;
 
    UPROPERTY()
    FExpressionOutput Output;
 
 
    FFunctionExpressionOutput()
        : ExpressionOutput(NULL)
    {
    }
 
};
 
UCLASS(hidecategories=object, MinimalAPI)
class UMaterialExpressionMaterialFunctionCall : public UMaterialExpression
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=MaterialExpressionMaterialFunctionCall, meta=(DisallowedClasses="/Script/Engine.MaterialFunctionInstance"))
    TObjectPtr<class UMaterialFunctionInterface> MaterialFunction;
 
    UPROPERTY()
    TArray<struct FFunctionExpressionInput> FunctionInputs;
 
    UPROPERTY()
    TArray<struct FFunctionExpressionOutput> FunctionOutputs;
 
    UPROPERTY(Transient)
    struct FMaterialParameterInfo FunctionParameterInfo;
 
    //~ Begin UObject Interface.
#if WITH_EDITOR
    ENGINE_API virtual void PreEditChange(FProperty* PropertyAboutToChange) override;
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    ENGINE_API virtual void PostLoad() override;
    //~ End UObject Interface.
 
#if WITH_EDITORONLY_DATA
    ENGINE_API bool IterateDependentFunctions(TFunctionRef<bool(UMaterialFunctionInterface*)> Predicate) const;
    ENGINE_API void GetDependentFunctions(TArray<UMaterialFunctionInterface*>& DependentFunctions) const;
#endif
 
#if WITH_EDITOR
    ENGINE_API void UnlinkFunctionFromCaller(FMaterialCompiler* Compiler);
    ENGINE_API void LinkFunctionIntoCaller(FMaterialCompiler* Compiler);
 
    ENGINE_API void PushParameterOwner(FMaterialCompiler* Compiler);
    ENGINE_API void PopParameterOwner(FMaterialCompiler* Compiler);
#endif
 
    //~ Begin UMaterialExpression Interface
#if WITH_EDITOR
    ENGINE_API virtual int32 Compile(class FMaterialCompiler* Compiler, int32 OutputIndex) override;
    ENGINE_API virtual void GetCaption(TArray<FString>& OutCaptions) const override;
    ENGINE_API virtual TArrayView<FExpressionInput*> GetInputsView() override;
    ENGINE_API virtual FExpressionInput* GetInput(int32 InputIndex) override;
    ENGINE_API virtual FName GetInputName(int32 InputIndex) const override;
    ENGINE_API virtual bool IsInputConnectionRequired(int32 InputIndex) const override;
    ENGINE_API virtual FString GetDescription() const override;
    ENGINE_API virtual void GetConnectorToolTip(int32 InputIndex, int32 OutputIndex, TArray<FString>& OutToolTip) override;
    ENGINE_API virtual void GetExpressionToolTip(TArray<FString>& OutToolTip) override;
    ENGINE_API virtual bool MatchesSearchQuery(const TCHAR* SearchQuery) override;
    ENGINE_API virtual bool DeepSearchQuery(const TCHAR* SearchQuery, TSharedPtr<FFindInMaterialResult> SearchResult) override;
    ENGINE_API virtual bool IsResultMaterialAttributes(int32 OutputIndex) override;
    ENGINE_API virtual bool IsResultSubstrateMaterial(int32 OutputIndex) override;
    ENGINE_API virtual void GatherSubstrateMaterialInfo(FSubstrateMaterialInfo& SubstrateMaterialInfo, int32 OutputIndex) override;
    ENGINE_API virtual FSubstrateOperator* SubstrateGenerateMaterialTopologyTree(class FMaterialCompiler* Compiler, class UMaterialExpression* Parent, int32 OutputIndex) override;
    ENGINE_API virtual EMaterialValueType GetInputValueType(int32 InputIndex) override;
    ENGINE_API virtual EMaterialValueType GetOutputValueType(int32 OutputIndex) override;
    //~ End UMaterialExpression Interface
 
    ENGINE_API FName GetInputNameWithType(int32 InputIndex, bool bWithType) const;
 
    ENGINE_API bool SetMaterialFunctionEx(UMaterialFunctionInterface* OldFunctionResource, UMaterialFunctionInterface* NewResource);
 
    UFUNCTION(BlueprintCallable, Category = "MaterialEditing")
    ENGINE_API virtual bool SetMaterialFunction(UMaterialFunctionInterface* NewMaterialFunction);
 
    ENGINE_API void UpdateFromFunctionResource(bool bRecreateAndLinkNode = true);
 
    void SetSharedCompileState(FMaterialFunctionCompileState* SharedState)
    {
        SharedCompileState = SharedState;
    }
 
private:    
    void FixupReferencingExpressions(
        const TArray<FFunctionExpressionOutput>& NewOutputs,
        const TArray<FFunctionExpressionOutput>& OriginalOutputs,
        TConstArrayView<TObjectPtr<UMaterialExpression>> Expressions, 
        TArray<FExpressionInput*>& MaterialInputs,
        bool bMatchByName);
 
    FMaterialFunctionCompileState* SharedCompileState;
 
    UMaterialFunctionInterface* SavedMaterialFunction = nullptr;
#endif // WITH_EDITOR
};