1. Epic GamesDeveloper
  3. UDMMaterialStage

UDMMaterialStage

A component which wraps a source and its inputs.

API > API/Plugins > API/Plugins/DynamicMaterialEditor

A component which wraps a source and its inputs.

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

Syntax

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

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UDMMaterialStage()

   Components/DMMaterialStage.h  

Typedefs

Name Type Remarks Include Path
FInputInitFunctionPtr TFunction< void(UDMMaterialStage *, UDMMaterialStageInput *)>   Components/DMMaterialStage.h
FSourceInitFunctionPtr TFunction< void(UDMMaterialStage *, UDMMaterialStageSource *)>   Components/DMMaterialStage.h

Constants

Name Type Remarks Include Path
InputsPathToken const FString   Components/DMMaterialStage.h
SourcePathToken const FString   Components/DMMaterialStage.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddInput ( UDMMaterialStageInput* InNewInput
)

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

bool CanChangeSource()

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

InInputClass * ChangeInput ( int32 InInputIdx,
int32 InInputChannel,
int32 InOutputIdx,
int32 InOutputChannel,
FInputInitFunctionPtr InPreInit
)

   Components/DMMaterialStage.h  

UDMMaterialStageInput * ChangeInput ( TSubclassOf< UDMMaterialStageInput > InInputClass,
int32 InInputIdx,
int32 InInputChannel,
int32 InOutputIdx,
int32 InOutputChannel
)

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

InInputClass * ChangeInput ( TSubclassOf< UDMMaterialStageInput > InInputSubclass,
int32 InInputIdx,
int32 InInputChannel,
int32 InOutputIdx,
int32 InOutputChannel,
FInputInitFunctionPtr InPreInit
)

   Components/DMMaterialStage.h  

UDMMaterialStageInput * ChangeInput ( TSubclassOf< UDMMaterialStageInput > InInputClass,
int32 InInputIdx,
int32 InInputChannel,
int32 InOutputIdx,
int32 InOutputChannel,
FInputInitFunctionPtr InPreInit
)

 Creates a new input value and maps it to a specific source input. Components/DMMaterialStage.h  

UDMMaterialStageSource * ChangeInput_PreviousStage ( int32 InInputIdx,
int32 InInputChannel,
EDMMaterialPropertyType InPreviousStageProperty,
int32 InOutputIdx,
int32 InOutputChannel
)

 Changes the input of the given input index to the output of the previous stage with the given material property. Components/DMMaterialStage.h
  • BlueprintCallable
  • Category="Material Designer"

InSourceClass * ChangeSource ( TSubclassOf< UDMMaterialStageSource > InSourceSubclass,
FSourceInitFunctionPtr InPreInit
)

   Components/DMMaterialStage.h  

UDMMaterialStageSource * ChangeSource ( TSubclassOf< UDMMaterialStageSource > InSourceClass,
FSourceInitFunctionPtr InPreInit
)

   Components/DMMaterialStage.h  

InSourceClass * ChangeSource ( FSourceInitFunctionPtr InPreInit
)

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

int32 FindIndex()

 Returns the index of this stage in the layer. Components/DMMaterialStage.h
  • BlueprintCallable
  • Category="Material Designer"

const FDMMaterialStageConnectorChannel * FindInputChannel ( UDMMaterialStageInput* InStageInput
)

   Components/DMMaterialStage.h  

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

   Components/DMMaterialStage.h  

void GeneratePreviewMaterial ( UMaterial* InPreviewMaterial
)

   Components/DMMaterialStage.h
  • BlueprintCallable
  • Category="Material Designer"
Determines what connects to what on this stage's Source. Components/DMMaterialStage.h
  • BlueprintPure
  • Category="Material Designer"
  Components/DMMaterialStage.h  

const TArray< UDMMaterialStageInput * > & GetInputs()

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

UDMMaterialLayerObject * GetLayer()

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

