Navigation
API > API/Plugins > API/Plugins/DynamicMaterial
A value used in a material. Manages its own parameter.
| Name | UDMMaterialValue |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DynamicMaterial/Source/DynamicMaterial/Public/Components/DMMaterialValue.h |
| Include Path | #include "Components/DMMaterialValue.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Abstract, ClassGroup="Material Designer",
Meta=(DisplayName="Material Designer Value"))
class UDMMaterialValue :
public UDMMaterialLinkedComponent ,
public IDMJsonSerializable ,
public IDMParameterContainer
Inheritance Hierarchy
- FNotifyHook → UDMMaterialComponent → UDMMaterialLinkedComponent → UDMMaterialValue
- UObjectBase → UObjectBaseUtility → UObject → UDMMaterialComponent → UDMMaterialLinkedComponent → UDMMaterialValue
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Components/DMMaterialValue.h | |||
UDMMaterialValue
(
EDMValueType InType |
Components/DMMaterialValue.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ParameterPathToken | const FString | Components/DMMaterialValue.h | |
| TypeClasses | TMap< EDMValueType, TStrongObjectPtr< UClass > > | Components/DMMaterialValue.h | |
| ValueName | const FName | Name that should be used by all child classes for its value property ("Value"). | Components/DMMaterialValue.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IsWholeLayerValue | void virtual GenerateExpression(const TSharedRef< IDMMaterialBuildStateInterface > &InBuildState) const PURE_VIRTUAL(UDMMaterialStageSource boo | Returns the output index (channel WHOLE_CHANNEL) if this expression has pre-masked outputs. | Components/DMMaterialValue.h | |
| Update | void virtual SetMIDParameter(UMaterialInstanceDynamic *InMID) const PURE_VIRTUAL(UDMMaterialStageSource voi | Components/DMMaterialValue.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AllowEditValue() |
Returns true if the property row generator should expose the value property. | Components/DMMaterialValue.h | |
bool CanResetToDefault
(
TSharedPtr< IPropertyHandle > InPropertyHandle |
Components/DMMaterialValue.h | ||
FText GetDescription() |
Combination of parameter name and type name. May be an automatically generated parameter name. | Components/DMMaterialValue.h |
|
UDynamicMaterialModel * GetMaterialModel() |
Returns the owning material model (this object's Outer). | Components/DMMaterialValue.h |
|
EDMMaterialParameterGroup GetParameterGroup() |
Determines the group this value's parameter will be in in the Material. | Components/DMMaterialValue.h | |
bool GetShouldExposeParameter() |
Components/DMMaterialValue.h |
|
|
EDMValueType GetType() |
Returns the type of value as respresented by the possible base type enums. | Components/DMMaterialValue.h |
|
FText GetTypeName() |
Uses the Value Definition Library to get the type name of the base enum type. | Components/DMMaterialValue.h |
|
virtual bool IsDefaultValue() |
Components/DMMaterialValue.h |
|
|
virtual void virtual ApplyDefaultValue() PURE_VIRTUAL(UDMMaterialValue void ResetDefaultValue() PURE_VIRTUAL(UDMMaterialValue bool SetParameterName
(
FName InBaseName |
Subclasses should implement a SetDefaultValue. | Components/DMMaterialValue.h |
|
void SetShouldExposeParameter
(
bool bInExpose |
Components/DMMaterialValue.h |
|
Overridden from UDMMaterialComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditorDuplicate
(
UDynamicMaterialModel* InMaterialModel, |
Sets the parent component to the InParent parameter. | Components/DMMaterialValue.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Modify
(
bool bInAlwaysMarkDirty |
Components/DMMaterialValue.h | ||
virtual void PostCDOContruct() |
Components/DMMaterialValue.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& InPropertyChangedEvent |
Components/DMMaterialValue.h | ||
virtual void PostEditImport() |
Components/DMMaterialValue.h | ||
virtual void PostEditUndo() |
Components/DMMaterialValue.h | ||
virtual void PostLoad() |
Components/DMMaterialValue.h |
Overridden from IDMJsonSerializable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool JsonDeserialize
(
const TSharedPtr< FJsonValue >& InJsonValue |
Components/DMMaterialValue.h | ||
virtual TSharedPtr< FJsonValue > JsonSerialize() |
Non-editor implementation. | Components/DMMaterialValue.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName GenerateAutomaticParameterName() |
Generates an automatic path name based on the component hierarchy | Components/DMMaterialValue.h | |
virtual void OnValueChanged
(
EDMUpdateType InUpdateType |
Called when the value changes to call this component's and the parent component's Update if possible. | Components/DMMaterialValue.h | |
void UpdateCachedParameterName
(
bool bInResetName |
Updates the cached parameter name based on the Parameter object or the above method. | Components/DMMaterialValue.h |
Overridden from UDMMaterialComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UDMMaterialComponent * GetSubComponentByPath
(
FDMComponentPath& InPath, |
Searches the component for a specific component based on a path. | Components/DMMaterialValue.h | |
virtual void OnComponentAdded() |
Called when a component enters the Added state. | Components/DMMaterialValue.h | |
virtual void OnComponentRemoved() |
Called when a component enters the Removed state. | Components/DMMaterialValue.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UDMMaterialValue * CreateMaterialValue
(
UDynamicMaterialModel* InMaterialModel, |
Creates a new material value and initializes it with the given material model. | Components/DMMaterialValue.h |
|