1. Epic GamesDeveloper
  3. UDMMaterialLayerObject

UDMMaterialLayerObject

A collection of stages.

API > API/Plugins > API/Plugins/DynamicMaterialEditor

A collection of stages.

   
Name UDMMaterialLayerObject
Type class
Header File /Engine/Plugins/VirtualProduction/DynamicMaterial/Source/DynamicMaterialEditor/Public/Components/DMMaterialLayer.h
Include Path #include "Components/DMMaterialLayer.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMMaterialLayerObject()

   Components/DMMaterialLayer.h  

Typedefs

Name Type Remarks Include Path
FStageCallbackFunc TFunctionRef< void(UDMMaterialStage *)>   Components/DMMaterialLayer.h

Constants

Name Type Remarks Include Path
BasePathToken const FString   Components/DMMaterialLayer.h
EffectStackPathToken const FString   Components/DMMaterialLayer.h
MaskPathToken const FString   Components/DMMaterialLayer.h
StagesPathToken const FString   Components/DMMaterialLayer.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ApplyEffects ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
const UDMMaterialStage* InStage,
TArray< UMaterialExpression* >& InOutStageExpressions,
int32& InOutLastExpressionOutputChannel,
int32& InOutLastExpressionOutputIndex
) const

 Apply the effects from this layer's effect stack to the given expressions based on the type of stage. Components/DMMaterialLayer.h  

bool AreAllStagesEnabled ( EDMMaterialLayerStage InStageScope
) const

 Checks if both stages are enabled and valid Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool AreAllStagesValid ( EDMMaterialLayerStage InStageScope
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool CanMoveLayerAbove ( UDMMaterialLayerObject* InLayer
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool CanMoveLayerBelow ( UDMMaterialLayerObject* InLayer
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

int32 FindIndex()

 Find the index of this layer in the slot. Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

void ForEachEnabledStage ( EDMMaterialLayerStage InStageScope,
FStageCallbackFunc InCallback
) const

 Iterate over only the enabled stages. Components/DMMaterialLayer.h  

void ForEachValidStage ( EDMMaterialLayerStage InStageScope,
FStageCallbackFunc InCallback
) const

 Iterate over all the valid stages, whether they are enabled or not. Components/DMMaterialLayer.h  

void GenerateExpressions ( const TSharedRef< FDMMaterialBuildState >& InBuildState
) const

   Components/DMMaterialLayer.h  

const TArray< TObjectPtr< UDMMaterialStage > > & GetAllStages()

   Components/DMMaterialLayer.h  

UDMMaterialEffectStack * GetEffectStack()

   Components/DMMaterialLayer.h
  • BlueprintPure
  • Category="Material Designer"

UDMMaterialStage * GetFirstEnabledStage ( EDMMaterialLayerStage InStageScope
) const

 Checks for the first enabled and valid stage. Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

UDMMaterialStage * GetFirstValidStage ( EDMMaterialLayerStage InStageScope
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

UDMMaterialStage * GetLastEnabledStage ( EDMMaterialLayerStage InStageScope
) const

 Checks for the last enabled and valid stage. Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

UDMMaterialStage * GetLastValidStage ( EDMMaterialLayerStage InStageScope
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

const FText & GetLayerName()

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

EDMMaterialPropertyType GetMaterialProperty()

   Components/DMMaterialLayer.h
  • BlueprintPure
  • Category="Material Designer"

UDMMaterialLayerObject * GetNextLayer ( EDMMaterialPropertyType InUsingProperty,
EDMMaterialLayerStage InSearchFor
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

UDMMaterialLayerObject * GetPreviousLayer ( EDMMaterialPropertyType InUsingProperty,
EDMMaterialLayerStage InSearchFor
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

UDMMaterialSlot * GetSlot()

   Components/DMMaterialLayer.h
  • BlueprintPure
  • Category="Material Designer"

UDMMaterialStage * GetStage ( EDMMaterialLayerStage InStageType,
bool bInCheckEnabled
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

TArray< UDMMaterialStage * > GetStages ( EDMMaterialLayerStage InStageType,
bool bInCheckEnabled
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

EDMMaterialLayerStage GetStageType ( const UDMMaterialStage* InStage
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool HasValidStage ( const UDMMaterialStage* InStage
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool HasValidStageOfType ( EDMMaterialLayerStage InStageScope
) const

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool IsEnabled()

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool IsStageEnabled ( EDMMaterialLayerStage InStageScope
) const

   Components/DMMaterialLayer.h
  • BlueprintPure
  • Category="Material Designer"

bool IsTextureUVLinkEnabled()

 Texture UV Link means that all stages use the same Texture UV from the base stage, if available. Components/DMMaterialLayer.h
  • BlueprintPure
  • Category="Material Designer"

FString SerializeToString()

 Used for copy+pasting. Components/DMMaterialLayer.h  

bool SetEnabled ( bool bInIsEnabled
)

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

void SetLayerName ( const FText& InName
)

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool SetMaterialProperty ( EDMMaterialPropertyType InMaterialProperty
)

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool SetStage ( EDMMaterialLayerStage InStageType,
UDMMaterialStage* InStage
)

 Replace the specified stage. Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool SetTextureUVLinkEnabled ( bool bInValue
)

 Texture UV Link means that all stages use the same Texture UV from the base stage, if available. Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

bool ToggleTextureUVLinkEnabled()

 Texture UV Link means that all stages use the same Texture UV from the base stage, if available. Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

Overridden from UDMMaterialComponent

Name Remarks Include Path Unreal Specifiers

virtual FText GetComponentDescription()

   Components/DMMaterialLayer.h  

virtual FString GetComponentPathComponent()

   Components/DMMaterialLayer.h  

virtual UDMMaterialComponent * GetParentComponent()

   Components/DMMaterialLayer.h  

virtual void PostEditorDuplicate ( UDynamicMaterialModel* InMaterialModel,
UDMMaterialComponent* InParent
)

   Components/DMMaterialLayer.h  

virtual void Update ( UDMMaterialComponent* InSource,
EDMUpdateType InUpdateType
)

   Components/DMMaterialLayer.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool Modify ( bool bInAlwaysMarkDirty
)

   Components/DMMaterialLayer.h  

virtual void PostEditUndo()

   Components/DMMaterialLayer.h  

Protected

Overridden from UDMMaterialComponent

Name Remarks Include Path Unreal Specifiers

virtual UDMMaterialComponent * GetSubComponentByPath ( FDMComponentPath& InPath,
const FDMComponentPathSegment& InPathSegment
) const

   Components/DMMaterialLayer.h  

virtual void OnComponentAdded()

   Components/DMMaterialLayer.h  

virtual void OnComponentRemoved()

   Components/DMMaterialLayer.h  

Static

Name Remarks Include Path Unreal Specifiers

static UDMMaterialLayerObject * CreateLayer ( UDMMaterialSlot* InSlot,
EDMMaterialPropertyType InMaterialProperty,
const TArray< UDMMaterialStage* >& InStages
)

   Components/DMMaterialLayer.h
  • BlueprintCallable
  • Category="Material Designer"

static UDMMaterialLayerObject * DeserializeFromString ( UDMMaterialSlot* InOuter,
const FString& InSerializedString
)

   Components/DMMaterialLayer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page