1. Epic GamesDeveloper
  3. FMaterialXSurfaceShaderAbstract

FMaterialXSurfaceShaderAbstract

API > API/Plugins > API/Plugins/InterchangeImport > API/Plugins/InterchangeImport/MaterialX > API/Plugins/InterchangeImport/MaterialX/MaterialXUtils

Inheritance Hierarchy

References

   
Module InterchangeImport
Header /Engine/Plugins/Interchange/Runtime/Source/Import/Public/MaterialX/MaterialXUtils/MaterialXSurfaceShaderAbstract.h
Include #include "MaterialX/MaterialXUtils/MaterialXSurfaceShaderAbstract.h"

Syntax

class FMaterialXSurfaceShaderAbstract : public FMaterialXBase

Variables

  Type Name Description
Protected variable bool bTangentSpaceInput Used for texture compression and transform to tangent space nodes coming from inputs such as coat_normal
Protected variable TMap< FString, FOnConnectNodeOutputToInput > MatchingConnectNodeDelegates Matching MaterialX category and Connect function
Protected variable UInterchangeShaderGraphNode * ShaderGraphNode Initialized by the material shader (e.g: surfacematerial), the derived class should only set the ShaderType
Protected variable TMap< FNodeOutput, UInterchangeShaderNode * > ShaderNodes Store the shader nodes only when we create the shader graph node
Protected variable MaterialX::NodePtr SurfaceShaderNode The surface shader node processed during the Translate, up to the derived class to initialize it

Constructors

  Type Name Description
Protected function    

Functions

  Type Name Description
Protected function bool

AddAttribute ( MaterialX::InputPtr Input,
const FString& InputChannelName,
UInterchangeShaderNode* ShaderNode,
int32 OutputIndex
)

 Add an attribute to a shader node from the given MaterialX input.
Protected function bool

AddAttributeFromValueOrInterface ( MaterialX::InputPtr Input,
const FString& InputChannelName,
UInterchangeShaderNode* ShaderNode,
int32 OutputIndex
)

 Add an attribute to a shader node from the given MaterialX input if that input has either a value or an interface name.
Protected function bool

AddBooleanAttribute ( MaterialX::InputPtr Input,
const FString& InputChannelName,
UInterchangeShaderNode* ShaderNode
)

 Add a bool attribute to a shader node only if its value taken from the input is not equal to its default value.
Protected function bool

AddFloatAttribute ( MaterialX::InputPtr Input,
const FString& InputChannelName,
UInterchangeShaderNode* ShaderNode,
float DefaultValue
)

 Add a float attribute to a shader node only if its value taken from the input is not equal to its default value.
Protected function bool

AddLinearColorAttribute ( MaterialX::InputPtr Input,
const FString& InputChannelName,
UInterchangeShaderNode* ShaderNode,
const FLinearColor& DefaultValue,
int32 OutputIndex
)

 Add an FLinearColor attribute to a shader node only if its value taken from the input is not equal to its default value.
Protected function bool

AddVectorAttribute ( MaterialX::InputPtr Input,
const FString& InputChannelName,
UInterchangeShaderNode* ShaderNode,
const FVector4f& DefaultValue,
int32 OutputIndex
)

 Add an FLinearColor attribute to a shader node only if its value taken from the input is not equal to its default value.
Protected function void
Protected function void
Protected function void
Protected function void Begin Connect MaterialX nodes
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function bool Create and connect the output of a MaterialX node that has already a matching in UE to a shader node.
Protected function void

ConnectNodeCategoryOutputToInput ( const MaterialX::Edge& Edge,
UInterchangeShaderNode* ParentShaderNode,
const FString& InputChannelName,
const FString& OutputName
)

 Create and connect manually the output of a MaterialX node to a shader node.
Protected function bool

ConnectNodeGraphOutputToInput ( MaterialX::InputPtr InputToNodeGraph,
UInterchangeShaderNode* ShaderNode,
const FString& ParentInputName
)

 Connect an ouput in the NodeGraph to the ShaderGraph.
Protected function bool

ConnectNodeNameOutputToInput ( MaterialX::InputPtr Input,
UInterchangeShaderNode* ShaderNode,
const FString& ParentInputName
)

 Create and connect a node name directly connected from an input to a shader node.
Protected function bool

ConnectNodeOutputToInput ( const char* InputName,
UInterchangeShaderNode* ShaderNode,
const FString& InputShaderName,
T DefaultValue,
bool bIsTangentSpaceInput
)

 Connect an output either from a node name or a node graph from a MaterialX input to the shader node.
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function void
Protected function UInterchangeFunctionCallShaderNode *

CreateFunctionCallShaderNode ( const FString& NodeName,
uint8 EnumType,
uint8 EnumValue,
const FString& OutputName
)

  
Protected function UInterchangeFunctionCallShaderNode *

CreateFunctionCallShaderNode ( MaterialX::ElementPtr Element,
const FString& NodeName,
const FString& FunctionPath,
const FString& OutputName
)

 Helper function to create an InterchangeFunctionCallShaderNode.
Protected function UInterchangeShaderNode *

CreateMaskShaderNode ( uint8 RGBA,
MaterialX::ElementPtr Element,
const FString& NodeName,
const FString& OutputName
)

 End Connect MaterialX nodes Create a ComponentMask shader node.
Protected function UInterchangeShaderNode *

CreateShaderNode ( MaterialX::ElementPtr Element,
const FString& NodeName,
const FString& ShaderType,
const FString& OutputName
)

 Helper function to create an InterchangeShaderNode.
Protected function Const UInterchangeTextureNode *

CreateTextureNode ( MaterialX::NodePtr Node
)

 Helper function to create an InterchangeTextureNode.
Protected function Const FString

GetAttributeParentName ( MaterialX::NodePtr Node
)

 Retrieve the Interchange parent name of a MaterialX node.
Protected function Const FString

GetFilePrefix ( MaterialX::ElementPtr Element
)

 Return the innermost file prefix of an element in the current scope.
Protected function Const FString

GetInputName ( MaterialX::InputPtr Input
)

 Get the input name.
Protected function Const const FString &

GetMatchedInputName ( MaterialX::NodePtr Node,
MaterialX::InputPtr Input
)

 Get the UE corresponding name of a MaterialX Node category and input for a material.
Protected function Const FString

GetUniqueName ( MaterialX::ElementPtr Element
)

 Ensure that we put in the node container the unique name, 2 nodes in a same file may have the same name as long as their parent's name is different, we just traverse the whole hierarchy to have a unique name
Protected function Const FLinearColor

GetVector ( MaterialX::InputPtr Input
)

 Helper function that returns a vector.
Protected function Virtual void  
Protected function Const void

SetAttributeNewName ( MaterialX::InputPtr Input,
const char* NewName
)

 Add the input new name under the attribute UE::NewName.
Protected function Const void

SetMatchingInputsNames ( MaterialX::NodePtr Node
)

 Set the matching inputs names of a node to correspond to the one used by UE.
Protected function UInterchangeShaderNode * This function should be called first by the Translate method of derived class, SurfaceShaderNode should initialized first by the derived class

Overridden from FMaterialXBase

  Type Name Description
Protected function void

Translate ( MaterialX::NodePtr ShaderNode
)

  

Classes

  Type Name Description
Protected struct FConnectNode    

Typedefs

Name Description
FNodeOutput  
FOnConnectNodeOutputToInput  

Constants

Name Description
DefaultOutput MaterialX states the default output name of the different nodes is 'out'.
EmptyString  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page