1. Epic GamesDeveloper
  3. UDynamicMaterialModel

UDynamicMaterialModel

API > API/Plugins > API/Plugins/DynamicMaterial > API/Plugins/DynamicMaterial/Model

Inheritance Hierarchy

References

   
Module DynamicMaterial
Header /Engine/Plugins/Experimental/DynamicMaterial/Source/DynamicMaterial/Public/Model/DynamicMaterialModel.h
Include #include "Model/DynamicMaterialModel.h"

Syntax

UCLASS (MinimalAPI, ClassGroup="Material Designer", DefaultToInstanced, BlueprintType,  
       Meta=(DisplayThumbnail="true"))  
class UDynamicMaterialModel : public UDynamicMaterialModelBase

Variables

  Type Name Description
Protected variable UProperty bool bCreateMaterialPackage  
Protected variable UProperty TEnumAsByte< EBlendMode > BlendMode These properties used to exist on the editor-only subclass of this model.
Protected variable UProperty Category BlueprintReadOnly instanced, textexporttransient, visibleinstanceonly TObjectPtr< UMaterial > DynamicMaterial Material generated by the Model.
Protected variable UProperty Category BlueprintReadOnly textexporttransient, visibleinstanceonly TObjectPtr< UDynamicMaterialInstance > DynamicMaterialInstance Material Designer Material representing the MID for this Model.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly TScriptInterface< IDynamicMaterialModelEditorOnlyDataInterface > EditorOnlyDataSI Object holding the editor-only data used by this model.
Protected variable UProperty TArray< TObjectPtr< UMaterialExpression > > Expressions  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalAmbientOcclusionParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalAnisotropyParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalBaseColorParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalDisplacementParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalEmissiveColorParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalMetallicParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalNormalParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalOffsetParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalOpacityParameterValue  
Protected variable UProperty TObjectPtr< UDMMaterialValueFloat1 > GlobalOpacityValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalPixelDepthOffsetParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalRefractionParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalRotationParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalRoughnessParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalSpecularParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalSubsurfaceColorParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalSurfaceThicknessParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalTangentParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalTilingParameterValue  
Protected variable UProperty Category BlueprintReadOnly instanced TObjectPtr< UDMMaterialValue > GlobalWorldPositionOffsetParameterValue  
Protected variable FDMOnTextureUVUpdated OnTextureUVUpdateDelegate Delegate called when a value is updated. @See GetOnValueUpdateDelegate.
Protected variable FDMOnValueUpdated OnValueUpdateDelegate Delegate called when a value is updated. @See GetOnValueUpdateDelegate.
Protected variable UProperty Category textexporttransient, visibleinstanceonly TMap< FName, TWeakObjectPtr< UDMMaterialParameter > > ParameterMap Map of parameter names to the objects representing that parameter.
Protected variable UProperty TMap< EDMMaterialPropertyType, TObjectPtr< UObject > > Properties  
Protected variable UProperty TMap< EDMMaterialPropertyType, TObjectPtr< UObject > > PropertySlotMap  
Protected variable UProperty Category BlueprintReadOnly instanced, visibleinstanceonly TSet< TObjectPtr< UDMMaterialComponent > > RuntimeComponents References to runtime components outered to this model which are not otherwise referenced.
Protected variable UProperty EDMMaterialShadingModel ShadingModel  
Protected variable UProperty TArray< TObjectPtr< UObject > > Slots  
Protected variable UProperty Category BlueprintReadOnly instanced, visibleinstanceonly TArray< TObjectPtr< UDMMaterialValue > > Values Global values

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Adds a reference to a component so they don't get garbage collected at runtime.
Public function UFunction BlueprintCallable, Category UDMMaterialValue *

AddValue ( TSubclassOf< UDMMaterialValue > InValueClass
)

 Creates a new value of the given class and returns it.
Public function Virtual void

ApplyComponents ( UMaterialInstanceDynamic* InMID
)

  
Public function Const UFunction BlueprintPure, Category, Meta TScriptInterface< IDynamicMaterialModelEditorOnlyDataInterface > Returns the editor only data for this model.
Public function bool Removes this specific object from the parameter map if the name is in use by a different parameter.
Public function UDMMaterialParameter *

CreateUniqueParameter ( FName InBaseName
)

 Creates a new parameter and assigns it a unique name.
Protected function FName

CreateUniqueParameterName ( FName InBaseName
)

 Checks the current parameters and returns the first parameter name that is not in used (BaseName1, 2, etc, etc.)
Protected function void Attempts to fix global opacity to give it a range of 0-1.
Protected function void Makes sure the global parameter values have the correct name.
Public function void

ForEachGlobalParameter ( TFunctionRef< void(UDMMaterialValue*InGlobalParameterValue)> InCallable
)

  
Public function void Removes parameter by the name assigned to this parameter object.
Public function Const InComponentClass * Searches the model for a specific component based on a path and Casts it to the given type.
Public function Const UDMMaterialComponent * Searches the model for a specific component based on a path.
Public function Const UFunction BlueprintCallable, Category UDMMaterialComponent *

