MaterialExpressionScalarParameter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "Materials/MaterialExpressionParameter.h"
#include "MaterialExpressionScalarParameter.generated.h"
 
class IMaterialEnumerationProvider;
 
UENUM()
enum class EMaterialScalarParameterControlType
{
    Numeric,
    Enumeration,
    EnumerationIndex,
};
 
UCLASS(collapsecategories, hidecategories=Object, MinimalAPI)
class UMaterialExpressionScalarParameter : public UMaterialExpressionParameter
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=MaterialExpressionScalarParameter, meta = (ShowAsInputPin = "Primary"))
    float DefaultValue;
 
    UPROPERTY(EditAnywhere, Category = UI, meta = (EditCondition = "!bUseCustomPrimitiveData"))
    EMaterialScalarParameterControlType ControlType = EMaterialScalarParameterControlType::Numeric;
 
    UPROPERTY(EditAnywhere, Category = UI, meta = (EditCondition = "!bUseCustomPrimitiveData && ControlType == EMaterialScalarParameterControlType::Numeric"))
    float SliderMin = 0.f;
 
    UPROPERTY(EditAnywhere, Category = UI, meta = (EditCondition = "ControlType == EMaterialScalarParameterControlType::Numeric"))
    float SliderMax = 0.f;
 
    UPROPERTY(EditAnywhere, Category = UI, meta = (EditCondition = "ControlType == EMaterialScalarParameterControlType::Enumeration", DisplayThumbnail = "false", AllowedClasses = "/Script/CoreUObject.Enum, /Script/Engine.MaterialEnumerationProvider"))
    TSoftObjectPtr<UObject> Enumeration;
 
    UPROPERTY(EditAnywhere, Category = UI, meta = (EditCondition = "ControlType == EMaterialScalarParameterControlType::EnumerationIndex", ClampMin = "0"))
    uint8 EnumerationIndex = 0;
 
    UPROPERTY(EditAnywhere, Category = CustomPrimitiveData)
    bool bUseCustomPrimitiveData = false;
 
    UPROPERTY(EditAnywhere, Category = CustomPrimitiveData, meta = (ClampMin = "0", EditCondition = "bUseCustomPrimitiveData"))
    uint8 PrimitiveDataIndex = 0;
 
#if WITH_EDITOR
    //~ Begin UObject Interface
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    //~ End UObject Interface
 
    //~ Begin UMaterialExpression Interface
    virtual int32 Compile(class FMaterialCompiler* Compiler, int32 OutputIndex) override;
    virtual void GetCaption(TArray<FString>& OutCaptions) const override;
    virtual bool GetParameterValue(FMaterialParameterMetadata& OutMeta) const override;
    virtual bool SetParameterValue(const FName& Name, const FMaterialParameterMetadata& Meta, EMaterialExpressionSetParameterValueFlags Flags) override;
    virtual bool HasClassAndNameCollision(UMaterialExpression* OtherExpression) const override;
    virtual void ValidateParameterName(const bool bAllowDuplicateName) override;
    //~ End UMaterialExpression Interface
 
    bool SetParameterValue(FName InParameterName, float InValue, EMaterialExpressionSetParameterValueFlags Flags = EMaterialExpressionSetParameterValueFlags::None);
#endif
    
    virtual bool IsUsedAsAtlasPosition() const { return false; }
};