Navigation
API > API/Plugins > API/Plugins/DynamicMaterial
Represents a MID-like version of a Material Designer Model. Uses dynamic values/texture uvs to link to the original model.
| Name | UDynamicMaterialModelDynamic |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DynamicMaterial/Source/DynamicMaterial/Public/Model/DynamicMaterialModelDynamic.h |
| Include Path | #include "Model/DynamicMaterialModelDynamic.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, ClassGroup="Material Designer",
Meta=(DisplayName="Material Designer Model Instance"))
class UDynamicMaterialModelDynamic : public UDynamicMaterialModelBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDynamicMaterialModelBase → UDynamicMaterialModelDynamic
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDynamicMaterialModelDynamic() |
Model/DynamicMaterialModelDynamic.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DynamicComponentsPathToken | const FString | Model/DynamicMaterialModelDynamic.h | |
| ParentModelPathToken | const FString | Model/DynamicMaterialModelDynamic.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddComponentDynamic
(
UDMMaterialComponentDynamic* InValueDynamic |
Adds the given component. Won't add if a component with the same name already exists. | Model/DynamicMaterialModelDynamic.h | |
virtual void ApplyComponents
(
UMaterialInstanceDynamic* InMID |
Model/DynamicMaterialModelDynamic.h | ||
void EnsureComponents() |
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. | Model/DynamicMaterialModelDynamic.h | |
UDMMaterialComponent * GetComponentByPath
(
const FString& InPath |
Finds the component with the given path. | Model/DynamicMaterialModelDynamic.h |
|
UDMMaterialComponent * GetComponentByPath
(
FDMComponentPath& InPath |
Finds the component with the given path. | Model/DynamicMaterialModelDynamic.h | |
UDMMaterialComponentDynamic * GetComponentDynamic
(
FName InName |
Returns the component with the given name or nullptr. | Model/DynamicMaterialModelDynamic.h |
|
const TMap< FName, TObjectPtr< UDMMaterialComponentDynamic > > & GetComponentMap() |
Returns the component map. | Model/DynamicMaterialModelDynamic.h | |
virtual UMaterial * GetGeneratedMaterial() |
Model/DynamicMaterialModelDynamic.h | ||
FDMOnTextureUVDynamicUpdated::RegistrationType & GetOnTextureUVDynamicUpdateDelegate() |
Returns the on value update method so it can (un)subscribed to. | Model/DynamicMaterialModelDynamic.h | |
FDMOnValueDynamicUpdated::RegistrationType & GetOnValueDynamicUpdateDelegate() |
Returns the on value update method so it can (un)subscribed to. | Model/DynamicMaterialModelDynamic.h | |
UDynamicMaterialModel * GetParentModel() |
Resolves and returns the parent model from ParentModelSoft, saving it in the transient ParentModel. | Model/DynamicMaterialModelDynamic.h |
|
void OnTextureUVUpdated
(
UDMTextureUVDynamic* InTextureUVDynamic |
Called when a texture uv changes so that the Material Designer Material can be updated and the event broadcast | Model/DynamicMaterialModelDynamic.h | |
void OnValueUpdated
(
UDMMaterialValueDynamic* InValueDynamic |
Called when a value changes so that the Material Designer Material can be updated and the event broadcast | Model/DynamicMaterialModelDynamic.h | |
bool RemoveComponentDynamic
(
UDMMaterialComponentDynamic* InValueDynamic |
Removes the given component. Won't remove if the name doesn't exist or the components don't match. | Model/DynamicMaterialModelDynamic.h | |
virtual void SetDynamicMaterialInstance
(
UDynamicMaterialInstance* InDynamicMaterialInstance |
Model/DynamicMaterialModelDynamic.h | ||
UDynamicMaterialModel * ToEditable
(
UObject* InOuter |
Converts this model dynamic to a new model and returns it. | Model/DynamicMaterialModelDynamic.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/DynamicMaterialModelDynamic.h | |
virtual UDynamicMaterialModel * ResolveMaterialModel () |
Returns the Material Designer Model that is the base for this Model. | Model/DynamicMaterialModelDynamic.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Model/DynamicMaterialModelDynamic.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDynamicMaterialModel * EnsureParentModel() |
Loads the parent model from the soft reference, if it is not already loaded. | Model/DynamicMaterialModelDynamic.h | |
void InitComponents () |
Scans the parent Material Model and adds all the components from there as Instance Components. | Model/DynamicMaterialModelDynamic.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UDynamicMaterialModelDynamic * Create
(
UObject* InOuter, |
Create a new Material Designer Model Instance based on a parent Model. | Model/DynamicMaterialModelDynamic.h |
|