MaterialExpressionFunctionInput.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/MaterialExpression.h"
#include "MaterialExpressionFunctionInput.generated.h"
 
class FMaterialCompiler;
struct FPropertyChangedEvent;
 
UENUM(BlueprintType)
enum EFunctionInputType : int
{
    FunctionInput_Scalar UMETA(DisplayName = "Scalar"),
    FunctionInput_Vector2 UMETA(DisplayName = "Vector2"),
    FunctionInput_Vector3 UMETA(DisplayName = "Vector3"),
    FunctionInput_Vector4 UMETA(DisplayName = "Vector4"),
    FunctionInput_Texture2D UMETA(DisplayName = "Texture2D"),
    FunctionInput_TextureCube UMETA(DisplayName = "TextureCube"),
    FunctionInput_Texture2DArray UMETA(DisplayName = "Texture2DArray"),
    FunctionInput_VolumeTexture UMETA(DisplayName = "VolumeTexture"),
    FunctionInput_StaticBool UMETA(DisplayName = "StaticBool"),
    FunctionInput_MaterialAttributes UMETA(DisplayName = "MaterialAttributes"),
    FunctionInput_TextureExternal UMETA(DisplayName = "TextureExternal"),
    FunctionInput_Bool UMETA(DisplayName = "Bool"),
    FunctionInput_Substrate UMETA(DisplayName = "Substrate"),
    FunctionInput_MAX UMETA(DisplayName = "NULL"),
};
#define EXPECTED_NUM_INPUT_TYPES 13
 
UENUM()
enum EBlendInputRelevance : int
{
    General,
    Top,
    Bottom
};
 
UCLASS(hidecategories=object, MinimalAPI)
class UMaterialExpressionFunctionInput : public UMaterialExpression
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(meta=(RequiredInput = "false"))
    FExpressionInput Preview;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=MaterialExpressionFunctionInput)
    FName InputName;
 
    UPROPERTY(EditAnywhere, Category=MaterialExpressionFunctionInput)
    FString Description;
 
    UPROPERTY()
    FGuid Id;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=MaterialExpressionFunctionInput)
    TEnumAsByte<enum EFunctionInputType> InputType;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=MaterialExpressionFunctionInput, meta=(OverridingInputProperty = "Preview"))
    FVector4f PreviewValue;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=MaterialExpressionFunctionInput)
    uint32 bUsePreviewValueAsDefault:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=MaterialExpression)
    int32 SortPriority;
 
    UPROPERTY(EditAnywhere, Category = MaterialExpressionFunctionInput)
    TEnumAsByte<enum EBlendInputRelevance> BlendInputRelevance = EBlendInputRelevance::General;
 
    UE_DEPRECATED(5.6, "bCompilingFunctionPreview has been deprecated.")
    UPROPERTY(transient, meta = (DeprecatedProperty, DeprecationMessage = "bCompilingFunctionPreview has been removed from function inputs and has no functional usage, it has been replaced by automatic state tracking between function calls."))
    uint32 bCompilingFunctionPreview_DEPRECATED : 1;
 
#if WITH_EDITOR
    FExpressionInput* AddNewEffectivePreviewDuringCompile(FExpressionInput& InEffectivePreview);
    void RemoveLastEffectivePreviewDuringCompile();
#endif
 
    //~ Begin UObject Interface.
    virtual void PostLoad() override;
    virtual void PostDuplicate(bool bDuplicateForPIE) override;
#if WITH_EDITOR
    virtual void PostEditImport() override;
    virtual void PreEditChange(FProperty* PropertyAboutToChange) override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    //~ End UObject Interface.
 
    //~ Begin UMaterialExpression Interface
#if WITH_EDITOR
    virtual void Build(MIR::FEmitter& Emitter) override;
    virtual void GetExpressionToolTip(TArray<FString>& OutToolTip) override;
    virtual int32 CompilePreview(class FMaterialCompiler* Compiler, int32 OutputIndex) override;
    virtual int32 Compile(class FMaterialCompiler* Compiler, int32 OutputIndex) override;
    virtual void GetCaption(TArray<FString>& OutCaptions) const override;
 
 
    virtual bool IsResultSubstrateMaterial(int32 OutputIndex) override;
    virtual void GatherSubstrateMaterialInfo(FSubstrateMaterialInfo& SubstrateMaterialInfo, int32 OutputIndex) override;
    virtual FSubstrateOperator* SubstrateGenerateMaterialTopologyTree(class FMaterialCompiler* Compiler, class UMaterialExpression* Parent, int32 OutputIndex) override;
    virtual bool IsResultMaterialAttributes(int32 OutputIndex) override;
    virtual EMaterialValueType GetInputValueType(int32 InputIndex) override;
    virtual EMaterialValueType GetOutputValueType(int32 OutputIndex) override;
#endif // WITH_EDITOR
    virtual bool IsAllowedIn(const UObject* MaterialOrFunction) const override;
    //~ End UMaterialExpression Interface
 
    ENGINE_API void ConditionallyGenerateId(bool bForce);
 
    ENGINE_API static FString GetInputTypeDisplayName(EFunctionInputType InputType);
    ENGINE_API static EMaterialValueType GetMaterialTypeFromInputType(EFunctionInputType InputType);
    ENGINE_API static EFunctionInputType GetInputTypeFromMaterialType(EMaterialValueType MaterialType);
#if WITH_EDITOR
    ENGINE_API void ValidateName();
#endif // WITH_EDITOR
 
private:
#if WITH_EDITOR
    int32 CompilePreviewValue(FMaterialCompiler* Compiler);
 
    FName InputNameBackup;
 
    TArray<FExpressionInput*> EffectivePreviewDuringCompile;
 
    void PushEffectivePreviewDuringCompile(FExpressionInput* InEffectivePreview);
    FExpressionInput* PopEffectivePreviewDuringCompile();
#endif // WITH_EDITOR
};