1. Epic GamesDeveloper
  3. UDynamicMaterialModelDynamic

UDynamicMaterialModelDynamic

Represents a MID-like version of a Material Designer Model.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup="Material Designer",  
       Meta=(DisplayName="Material Designer Model Instance"))  
class UDynamicMaterialModelDynamic : public UDynamicMaterialModelBase

Remarks

Represents a MID-like version of a Material Designer Model. Uses dynamic values/texture uvs to link to the original model.

Variables

  Type Name Description
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly TMap< FName, TObjectPtr< UDMMaterialComponentDynamic > > DynamicComponents Map of the dynamic components that reference the parent model.
Protected variable UProperty Category BlueprintReadOnly textexporttransient, visibleinstanceonly TObjectPtr< UDynamicMaterialInstance > DynamicMaterialInstance Hard reference to the instance, if it exists.
Protected variable FDMOnTextureUVDynamicUpdated OnTextureUVDynamicUpdateDelegate Delegate called when texture uvs update. @See GetOnTextureUVDynamicUpdateDelegate
Protected variable FDMOnValueDynamicUpdated OnValueDynamicUpdateDelegate Delegate called when values update. @See GetOnValueDynamicUpdateDelegate
Protected variable UProperty Transient TObjectPtr< UDynamicMaterialModel > ParentModel Hard reference to the parent model, loaded when the model is first accessed.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly TSoftObjectPtr< UDynamicMaterialModel > ParentModelSoft Soft reference to the parent model.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function bool Adds the given component. Won't add if a component with the same name already exists.
Public function Virtual void

ApplyComponents ( UMaterialInstanceDynamic* InMID
)

  
Public function Static UFunction BlueprintCallable, Category UDynamicMaterialModelDynamic *

Create ( UObject* InOuter,
UDynamicMaterialModel* InParentModel
)

 Create a new Material Designer Model Instance based on a parent Model.
Public function void Checks the parent model to make sure that all components that exist on the parent model are added and that all components that no longer exist on the parent model are removed.
Protected function UDynamicMaterialModel * Loads the parent model from the soft reference, if it is not already loaded.
Public function Const UFunction BlueprintPure, Category UDMMaterialComponent *

GetComponentByPath ( const FString& InPath
)

 Finds the component with the given path.
Public function Const UDMMaterialComponent * Finds the component with the given path.
Public function UFunction BlueprintPure, Category UDMMaterialComponentDynamic *

GetComponentDynamic ( FName InName
)

 Returns the component with the given name or nullptr.
Public function Virtual Const UMaterial *  
Public function FDMOnTextureUVDynamicUpdated::RegistrationType & Returns the on value update method so it can (un)subscribed to.
Public function FDMOnValueDynamicUpdated::RegistrationType & Returns the on value update method so it can (un)subscribed to.
Public function Const UFunction BlueprintPure, Category UDynamicMaterialModel * Resolves and returns the parent model from ParentModelSoft, saving it in the transient ParentModel.
Protected function void Scans the parent Material Model and adds all the components from there as Instance Components.
Public function void

OnTextureUVUpdated ( UDMTextureUVDynamic* InTextureUVDynamic
)

 Called when a texture uv changes so that the Material Designer Material can be updated and the event broadcast
Public function void Called when a value changes so that the Material Designer Material can be updated and the event broadcast
Public function Virtual void  
Public function bool Removes the given component. Won't remove if the name doesn't exist or the components don't match.
Public function Virtual void

SetDynamicMaterialInstance ( UDynamicMaterialInstance* InDynamicMaterialInstance
)

  
Public function UDynamicMaterialModel *

ToEditable ( UObject* InOuter
)

 Converts this model dynamic to a new model and returns it.

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
DynamicComponentsPathToken  
ParentModelPathToken  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page