1. Epic GamesDeveloper
  3. UDMMaterialStageThroughput

UDMMaterialStageThroughput

A node which take one or more inputs and produces an output (e.g. Multiply)

API > API/Plugins > API/Plugins/DynamicMaterialEditor

A node which take one or more inputs and produces an output (e.g. Multiply)

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

Syntax

UCLASS (MinimalAPI, Abstract, BlueprintType, ClassGroup="Material Designer",  
       Meta=(DisplayName="Material Designer Stage Throughput"))  
class UDMMaterialStageThroughput : public UDMMaterialStageSource

Inheritance Hierarchy

Derived Classes

UDMMaterialStageThroughput derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Components/DMMaterialStageThroughput.h  

UDMMaterialStageThroughput ( const FText& InName
)

   Components/DMMaterialStageThroughput.h  

Constants

Name Type Remarks Include Path
Throughputs TArray< TStrongObjectPtr< UClass > >   Components/DMMaterialStageThroughput.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddDefaultInput ( int32 InInputIndex
) const

 When the node is instantiated, this method adds default input values based on type. Components/DMMaterialStageThroughput.h  

bool AllowsNestedInputs()

 Returns true if this node's inputs can have their own inputs. Components/DMMaterialStageThroughput.h
  • BlueprintPure
  • Category="Material Designer"

virtual bool CanChangeInput ( int32 InThroughputInputIndex
) const

 Whether the value of the given input change. Components/DMMaterialStageThroughput.h  

virtual bool CanChangeInputType ( int32 InThroughputInputIndex
) const

 Whether you can change the type of the given input. Components/DMMaterialStageThroughput.h  

virtual bool CanInputAcceptType ( int32 InThroughputInputIndex,
EDMValueType InValueType
) const

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

virtual bool CanInputConnectTo ( int32 InThroughputInputIndex,
const FDMMaterialStageConnector& InOutputConnector,
int32 InOutputChannel,
bool bInCheckSingleFloat
)

 Whether the given output connector can connect to this node. Components/DMMaterialStageThroughput.h
  • BlueprintCallable
  • Category="Material Designer"

virtual void ConnectOutputToInput ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
int32 InThroughputInputIndex,
int32 InExpressionInputIndex,
UMaterialExpression* InSourceExpression,
int32 InSourceOutputIndex,
int32 InSourceOutputChannel
)

 Connect the output of a node to the given input of this node. Components/DMMaterialStageThroughput.h  

const FText & GetDescription()

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

virtual UMaterialExpression * GetExpressionForInput ( const TArray< UMaterialExpression* >& InStageSourceExpressions,
int32 InThroughputInputIndex,
int32 InExpressionInputIndex
)

 Override this to redirect inputs to other nodes. Components/DMMaterialStageThroughput.h  

const TArray< FDMMaterialStageConnector > & GetInputConnectors()

   Components/DMMaterialStageThroughput.h
  • BlueprintPure
  • Category="Material Designer"
Returns all the material nodes requires to create this node's Texture UV input. Components/DMMaterialStageThroughput.h  

virtual int32 GetLayerMaskTextureUVLinkInputIndex()

 Returns the input index for the default implementation of the below method. Components/DMMaterialStageThroughput.h  

bool IsInputRequired()

 Returns true if input is required to successfully compile this node. Components/DMMaterialStageThroughput.h
  • BlueprintPure
  • Category="Material Designer"

virtual bool IsInputVisible ( int32 InThroughputInputIndex
) const

 Whether this input will show up in the Material Designer editor. Components/DMMaterialStageThroughput.h  

virtual void OnInputUpdated ( int32 InThroughputInputIndex,
EDMUpdateType InUpdateType
)

 This is called when the input value of this node's stage is updated. Components/DMMaterialStageThroughput.h  

virtual void OnPostInputAdded ( int32 InInputIdx
)

   Components/DMMaterialStageThroughput.h  

virtual int32 ResolveInput ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
int32 InThroughputInputIndex,
FDMMaterialStageConnectorChannel& OutChannel,
TArray< UMaterialExpression* >& OutExpressions
) const

 Generates (or retrieves) expressions that produce this input for the node. Components/DMMaterialStageThroughput.h  

virtual int32 ResolveLayerMaskTextureUVLinkInput ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
int32 InThroughputInputIndex,
FDMMaterialStageConnectorChannel& OutChannel,
TArray< UMaterialExpression* >& OutExpressions
) const

 If this is on a Mask stage and it is the UV input index, this method is used to retrieve the base stage's UV input. Components/DMMaterialStageThroughput.h  

virtual bool SupportsLayerMaskTextureUVLink()

 Returns true if the layer and mask can have their Texture UV linked. Components/DMMaterialStageThroughput.h  

Overridden from UDMMaterialComponent

Name Remarks Include Path Unreal Specifiers

virtual FText GetComponentDescription()

   Components/DMMaterialStageThroughput.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ConnectOutputToInput_Internal ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
UMaterialExpression* InTargetExpression,
int32 InExpressionInputIndex,
UMaterialExpression* InSourceExpression,
int32 InSourceOutputIndex,
int32 InSourceOutputChannel
) const

 @See ConnectOutputToInput Components/DMMaterialStageThroughput.h  

virtual void GeneratePreviewMaterial ( UMaterial* InPreviewMaterial
)

 Generates a material based on the output of just this node. Components/DMMaterialStageThroughput.h  

virtual int32 ResolveInputChannel ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
int32 InThroughputInputIndex,
int32 InChannelIndex,
FDMMaterialStageConnectorChannel& OutChannel,
TArray< UMaterialExpression* >& OutExpressions
) const

 Finds the input for the individual channel. Components/DMMaterialStageThroughput.h  

virtual bool ShouldKeepInput ( int32 InThroughputInputIndex
)

 When the stage's source is changed, whether the given of input from the previous source should be kept. Components/DMMaterialStageThroughput.h  

Overridden from UDMMaterialComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnComponentAdded()

   Components/DMMaterialStageThroughput.h  

Static

Name Remarks Include Path Unreal Specifiers

static void GenerateThroughputList()

   Components/DMMaterialStageThroughput.h  

static const TArray< TStrongObjectPtr< UClass > > & GetAvailableThroughputs()

   Components/DMMaterialStageThroughput.h  

static int32 ResolveLayerMaskTextureUVLinkInputImpl ( const TSharedRef< FDMMaterialBuildState >& InBuildState,
const UDMMaterialStageSource* InStageSource,
FDMMaterialStageConnectorChannel& OutChannel,
TArray< UMaterialExpression* >& OutExpressions
)

 @See ResolveLayerMaskTextureUVLinkInput Components/DMMaterialStageThroughput.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page