MaterialFunction.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 "Misc/Guid.h"
#include "Templates/Casts.h"
#include "Materials/MaterialFunctionInterface.h"
#include "StaticParameterSet.h"
#include "MaterialDomain.h"
#include "MaterialExpression.h"
#include "MaterialFunction.generated.h"
 
class UMaterial;
class UTexture;
struct FPropertyChangedEvent;
class UMaterialExpression;
 
UCLASS(MinimalAPI, Optional)
class UMaterialFunctionEditorOnlyData : public UMaterialFunctionInterfaceEditorOnlyData
{
    GENERATED_BODY()
 
public:
    UPROPERTY()
    FMaterialExpressionCollection ExpressionCollection;
 
    //~ Begin UObject Interface.
    ENGINE_API virtual void PreSave(FObjectPreSaveContext ObjectSaveContext) override;
    //~ End UObject Interface.
};
 
UCLASS(BlueprintType, hidecategories=object, MinimalAPI)
class UMaterialFunction : public UMaterialFunctionInterface
{
    GENERATED_UCLASS_BODY()
 
#if WITH_EDITORONLY_DATA
    virtual const UClass* GetEditorOnlyDataClass() const override { return UMaterialFunctionEditorOnlyData::StaticClass(); }
 
    UMaterialFunctionEditorOnlyData* GetEditorOnlyData() { return CastChecked<UMaterialFunctionEditorOnlyData>(Super::GetEditorOnlyData()); }
    const UMaterialFunctionEditorOnlyData* GetEditorOnlyData() const { return CastChecked<UMaterialFunctionEditorOnlyData>(Super::GetEditorOnlyData()); }
#endif // WITH_EDITORONLY_DATA
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(transient)
    TObjectPtr<class UMaterialFunction> ParentFunction;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, Category=MaterialFunction, AssetRegistrySearchable)
    FString Description;
 
    UPROPERTY(EditAnywhere, Category=MaterialFunction, AssetRegistrySearchable)
    FString UserExposedCaption;
 
    UPROPERTY(EditAnywhere, Category=MaterialFunction, AssetRegistrySearchable)
    uint8 bExposeToLibrary:1;
 
#if WITH_EDITORONLY_DATA    
    UE_DEPRECATED(5.6, "bPrefixParameterNames has been deprecated.")
    UPROPERTY()
    uint8 bPrefixParameterNames:1;
#endif // WITH_EDITORONLY_DATA
 
    UE_DEPRECATED(5.8, "Experimental bEnableExecWire is no longer supported.")
    UPROPERTY(EditAnywhere, Category = MaterialFunction)
    uint8 bEnableExecWire : 1;
 
    UPROPERTY(EditAnywhere, Category = MaterialFunction)
    uint8 bEnableNewHLSLGenerator : 1;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(AssetRegistrySearchable)
    TArray<FString> LibraryCategories_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category=MaterialFunction, AssetRegistrySearchable)
    TArray<FText> LibraryCategoriesText;
#endif
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(transient)
    TObjectPtr<UMaterial> PreviewMaterial;
 
    // The UMaterial which represents this function while the function itself is open in the material editor
    TObjectPtr<UMaterial> EditorMaterial;
 
    UPROPERTY()
    TArray<TObjectPtr<class UMaterialExpressionMaterialFunctionCall>> DependentFunctionExpressionCandidates;
 
    UPROPERTY(EditAnywhere, Category = Preview, AssetRegistrySearchable)
    TEnumAsByte<enum EBlendMode> PreviewBlendMode = BLEND_Opaque;
 
    UPROPERTY(EditAnywhere, Category = Preview, AssetRegistrySearchable)
    TEnumAsByte<enum EMaterialDomain> PreviewMaterialDomain;
 
    class UMaterialGraph* MaterialGraph = nullptr;
 
    /* Whether all expressions in the function loaded correctly. */
    uint8 bAllExpressionsLoadedCorrectly : 1;
 
private:
    UPROPERTY(transient)
    uint8 bReentrantFlag:1;
#endif // WITH_EDITORONLY_DATA
 
public:
    //~ Begin UObject Interface.
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    virtual void PreSave(FObjectPreSaveContext ObjectSaveContext) override;
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostLoad() override;
#if WITH_EDITORONLY_DATA
    static void DeclareConstructClasses(TArray<FTopLevelAssetPath>& OutConstructClasses, const UClass* SpecificSubclass);
#endif
    //~ End UObject Interface.
 
    void SetMaterialFunctionUsage(EMaterialFunctionUsage Usage) { MaterialFunctionUsage = Usage; }
 
    //~ Begin UMaterialFunctionInterface interface
    virtual EMaterialFunctionUsage GetMaterialFunctionUsage() override { return MaterialFunctionUsage; }
 
