|
Module |
|
|
Header |
/Engine/Source/Runtime/Engine/Classes/Materials/MaterialExpression.h |
|
Include |
#include "Materials/MaterialExpression.h" |
class UMaterialExpression : public UObject
| Name | Description | ||
|---|---|---|---|
|
|
uint32: 1 |
bCollapsed |
If true, show a collapsed version of the node |
|
|
uint32: 1 |
bCommentBubbleVisible |
If true, the comment bubble will be visible in the graph editor |
|
|
uint32: 1 |
bHidePreviewWindow |
If true, do not render the preview window for the expression |
|
|
uint8: 1 |
bIsParameterExpression |
Indicates that this is a 'parameter' type of expression and should always be loaded (ie not cooked away) because we might want the default parameter. |
|
|
uint32: 1 |
bNeedToUpdatePreview |
If true, we should update the preview next render. This is set when changing bRealtimePreview. |
|
|
uint32: 1 |
bRealtimePreview |
Set to true by RecursiveUpdateRealtimePreview() if the expression's preview needs to be updated in realtime in the material editor. |
|
|
uint32: 1 |
bShaderInputData |
Whether the node represents an input to the shader or not. Used to color the node's background. |
|
|
uint32: 1 |
bShowInputs |
Whether to draw the expression's inputs. |
|
|
uint32: 1 |
bShowMaskColorsOnPin |
If true, changes the pin color to match the output mask |
|
|
uint32: 1 |
bShowOutputNameOnPin |
If true, use the output name as the label for the pin |
|
|
uint32: 1 |
bShowOutputs |
Whether to draw the expression's outputs. |
|
|
Desc |
A description that level designers can add (shows in the material editor UI). |
|
|
|
TObjectPtr< cla... |
Function |
The material function that this expression is being used with, if any. |
|
|
TObjectPtr< UEd... |
GraphNode |
Expression's Graph representation |
|
|
LastErrorText |
Text of last error for this expression |
|
|
|
TObjectPtr< cla... |
Material |
The material that this expression is currently being compiled in. |
|
|
int32 |
MaterialExpressionEditorX |
|
|
|
int32 |
MaterialExpressionEditorY |
|
|
|
MaterialExpressionGuid |
GUID to uniquely identify this node, to help the tutorials out |
|
|
|
MenuCategories |
Localized categories to sort this expression into... |
|
|
|
int32 |
NumExecutionInputs |
Number of expressions connected to this expression's execution input |
|
|
Outputs |
The expression's outputs, which are set in default properties by derived classes. |
|
|
|
TObjectPtr< UMa... |
SubgraphExpression |
If exists, expresssion containing this expression within its subgraph. |
| Name | Description | |
|---|---|---|
|
|
UMaterialExpression ( |
| Name | Description | ||
|---|---|---|---|
|
|
bool |
CanIgnoreOutputIndex() |
If true, discards the output index when caching this expression which allows more cases to re-use the output instead of adding a separate instruction |
|
|
bool |
CanReferenceTexture() |
Returns true if GetReferencedTexture() can ever return a valid pointer. |
|
|
bool |
CanRenameNode() |
Can this node be renamed? |
|
|
bool |
CanUserDeleteExpression() |
|
|
|
int32 |
Compile ( |
Create the new shader code chunk needed for the Abs expression |
|
|
int32 |
CompilePreview ( |
|
|
|
int32 |
CompilerError ( |
|
|
|
void |
ConnectExpression ( |
Connects the specified input expression to the specified output of this expression. |
|
|
void |
ConnectToPreviewMaterial ( |
Connects the specified output to the passed material for previewing. |
|
|
bool |
ContainsInputLoop ( |
Checks whether any inputs to this expression create a loop |
|
|
bool |
ContainsInputLoopInternal ( |
Checks whether any inputs to this expression create a loop by recursively calling itself and keeping a list of inputs as expression keys. |
|
|
void |
CopyMaterialExpressions ( |
Copy the SrcExpressions into the specified material, preserving internal references. |
|
|
void |
GatherStrataMaterialInfo ( |
Recursively parse nodes outputing strata material in order to gather all the possible shading models used in a material graph output a Strata material. |
|
|
bool |
GenerateHLSLExpression ( |
|
|
|
bool |
GenerateHLSLStatements ( |
A given UMaterial implementation should implement at least one of these methods in order to generate HLSL code It's valid to implement more than one, if the expression can be used in multiple ways. |
|
|
bool |
GetAllInputExpressions ( |
Recursively gets a list of all expressions that are connected to this Checks for repeats so that it can't end up in an infinite loop |
|
|
UObject *... |
GetAssetOwner() |
|
|
|
GetAssetPathName() |
||
|
|
void |
GetCaption |
Returns the text to display on the material expression (in the material editor). |
|
|
void |
GetConnectorToolTip |
Get a tooltip for the specified connector. |
|
|
GetCreationDescription() |
||
|
|
GetCreationName() |
||
|
|
GetDescription() |
Get a single line description of the material expression (used for lists) |
|
|
|
GetEditableName() |
Returns the current 'name' of the node (typically a parameter name). |
|
|
|
void |
GetExecOutputs ( |
|
|
|
void |
GetExpressionToolTip |
Get a tooltip for the expression itself. |
|
|
int32 |
GetHeight() |
|
|
|
FExpressionI... |
GetInput ( |
Get the expression inputs supported by this expression (Note: property inputs NOT included). |
|
|
GetInputName ( |
||
|
|
GetInputPinDefaultValue ( |
||
|
|
GetInputPinProperty ( |
Find the property that is associated with the input pin. |
|
|
|
GetInputPinSubCategory ( |
||
|
|
UObject *... |
GetInputPinSubCategoryObject ( |
|
|
|
const TArray... |
GetInputs() |
Get the expression inputs supported by this expression (Note: property inputs NOT included). |
|
|
uint32 |
GetInputType ( |
|
|
|
GetKeywords() |
Returns the keywords that should be used when searching for this expression |
|
|
|
int |
GetLabelPadding() |
Returns the amount of padding to use for the label. |
|
|
void |
GetLandscapeLayerNames |
|
|
|
FGuid & |
GetMaterialExpressionId() |
Return the material expression guid. |
|
|
GetOutputs() |
Get the outputs supported by this expression. |
|
|
|
uint32 |
GetOutputType ( |
|
|
|
FGuid & |
GetParameterExpressionId() |
Callback to access derived classes' parameter expression id. |
|
|
GetParameterName() |
||
|
|
EMaterialPar... |
GetParameterType() |
|
|
|
bool |
GetParameterValue ( |
|
|
|
GetPreviewOverlayText() |
||
|
|
GetPropertyInputs() |
||
|
|
UObject *... |
GetReferencedTexture() |
Callback to get any texture reference this expression emits. |
|
|
void |
GetTexturesForceMaterialRecompile |
Fill the array with all textures dependence that should trig a recompile of the material. |
|
|
int32 |
GetWidth() |
Get the width required by this expression (in the material editor). |
|
|
bool |
HasAParameterName() |
Parameter Name functions, this is requires as multiple class have ParameterName but are not UMaterialExpressionParameter due to class hierarchy. |
|
|
bool |
HasClassAndNameCollision ( |
|
|
|
bool |
HasConnectedOutputs() |
|
|
|
bool |
HasExecInput() |
|
|
|
void |
InitializeNumExecutionInputs ( |
|
|
|
bool |
IsExpressionConnected ( |
Check if input exppresion is directly connected to the material. |
|
|
bool |
IsInputConnectionRequired ( |
|
|
|
bool |
IsResultMaterialAttributes ( |
Marks certain expression types as outputting material attributes. |
|
|
bool |
IsResultStrataMaterial ( |
Marks certain expression types as outputting Strata material. |
|
|
bool |
IsUsingNewHLSLGenerator() |
|
|
|
bool |
MatchesSearchQuery ( |
MatchesSearchQuery: Check this expression to see if it matches the search query |
|
|
bool |
NeedsRealtimePreview() |
|
|
|
void |
PinDefaultValueChanged ( |
|
|
|
void |
PostCopyNode ( |
Called after a node copy, once the Material and Function properties are set correctly and that all new expressions are added to Material->Expressions |
|
|
void |
SetEditableName ( |
Sets the current 'name' of the node (typically a parameter name) Only valid to call on a node that previously returned CanRenameNode() = true. |
|
|
void |
SetParameterName ( |
|
|
|
bool |
SetParameterValue ( |
|
|
|
FStrataOpera... |
StrataGenerateMaterialTopologyTree ( |
A starta material is a tree with FrontMateiral being its root and BSDF being leaves, with operators in the middle. |
|
|
void |
UpdateMaterialExpressionGuid ( |
Generates a GUID for this expression if one doesn't already exist. |
|
|
void |
UpdateParameterGuid ( |
Generates a GUID for the parameter expression if one doesn't already exist and we are one. |
|
|
bool |
UsesLeftGutter() |
|
|
|
bool |
UsesRightGutter() |
|
|
|
void |
ValidateParameterName ( |
|
|
|
void |
ValidateState() |
Asserts if the expression is not contained by its Material or Function's expressions array. |
| Name | Description | ||
|---|---|---|---|
|
|
bool |
CanEditChange ( |
Called by the editor to query whether a property of this object is allowed to be modified. |
|
|
bool |
Modify ( |
Note that the object will be modified. |
|
|
void |
PostDuplicate ( |
Called after duplication & serialization and before PostLoad. |
|
|
void |
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
void |
PostEditImport() |
Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization |
|
|
void |
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
void |
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
void |
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
|
Name |
Description |
|---|---|
|
CompileExecutionOutputIndex |