GetComponentByPath ( const FString& InPath
)

 Searches the model for a specific component based on a path.
Public function Const IDynamicMaterialModelEditorOnlyDataInterface * Returns the editor only data for this model.
Public function Virtual Const UMaterial *  
Public function Const UFunction BlueprintPure, Category UDMMaterialValueFloat1 *  
Public function Const UFunction BlueprintPure, Category UDMMaterialValue *

GetGlobalParameterValue ( FName InName
)

 Returns a specific global parameter value (such as global opacity) of the given object name (see global parameter FNames) or nullptr.
Public function Const UFunction BlueprintPure, Category UDMMaterialValue * Returns a specific global parameter value (such as global opacity) for the given material property or nullptr.
Public function Const InValueClass * Returns a Cast version of a specific global value (such as global opacity) or nullptr.
Public function FDMOnTextureUVUpdated::RegistrationType & Returns the texture uv update delegate to (un)subscribe.
Public function FDMOnValueUpdated::RegistrationType & Returns the value update delegate to (un)subscribe.
Public function Const const TSet< TObjectPtr< UDMMaterialComponent > > & Returns a set of components that require a runtime reference, such as texture uvs.
Public function Const InValueClass *

GetTypedGlobalParameterValue ( FName InName
)

 Returns a Cast version of a specific global value (such as global opacity) or nullptr.
Public function Const UFunction BlueprintPure, Category UDMMaterialValue *

GetValueByName ( FName InName
)

 Returns a specific (non-global parameter) value of the given object name.
Public function Const UFunction BlueprintPure, Category const TArray< UDMMaterialValue * > & Returns an array of the (non-global parameter) values used in this Model.
Public function Const UFunction BlueprintPure, Category bool

HasParameterName ( FName InParameterName
)

 Returns true if a parameter has with the given name exists on this Model.
Public function Const UFunction BlueprintPure, Category bool Returns this if this is IsValid() and isn't isn't being destroyed.
Public function void

OnTextureUVUpdated ( UDMTextureUV* InTextureUV
)

 Called by the texture uv when it updates.
Public function void

OnValueUpdated ( UDMMaterialValue* InValue,
EDMUpdateType InUpdateType
)

 Called by the value when it updates. Updates Material Designer Material and triggers the delegate.
Public function Virtual void

PostDuplicate ( bool bInDuplicateForPIE
)

  
Public function Virtual void  
Public function void Called to ensure that the object hierarchy is correct.
Public function Virtual void  
Public function Virtual void  
Protected function void Called to ensure that all components are correctly initialized.
Public function void Removes a reference to a component.
Public function void

RemoveValueByParameterName ( FName InName
)

 Removes a value based on its parameter name.
Public function void

RenameParameter ( UDMMaterialParameter* InParameter,
FName InBaseName
)

 Updates the name on an existing parameter.
Public function Virtual void

SetDynamicMaterialInstance ( UDynamicMaterialInstance* InDynamicMaterialInstance
)

  

Overridden from UDynamicMaterialModelBase

  Type Name Description
Public function Virtual Const UDynamicMaterialInstance * Returns the Material Designer Material that contains this Model, if there is one.
Public function Virtual UDynamicMaterialModel * Returns the Material Designer Model that is the base for this Model.

Constants

Name Description
GlobalAmbientOcclusionParameterName  
GlobalAmbientOcclusionValueName  
GlobalAnisotropyParameterName  
GlobalAnisotropyValueName  
GlobalBaseColorParameterName  
GlobalBaseColorValueName FNames for global parameters values.
GlobalDisplacementParameterName  
GlobalDisplacementValueName  
GlobalEmissiveColorParameterName  
GlobalEmissiveColorValueName  
GlobalMetallicParameterName  
GlobalMetallicValueName  
GlobalNormalParameterName  
GlobalNormalValueName  
GlobalOffsetParameterName  
GlobalOffsetValueName  
GlobalOpacityParameterName  
GlobalOpacityValueName  
GlobalPixelDepthOffsetParameterName  
GlobalPixelDepthOffsetValueName  
GlobalRefractionParameterName  
GlobalRefractionValueName  
GlobalRotationParameterName  
GlobalRotationValueName  
GlobalRoughnessParameterName  
GlobalRoughnessValueName  
GlobalSpecularParameterName  
GlobalSpecularValueName  
GlobalSubsurfaceColorParameterName  
GlobalSubsurfaceColorValueName  
GlobalSurfaceThicknessParameterName  
GlobalSurfaceThicknessValueName  
GlobalTangentParameterName  
GlobalTangentValueName  
GlobalTilingParameterName  
GlobalTilingValueName  
GlobalWorldPositionOffsetParameterName  
GlobalWorldPositionOffsetValueName  
ParametersPathToken  
ValuesPathToken Tokens used for Components.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page