#if WITH_EDITOR
    virtual void UpdateFromFunctionResource() override;
 
    virtual void GetInputsAndOutputs(TArray<struct FFunctionExpressionInput>& OutInputs, TArray<struct FFunctionExpressionOutput>& OutOutputs) const override;
 
    virtual void ForceRecompileForRendering(FMaterialUpdateContext& UpdateContext, UMaterial* InPreviewMaterial) override;
#endif
 
    virtual bool ValidateFunctionUsage(class FMaterialCompiler* Compiler, const FFunctionExpressionOutput& Output) override;
 
#if WITH_EDITOR
    virtual int32 Compile(class FMaterialCompiler* Compiler, const struct FFunctionExpressionOutput& Output) override;
 
    virtual void LinkIntoCaller(const TArray<FFunctionExpressionInput>& CallerInputs) override;
 
    virtual void UnlinkFromCaller() override;
#endif
 
#if WITH_EDITORONLY_DATA
    virtual bool IsDependent(UMaterialFunctionInterface* OtherFunction) override;
 
    ENGINE_API virtual bool IterateDependentFunctions(TFunctionRef<bool(UMaterialFunctionInterface*)> Predicate) const override;
 
    ENGINE_API virtual void GetDependentFunctions(TArray<UMaterialFunctionInterface*>& DependentFunctions) const override;
 
    virtual FString GetUserExposedCaption() const override { return UserExposedCaption; }
 
    void GetAllCustomOutputExpressions(TArray<class UMaterialExpressionCustomOutput*>& OutCustomOutputs) const;
 
#endif // WITH_EDITORONLY_DATA
 
#if WITH_EDITOR
    virtual UMaterialInterface* GetPreviewMaterial() override;
 
    virtual void UpdateInputOutputTypes() override;
 
    virtual void UpdateDependentFunctionCandidates();
 
    virtual bool HasFlippedCoordinates() const override;
#endif
 
    virtual UMaterialFunction* GetBaseFunction(FMFRecursionGuard RecursionGuard = FMFRecursionGuard()) override { return this; }
    virtual const UMaterialFunction* GetBaseFunction(FMFRecursionGuard RecursionGuard = FMFRecursionGuard()) const override { return this; }
#if WITH_EDITORONLY_DATA
    ENGINE_API TConstArrayView<TObjectPtr<UMaterialExpression>> GetExpressions() const;
    ENGINE_API TConstArrayView<TObjectPtr<UMaterialExpressionComment>> GetEditorComments() const;
 
    ENGINE_API const FMaterialExpressionCollection& GetExpressionCollection() const;
    ENGINE_API FMaterialExpressionCollection& GetExpressionCollection();
    ENGINE_API void AssignExpressionCollection(const FMaterialExpressionCollection& InCollection);
#endif // WITH_EDITORONLY_DATA
    //~ End UMaterialFunctionInterface interface
 
 
#if WITH_EDITOR
    ENGINE_API bool SetParameterValueEditorOnly(const FName& ParameterName, const FMaterialParameterMetadata& Meta);
    ENGINE_API bool SetVectorParameterValueEditorOnly(FName ParameterName, FLinearColor InValue);
    ENGINE_API bool SetScalarParameterValueEditorOnly(FName ParameterName, float InValue);
    ENGINE_API bool SetTextureParameterValueEditorOnly(FName ParameterName, class UTexture* InValue);
    ENGINE_API bool SetRuntimeVirtualTextureParameterValueEditorOnly(FName ParameterName, class URuntimeVirtualTexture* InValue);
    ENGINE_API bool SetSparseVolumeTextureParameterValueEditorOnly(FName ParameterName, class USparseVolumeTexture* InValue);
    ENGINE_API bool SetFontParameterValueEditorOnly(FName ParameterName, class UFont* InFontValue, int32 InFontPage);
    ENGINE_API bool SetStaticComponentMaskParameterValueEditorOnly(FName ParameterName, bool R, bool G, bool B, bool A, FGuid OutExpressionGuid);
    ENGINE_API bool SetStaticSwitchParameterValueEditorOnly(FName ParameterName, bool OutValue, FGuid OutExpressionGuid);
 
    inline bool GetReentrantFlag() const { return bReentrantFlag; }
    inline void SetReentrantFlag(bool bIsReentrant) { bReentrantFlag = bIsReentrant; }
 
    virtual bool IsUsingNewHLSLGenerator() const override;
#endif // WITH_EDITOR
 
private:
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TArray<TObjectPtr<UMaterialExpression>> FunctionExpressions_DEPRECATED;
 
    UPROPERTY()
    TArray<TObjectPtr<class UMaterialExpressionComment>> FunctionEditorComments_DEPRECATED;
#endif // WITH_EDITORONLY_DATA
};