1. Epic GamesDeveloper
  3. UDynamicMaterialModel

UDynamicMaterialModel

API > API/Plugins > API/Plugins/DynamicMaterial

   
Name UDynamicMaterialModel
Type class
Header File /Engine/Plugins/VirtualProduction/DynamicMaterial/Source/DynamicMaterial/Public/Model/DynamicMaterialModel.h
Include Path #include "Model/DynamicMaterialModel.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDynamicMaterialModel()

   Model/DynamicMaterialModel.h  

Constants

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddRuntimeComponentReference ( UDMMaterialComponent* InValue
)

 Adds a reference to a component so they don't get garbage collected at runtime. Model/DynamicMaterialModel.h  

UDMMaterialValue * AddValue ( TSubclassOf< UDMMaterialValue > InValueClass
)

 Creates a new value of the given class and returns it. Model/DynamicMaterialModel.h
  • BlueprintCallable
  • Category="Material Designer"

virtual void ApplyComponents ( UMaterialInstanceDynamic* InMID
)

   Model/DynamicMaterialModel.h  
Returns the editor only data for this model. Model/DynamicMaterialModel.h
  • BlueprintPure
  • Category="Material Designer"
  • Meta=(DisplayName="Get Editor Only Data")
Removes this specific object from the parameter map if the name is in use by a different parameter. Model/DynamicMaterialModel.h  

UDMMaterialParameter * CreateUniqueParameter ( FName InBaseName
)

 Creates a new parameter and assigns it a unique name. Model/DynamicMaterialModel.h  

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

   Model/DynamicMaterialModel.h  

void FreeParameter ( UDMMaterialParameter* InParameter
)

 Removes parameter by the name assigned to this parameter object. Model/DynamicMaterialModel.h  

InComponentClass * GetComponentByPath ( FDMComponentPath& InPath
) const

 Searches the model for a specific component based on a path and Casts it to the given type. Model/DynamicMaterialModel.h  
Searches the model for a specific component based on a path. Model/DynamicMaterialModel.h  

UDMMaterialComponent * GetComponentByPath ( const FString& InPath
) const

 Searches the model for a specific component based on a path. Model/DynamicMaterialModel.h
  • BlueprintCallable
  • Category="Material Designer"
Returns the editor only data for this model. Model/DynamicMaterialModel.h  

virtual UMaterial * GetGeneratedMaterial()

   Model/DynamicMaterialModel.h  

UDMMaterialValueFloat1 * GetGlobalOpacityValue()

   Model/DynamicMaterialModel.h
  • BlueprintPure
  • Category="Material Designer"

UDMMaterialValue * GetGlobalParameterValue ( FName InName
) const

 Returns a specific global parameter value (such as global opacity) of the given object name (see global parameter FNames) or nullptr. Model/DynamicMaterialModel.h
  • BlueprintPure
  • Category="Material Designer"
Returns a specific global parameter value (such as global opacity) for the given material property or nullptr. Model/DynamicMaterialModel.h
  • BlueprintPure
  • Category="Material Designer"
Returns a Cast version of a specific global value (such as global opacity) or nullptr. Model/DynamicMaterialModel.h  

FDMOnTextureUVUpdated::RegistrationType & GetOnTextureUVUpdateDelegate()

 Returns the texture uv update delegate to (un)subscribe. Model/DynamicMaterialModel.h  

FDMOnValueUpdated::RegistrationType & GetOnValueUpdateDelegate()

 Returns the value update delegate to (un)subscribe. Model/DynamicMaterialModel.h  

const TSet< TObjectPtr< UDMMaterialComponent > > & GetRuntimeComponents()

 Returns a set of components that require a runtime reference, such as texture uvs. Model/DynamicMaterialModel.h  

InValueClass * GetTypedGlobalParameterValue ( FName InName
) const

 Returns a Cast version of a specific global value (such as global opacity) or nullptr. Model/DynamicMaterialModel.h  

UDMMaterialValue * GetValueByName ( FName InName
) const

 Returns a specific (non-global parameter) value of the given object name. Model/DynamicMaterialModel.h
  • BlueprintPure
  • Category="Material Designer"

const TArray< UDMMaterialValue * > & GetValues()

 Returns an array of the (non-global parameter) values used in this Model. Model/DynamicMaterialModel.h
  • BlueprintPure
  • Category="Material Designer"

bool HasParameterName ( FName InParameterName
) const

 Returns true if a parameter has with the given name exists on this Model. Model/DynamicMaterialModel.h
  • BlueprintPure
  • Category="Material Designer"

bool IsModelValid()

 Returns this if this is IsValid() and isn't isn't being destroyed. Model/DynamicMaterialModel.h
  • BlueprintPure
  • Category="Material Designer"

void OnTextureUVUpdated ( UDMTextureUV* InTextureUV
)

 Called by the texture uv when it updates. Model/DynamicMaterialModel.h  

void OnValueUpdated ( UDMMaterialValue* InValue,
EDMUpdateType InUpdateType
)

 Called by the value when it updates. Updates Material Designer Material and triggers the delegate. Model/DynamicMaterialModel.h  

void PostEditorDuplicate()

 Called to ensure that the object hierarchy is correct. Model/DynamicMaterialModel.h  

void RemoveRuntimeComponentReference ( UDMMaterialComponent* InValue
)

 Removes a reference to a component. Model/DynamicMaterialModel.h  

void RemoveValueByParameterName ( FName InName
)

 Removes a value based on its parameter name. Model/DynamicMaterialModel.h  

void RenameParameter ( UDMMaterialParameter* InParameter,
FName InBaseName
)

 Updates the name on an existing parameter. Model/DynamicMaterialModel.h  

virtual void SetDynamicMaterialInstance ( UDynamicMaterialInstance* InDynamicMaterialInstance
)

   Model/DynamicMaterialModel.h  

Overridden from UDynamicMaterialModelBase

Name Remarks Include Path Unreal Specifiers

virtual UDynamicMaterialInstance * GetDynamicMaterialInstance()

 Returns the Material Designer Material that contains this Model, if there is one. Model/DynamicMaterialModel.h  
Returns the Material Designer Model that is the base for this Model. Model/DynamicMaterialModel.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( bool bInDuplicateForPIE
)

   Model/DynamicMaterialModel.h  

virtual void PostEditImport()

   Model/DynamicMaterialModel.h  

virtual void PostEditUndo()

   Model/DynamicMaterialModel.h  

virtual void PostLoad()

   Model/DynamicMaterialModel.h  

Protected

Name Remarks Include Path Unreal Specifiers

FName CreateUniqueParameterName ( FName InBaseName
)

 Checks the current parameters and returns the first parameter name that is not in used (BaseName1, 2, etc, etc.) Model/DynamicMaterialModel.h  

void FixGlobalParameterValues()

 Attempts to fix global opacity to give it a range of 0-1. Model/DynamicMaterialModel.h  

void FixGlobalVars()

 Makes sure the global parameter values have the correct name. Model/DynamicMaterialModel.h  
Called to ensure that all components are correctly initialized. Model/DynamicMaterialModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page