1. Epic GamesDeveloper
  3. UDMMaterialValue

UDMMaterialValue

A value used in a material. Manages its own parameter.

API > API/Plugins > API/Plugins/DynamicMaterial > API/Plugins/DynamicMaterial/Components

Inheritance Hierarchy

References

   
Module DynamicMaterial
Header /Engine/Plugins/Experimental/DynamicMaterial/Source/DynamicMaterial/Public/Components/DMMaterialValue.h
Include #include "Components/DMMaterialValue.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Abstract, ClassGroup="Material Designer",  
       Meta=(DisplayName="Material Designer Value"))  
class UDMMaterialValue :  
    public UDMMaterialLinkedComponent ,  
    public IDMJsonSerializable

Remarks

A value used in a material. Manages its own parameter.

Variables

  Type Name Description
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly bool bExposeParameter  
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly bool bLocal True: The value is local to the stage it is used in.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly FName CachedParameterName  
Public variable void virtual GenerateExpression(const TSharedRef< IDMMaterialBuildStateInterface > &InBuildState) co... IsWholeLayerValue Returns the output index (channel WHOLE_CHANNEL) if this expression has pre-masked outputs.
Protected variable UProperty Category BlueprintReadOnly instanced, visibleinstanceonly TObjectPtr< UDMMaterialParameter > Parameter The parameter name used to expose this value in a material.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly EDMValueType Type  
Public variable void virtual SetMIDParameter(UMaterialInstanceDynamic *InMID) const PURE_VIRTUAL(UDMMaterialStag... Update  

Constructors

  Type Name Description
Public function    
Protected function    

Functions

  Type Name Description
Public function Virtual Const bool Returns true if the property row generator should expose the value property.
Public function Virtual UFunction BlueprintCallable, Category void Subclasses should implement a SetDefaultValue.
Public function Const bool

CanResetToDefault ( TSharedPtr< IPropertyHandle > InPropertyHandle
)

  
Public function Static UFunction BlueprintCallable, Category UDMMaterialValue *

CreateMaterialValue ( UDynamicMaterialModel* InMaterialModel,
const FString& InName,
TSubclassOf< UDMMaterialValue > InValueClass,
bool bInLocal
)

 Creates a new material value and initializes it with the given material model.
Protected function Const FName Generates an automatic path name based on the component hierarchy
Public function Const UFunction BlueprintPure, Category FText Combination of parameter name and type name. May be an automatically generated parameter name.
Public function Const UFunction BlueprintPure, Category UDynamicMaterialModel * Returns the owning material model (this object's Outer).
Public function Const EDMMaterialParameterGroup Determines the group this value's parameter will be in in the Material.
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category EDMValueType

GetType ()

 Returns the type of value as respresented by the possible base type enums.
Public function Const UFunction BlueprintPure, Category FText Uses the Value Definition Library to get the type name of the base enum type.
Public function Virtual Const UFunction BlueprintPure, Category bool  
Protected function Virtual void

OnValueChanged ( EDMUpdateType InUpdateType
)

 Called when the value changes to call this component's and the parent component's Update if possible.
Public function Virtual void  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual UFunction BlueprintCallable, Category void ResetDefaultValue() PURE_VIRTUAL(UDMMaterialValue bool

SetParameterName ( FName InBaseName
)

 Resets to the default default value.
Public function UFunction BlueprintCallable, Category void

SetShouldExposeParameter ( bool bInExpose
)

  
Protected function void

UpdateCachedParameterName ( bool bInResetName
)

 Updates the cached parameter name based on the Parameter object or the above method.

Overridden from UDMMaterialComponent

  Type Name Description
Protected function Virtual Const UDMMaterialComponent * Searches the component for a specific component based on a path.
Public function Virtual bool

Modify ( bool bInAlwaysMarkDirty
)

  
Protected function Virtual void Called when a component enters the Added state.
Protected function Virtual void Called when a component enters the Removed state.
Public function Virtual void Sets the parent component to the InParent parameter.
Public function Virtual void  

Overridden from IDMJsonSerializable

  Type Name Description
Public function Virtual bool

JsonDeserialize ( const TSharedPtr< FJsonValue >& InJsonValue
)

  
Public function Virtual Const TSharedPtr< FJsonValue > Non-editor implementation.

Constants

Name Description
ParameterPathToken  
TypeClasses  
ValueName Name that should be used by all child classes for its value property ("Value").

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page