1. Epic GamesDeveloper
  3. UDMMaterialProperty

UDMMaterialProperty

Base Color, Specular, Opacity, etc

API > API/Plugins > API/Plugins/DynamicMaterialEditor > API/Plugins/DynamicMaterialEditor/Components

Inheritance Hierarchy

References

   
Module DynamicMaterialEditor
Header /Engine/Plugins/Experimental/DynamicMaterial/Source/DynamicMaterialEditor/Public/Components/DMMaterialProperty.h
Include #include "Components/DMMaterialProperty.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup="Material Designer",  
       Meta=(DisplayName="Material Designer Property"))  
class UDMMaterialProperty : public UDMMaterialComponent

Remarks

Base Color, Specular, Opacity, etc

Variables

  Type Name Description
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly bool bEnabled Whether this property is enabled. If it is not enabled, it will generate no expressions.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly TMap< FName, TObjectPtr< UDMMaterialComponent > > Components Components of this property. Not necessarily owned or controlled by this property.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly FDMMaterialStageConnection InputConnectionMap The map of expressions connected to this property's input node.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly EDMValueType InputConnectorType The value type used to connect to this property.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly EDMMaterialPropertyType MaterialProperty The property type of this property.
Protected variable UProperty Category BlueprintReadOnly visibleinstanceonly TObjectPtr< UMaterialFunctionInterface > OutputProcessor An optional material function which is applied in between the property and its inputs.
Protected variable UProperty Transient textexporttransient TObjectPtr< UMaterialFunctionInterface > OutputProcessor_PreUpdate  

Constructors

  Type Name Description
Public function    
Protected function  

UDMMaterialProperty ( EDMMaterialPropertyType InMaterialProperty,
EDMValueType InInputConnectorType
)

  

Functions

  Type Name Description
Public function Virtual Const void

AddAlphaMultiplier ( const TSharedRef< FDMMaterialBuildState >& InBuildState
)

 Adds the alpha multiplier.
Public function Virtual UDMMaterialComponent *

AddComponent ( FName InName,
UDMMaterialComponent* InComponent
)

 Adds a component to the component list. Sets component state to added.
Public function Virtual void Adds the default base stage for a layer in this property.
Public function Virtual void Adds the default mask stage for a layer in this property.
Public function Virtual Const void

AddOutputProcessor ( const TSharedRef< FDMMaterialBuildState >& InBuildState
)

 Adds the output processor to the end of the current expression chain.
Protected function Static UMaterialExpression *

CreateConstant ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
const FVector3d& InDefaultValue
)

  
Protected function Static UMaterialExpression *

CreateConstant ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
const FVector4d& InDefaultValue
)

  
Protected function Static UMaterialExpression *

CreateConstant ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
const FVector2d& InDefaultValue
)

  
Protected function Static UMaterialExpression *

CreateConstant ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
float InDefaultValue
)

  
Public function Static UDMMaterialProperty *

CreateCustomMaterialPropertyDefaultSubobject ( UDynamicMaterialModelEditorOnlyData* InModelEditorOnlyData,
EDMMaterialPropertyType InMaterialProperty,
const FName& InSubObjName
)

 Craetes a material property as a default subobject of the EditorOnlyData object.
Public function Virtual Const void

GenerateExpressions ( const TSharedRef< FDMMaterialBuildState >& InBuildState
)

 Generates the base expressions for this slot.
Public function Static void

GenerateOpacityExpressions ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
UDMMaterialSlot* InFromSlot,
EDMMaterialPropertyType InFromProperty,
UMaterialExpression*& OutExpression,
int32& OutOutputIndex,
int32& OutOutputChannel
)

 Adds expressions to opacity properties based on color channel.
Public function Virtual void

GeneratePreviewMaterial ( UMaterial* InPreviewMaterial
)

 Adds nodes to the given material based on this property's generated expressions.
Public function Virtual Const UDMMaterialComponent *

GetComponent ( FName InName
)

 Fetches a component from the component list.
Public function Virtual Const UMaterialExpression *

GetDefaultInput ( const TSharedRef< FDMMaterialBuildState >& InBuildState
)

 Generates a default input node for this property if the layer stack is empty.
Public function Const UFunction BlueprintPure, Category FText The description of this property based on the EDMMaterialPropertyType enum.
Public function Const UFunction BlueprintPure, Category const FDMMaterialStageConnection &  
Public function FDMMaterialStageConnection &  
Public function Const UFunction BlueprintPure, Category EDMValueType  
Public function Const UFunction BlueprintPure, Category UDynamicMaterialModelEditorOnlyData *  
Public function Const UFunction BlueprintPure, Category EDMMaterialPropertyType  
Public function Const UFunction BlueprintPure, Category UMaterialFunctionInterface * The output process is an optional material function which is applied in between the property and its inputs.
Public function Virtual Const TEnumAsByte< EMaterialSamplerType >  
Public function Const InClassName *

GetTypedComponent ( FName InName
)

  
Public function Virtual Const bool

HasComponent ( FName InName
)

 Checks to see if a component with this name exists.
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category bool Whether this property represents a material pin.
Public function Virtual Const bool Check whether the current model settings are valid for this property.
Public function void  
Protected function void Triggered when the output process is updated either through PostEditChangeProperty or via the setter.
Public function Virtual void Triggered when a slot is added to this property. Should create useful, default layer stack.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

  
Public function Virtual void

PreEditChange ( FProperty* InPropertyAboutToChange
)

  
Public function Virtual UDMMaterialComponent *

RemoveComponent ( FName InName
)

 Removes the component from the component list. Sets component state to removed.
Public function Virtual UFunction BlueprintCallable, Category void Empty the connection map and recalculate the input types.
Public function UFunction BlueprintCallable, Category void

SetEnabled ( bool bInEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetOutputProcessor ( UMaterialFunctionInterface* InFunction
)

 The output process is an optional material function which is applied in between the property and its inputs.

Overridden from UDMMaterialComponent

  Type Name Description
Public function Virtual Const FString Returns the part of the component representing just this object
Protected function Virtual Const UDMMaterialComponent * Searches the component for a specific component based on a path.
Protected function Virtual void Called when a component enters the Added state.
Protected function Virtual void Called when a component enters the Removed state.
Public function Virtual void Called to ensure that the object hierarchy is correct.
Public function Virtual void

Update ( UDMMaterialComponent* InSource,
EDMUpdateType InUpdateType
)

 Event that is triggered when this component, or a sub-component, changes to trigger other updates in the model.

Constants

Name Description
ComponentsPathToken  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page