1. Epic GamesDeveloper
  3. UDMMaterialEffectStack

UDMMaterialEffectStack

Container for effects. Effects can be applied to either layers (on a per stage basis) or to slots.

API > API/Plugins > API/Plugins/DynamicMaterialEditor

Container for effects. Effects can be applied to either layers (on a per stage basis) or to slots.

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

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup="Material Designer",  
       Meta=(DisplayName="Material Designer Effect Stack"))  
class UDMMaterialEffectStack : public UDMMaterialComponent

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMMaterialEffectStack()

   Components/DMMaterialEffectStack.h  

Typedefs

Name Type Remarks Include Path
FEffectCallbackFunc TFunctionRef< void(UDMMaterialEffect *)>   Components/DMMaterialEffectStack.h

Constants

Name Type Remarks Include Path
EffectsPathToken const FString   Components/DMMaterialEffectStack.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddEffect ( UDMMaterialEffect* InEffect
)

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

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

 Apply all matching effect types to the expressions and add them to the array. Components/DMMaterialEffectStack.h  

void ApplyPreset ( const FDMMaterialEffectStackJson& InPreset
)

 Apply the given preset to this stack. Does not remove old effects. Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"

TArray< UDMMaterialEffect * > BP_GetEffects()

   Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"
  • Meta=(DisplayName="Get Effects")

bool BP_MoveEffectByIndex ( int32 InIndex,
int32 InNewIndex
)

   Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"
  • Meta=(DisplayName="Move Effect (By Index)")

bool BP_MoveEffectByValue ( UDMMaterialEffect* InEffect,
int32 InNewIndex
)

   Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"
  • Meta=(DisplayName="Move Effect (By Value)")

UDMMaterialEffect * BP_RemoveEffectByIndex ( int32 InIndex
)

   Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"
  • Meta=(DisplayName="Remove Effect (By Index)")

bool BP_RemoveEffectByValue ( UDMMaterialEffect* InEffect
)

   Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"
  • Meta=(DisplayName="Remove Effect (By Value)")
Creates a preset based on the current stage. Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"

UDMMaterialEffect * GetEffect ( int32 InIndex
) const

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

const TArray< TObjectPtr< UDMMaterialEffect > > & GetEffects()

   Components/DMMaterialEffectStack.h  

UDMMaterialLayerObject * GetLayer()

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

UDMMaterialSlot * GetSlot()

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

bool HasEffect ( const UDMMaterialEffect* InEffect
) const

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

bool IsEnabled()

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

bool MoveEffect ( UDMMaterialEffect* InEffect,
int32 InNewIndex
)

   Components/DMMaterialEffectStack.h  

bool MoveEffect ( int32 InIndex,
int32 InNewIndex
)

   Components/DMMaterialEffectStack.h  

UDMMaterialEffect * RemoveEffect ( int32 InIndex
)

   Components/DMMaterialEffectStack.h  

bool RemoveEffect ( UDMMaterialEffect* InEffect
)

   Components/DMMaterialEffectStack.h  

UDMMaterialEffect * SetEffect ( int32 InIndex,
UDMMaterialEffect* InEffect
)

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

bool SetEnabled ( bool bInIsEnabled
)

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

Overridden from UDMMaterialComponent

Name Remarks Include Path Unreal Specifiers

virtual FText GetComponentDescription()

   Components/DMMaterialEffectStack.h  

virtual FString GetComponentPathComponent()

   Components/DMMaterialEffectStack.h  

virtual UDMMaterialComponent * GetParentComponent()

   Components/DMMaterialEffectStack.h  

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

   Components/DMMaterialEffectStack.h  

virtual void Update ( UDMMaterialComponent* InSource,
EDMUpdateType InUpdateType
)

   Components/DMMaterialEffectStack.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool Modify ( bool bInAlwaysMarkDirty
)

   Components/DMMaterialEffectStack.h  

virtual void PostEditUndo()

   Components/DMMaterialEffectStack.h  

Protected

Name Remarks Include Path Unreal Specifiers

TArray< UDMMaterialEffect * > GetIncompatibleEffects ( UDMMaterialEffect* InEffect
)

   Components/DMMaterialEffectStack.h  

TArray< UDMMaterialEffect * > RemoveIncompatibleEffects ( UDMMaterialEffect* InEffect
)

 Returns the removed effects. Components/DMMaterialEffectStack.h  

Overridden from UDMMaterialComponent

Name Remarks Include Path Unreal Specifiers

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

   Components/DMMaterialEffectStack.h  

virtual void OnComponentAdded()

   Components/DMMaterialEffectStack.h  

virtual void OnComponentRemoved()

   Components/DMMaterialEffectStack.h  

Static

Name Remarks Include Path Unreal Specifiers
  Components/DMMaterialEffectStack.h  
  Components/DMMaterialEffectStack.h  

static UDMMaterialEffectStack * CreateEffectStackForLayer ( UDMMaterialLayerObject* InLayer
)

   Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"
  • Meta=(DisplayName="Create Effect Stack (For Layer)")

static UDMMaterialEffectStack * CreateEffectStackForSlot ( UDMMaterialSlot* InSlot
)

   Components/DMMaterialEffectStack.h
  • BlueprintCallable
  • Category="Material Designer"
  • Meta=(DisplayName="Create Effect Stack (For Slot)")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page