UDMMaterialStage * GetNextStage()

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

UDMMaterialStage * GetPreviousStage()

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

TMap< EDMMaterialPropertyType, UDMMaterialLayerObject * > GetPreviousStagesPropertyMap()

 Get the last layer for each property type from the previous stages. Components/DMMaterialStage.h  
Get the last layer for each property type from all stages. Components/DMMaterialStage.h  

UDMMaterialStageSource * GetSource()

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

EDMValueType GetSourceType ( const FDMMaterialStageConnectorChannel& InChannel
) const

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

virtual void InputUpdated ( UDMMaterialStageInput* InInput,
EDMUpdateType InUpdateType
)

 Called when one of the inputs triggers it's Update event. Components/DMMaterialStage.h  

virtual bool IsCompatibleWithNextStage ( const UDMMaterialStage* InNextStage
) const

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

virtual bool IsCompatibleWithPreviousStage ( const UDMMaterialStage* InPreviousStage
) const

 Returns true if the output of the previous stage can connect to this stage. Components/DMMaterialStage.h
  • BlueprintPure
  • Category="Material Designer"

bool IsEnabled()

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

bool IsInputMapped ( int32 InputIndex
) const

 Returns true if the given source's input is mapped to an input (or the previous stage). Components/DMMaterialStage.h
  • BlueprintCallable
  • Category="Material Designer"

void RemoveAllInputs()

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

void RemoveInput ( UDMMaterialStageInput* InInput
)

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

void RemoveUnusedInputs()

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

virtual void ResetInputConnectionMap()

 Verifies the entire input connection map. Components/DMMaterialStage.h
  • BlueprintCallable
  • Category="Material Designer"

void SetCanChangeSource ( bool bInCanChangeSource
)

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

bool SetEnabled ( bool bInEnabled
)

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

void SetSource ( UDMMaterialStageSource* InSource
)

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

void UpdateInputMap ( int32 InInputIdx,
int32 InSourceIndex,
int32 InInputChannel,
int32 InOutputIdx,
int32 InOutputChannel,
EDMMaterialPropertyType InStageProperty
)

 Changes the input mapping. Components/DMMaterialStage.h  

bool VerifyAllInputMaps()

 Returns true if any changes were made Components/DMMaterialStage.h
  • BlueprintCallable
  • Category="Material Designer"

bool VerifyInputMap ( int32 InInputIdx
)

 Returns true if any changes were made Components/DMMaterialStage.h
  • BlueprintCallable
  • Category="Material Designer"

Overridden from UDMMaterialComponent

Name Remarks Include Path Unreal Specifiers

virtual FText GetComponentDescription()

   Components/DMMaterialStage.h  

virtual FSlateIcon GetComponentIcon()

   Components/DMMaterialStage.h  

virtual FString GetComponentPathComponent()

   Components/DMMaterialStage.h  

virtual UDMMaterialComponent * GetParentComponent()

   Components/DMMaterialStage.h  

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

   Components/DMMaterialStage.h  

virtual void Update ( UDMMaterialComponent* InSource,
EDMUpdateType InUpdateType
)

   Components/DMMaterialStage.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool Modify ( bool bInAlwaysMarkDirty
)

   Components/DMMaterialStage.h  

virtual void PostEditUndo()

   Components/DMMaterialStage.h  

Protected

Overridden from UDMMaterialComponent

Name Remarks Include Path Unreal Specifiers

virtual void GetComponentPathInternal ( TArray< FString >& OutChildComponentPathComponents
) const

   Components/DMMaterialStage.h  

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

   Components/DMMaterialStage.h  

virtual void OnComponentAdded()

   Components/DMMaterialStage.h  

virtual void OnComponentRemoved()

   Components/DMMaterialStage.h  

Static

Name Remarks Include Path Unreal Specifiers

static UDMMaterialStage * CreateMaterialStage ( UDMMaterialLayerObject* InLayer
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page