1. Epic GamesDeveloper
  3. UTG_Graph

UTG_Graph

API > API/Plugins > API/Plugins/TextureGraph

Inheritance Hierarchy

References

   
Module TextureGraph
Header /Engine/Plugins/Experimental/TextureGraph/Source/TextureGraph/Public/TG_Graph.h
Include #include "TG_Graph.h"

Syntax

UCLASS ()  
class UTG_Graph : public UObject

Variables

  Type Name Description
Protected variable UProperty Transient bool bIsGraphTraversalDirty Pure data struct evaluated at runtime when traversal is required And a dirty flag
Protected variable UProperty TArray< TObjectPtr< UObject > > ExtraEditorNodes Extra data to hold information that is useful only in editor (like comments)
Public variable FOnTextureGraphChanged OnGraphChangedDelegate  
Public variable FOnNodeEvaluation OnNodePostEvaluateDelegate  
Public variable FOnTGNodeSignatureChanged OnNodeSignatureChangedDelegate Notifiers.
Public variable FOnTGNodeAdded OnTGNodeAddedDelegate  
Public variable FOnTGNodeRemoved OnTGNodeRemovedDelegate  
Public variable FOnTGNodeRenamed OnTGNodeRenamedDelegate  
Protected variable UProperty Transient FTG_GraphTraversal Traversal  

Functions

  Type Name Description
Public function void

AddPostPasteNode ( UTG_Node* NewNode
)

 Accessed from TG_EdGraphNode after a paste of a new node.
Public function Const void

AppendParamsSignature ( FTG_Arguments& InOutArguments,
TArray< FTG_Id >& InParams,
TArray< FTG_Id >& OutParams
)

 Create a Signature from the current graph topology declaring the current Params as Arguments The signature list the input and output pins of the graph
Public function Static bool

ArePinsCompatible ( const UTG_Pin* PinFrom,
const UTG_Pin* PinTo,
FName& ConverterKey
)

 Are 2 Pins compatible ? This function check that the 2 pins can be connected to each other in terms of their argument types A non empty ConverterKey is also returned if required to achieve a conversion of the pin A to the pin B The converterKey is then used during the evaluation to find the proper Converter
Public function bool

Connect ( UTG_Node& NodeFrom,
FTG_Name& PinFrom,
UTG_Node& NodeTo,
FTG_Name& PinTo
)

 Connect a output pin from a node to the specified input pin of the to node Return true if the edge is created or false if couldn't create the edge
Public function Static bool

ConnectionCausesLoop ( const UTG_Pin* PinFrom,
const UTG_Pin* PinTo
)

 Check that the connection from PinFrom to PInTO doesn't create a loop.
Public function Virtual void

Construct ( FString InName
)

 Construct the Graph, can only be done once before "using" the graph.
Public function UTG_Node * Create a node from an initialized Expression A new Node instance is created which uses initialized expression The Node is setup with its input and output pins reflecting the Signature of the Expression.
Public function UTG_Node *

CreateExpressionNode ( const UClass* ExpressionClass
)

 Create a node from an Expression Class A new Expression instance is created along with the Node instance The Node is setup with its input and output pins reflecting the Signature of the Expression.
Protected function Const void  
Protected function Const void  
Public function void Evaluate the graph Traverse every nodes in the traversal order and call the node's expression evaluate method A configured evaluation context with a valid Cycle is required Evaluation is concretely implemented in FTG_Evaluation struct
Public function Const const UTG_Pin *

FindParamPin ( const FName& InName
)

  
Public function UTG_Pin *

FindParamPin ( const FName& InName
)

  
Public function Const FTG_Id

FindParamPinId ( const FName& InName
)

 Find a param pin from its name.
Public function Const void

ForEachEdges ( std::function< void(const UTG_Pin*, const UTG_Pin*)> visitor
)

 Iterate through all the VALID edges.
Public function Const void

ForEachNodes ( std::function< void(const UTG_Node*, uint32)> visitor
)

 Iterate through all the VALID nodes.
Public function void

ForEachOutputSettings ( std::function< void(const FTG_OutputSettings&)> visitor
)

 Iterate through all the output settings.
Public function Const void

ForEachParams ( std::function< void(const UTG_Pin*, uint32)> visitor
)

 Iterate through all the VALID Param pins.
Public function Const void

ForEachPins ( std::function< void(const UTG_Pin*, uint32, uint32)> visitor
)

 Iterate through all the VALID pins.
Public function Const void

ForEachVars ( std::function< void(const FTG_Var*, uint32, uint32)> visitor
)

 Iterate through all the VALID vars.
Public function Const TArray< FTG_Id >

GatherAllSourceNodes ( const UTG_Node* Node
)

 Useful function to navigate the Nodes Collect all the nodes which are connecting directly or indirectly into the specified node
Protected function Const void

GatherOuterNodes ( const TArray< FTG_Ids >& sourceNodesPerNode,
TSet< FTG_Id >& nodeReservoirA,
TSet< FTG_Id >& nodeReservoirB
)

 Utility functions used to establish the traversal order.
Public function Const TArray< FTG_Id >

GatherSourceNodes ( const UTG_Node* Node
)

 Traverseal of the graph and evaluation.
Public function Const int

GetAllOutputParamValues ( TArray< FTG_Variant >& OutVariants,
TArray< FName >* OutNames
)

 Get all the output param's value as FTG_Variant along with their names optionally
Public function Const const TArray< TObjectPtr< UObject > > &  
Public function Const FTG_Ids  
Public function Const const UTG_Node *

GetNode ( FTG_Id NodeId
)

  
Public function UTG_Node *

GetNode ( FTG_Id NodeId
)

 Accessors for nodes, pins, params.
Public function UTG_Node *  
Public function Const FTG_Ids  
Public function Const int

GetOutputParamTextures ( TArray< FName >& OutNames,
FTG_Ids& OutPinIds
)

 Get the names and ids of the output params which are Textures.
Public function Const bool

GetOutputParamValue ( const FName& InName,
FTG_Variant& OutVariant
)

 Accessors for output param values after evaluation Only valid AFTER Evaluation of the graph Get the nammed output param value as FTG_Variant if it exists.
Public function Const FTG_Ids  
Public function Const TArray< FName >  
Public function Const const UTG_Pin *

GetPin ( FTG_Id PinId
)

  
Public function UTG_Pin *

GetPin ( FTG_Id PinId
)

  
Public function Const const FTG_GraphTraversal & Access the traversal (update it if needed)
Public function FTG_Var *

GetVar ( FTG_Id VarId
)

  
Protected function bool

IsDependentInternal ( const UTG_Graph* SourceGraph,
TArray< UTG_Graph* >& DependentGraphs
)

  
Public function void

Log ()

 Log the graph description to the log output buffer.
Public function Static FString

LogCall ( const TArray< FTG_Id >& PinInputs,
const TArray< FTG_Id >& PinOutputs,
int32 InputLogWidth
)

  
Public function FString

LogNodes ( FString InTab
)

  
Public function FString

LogParams ( FString InTab
)

  
Public function FString

LogTraversal ( FString InTab
)

  
Public function FString

LogVars ( FString InTab
)

  
Protected function void

OnNodeAdded ( UTG_Node* InNode
)

  
Protected function void

OnNodeChanged ( UTG_Node* InNode,
bool Tweaking
)

  
Protected function void

OnNodePinChanged ( FTG_Id InPinId,
UTG_Node* InNode
)

  
Protected function void

OnNodeRemoved ( UTG_Node* InNode,
FName InName
)

  
Protected function void

OnNodeRenamed ( UTG_Node* InNode,
FName OldName
)

  
Protected function void  
Public function void

RemoveEdge ( UTG_Node& NodeFrom,
FTG_Name& PinFrom,
UTG_Node& NodeTo,
FTG_Name& PinTo
)

 Remove a particular edge.
Public function void

RemoveNode ( UTG_Node* InNode
)

 Remove the node The node is destroyed, its Uuid becomes invalid The associated Expression is dereferenced and potentially GCed All the associated Pins are destroyed As a consequence, each pin's associated connection Edge(s) are destroyed associated Var is dereferenced and potentially GCed
Public function void

RemovePinEdges ( UTG_Node& InNode,
FTG_Name& InPin
)

 Remove all the edges connected to the specified Pin.
Protected function bool

RenameParam ( FName OldName,
FName NewName
)

 Rename existing param.
Public function void

Reset ()

 Reset the graph empty, destroy any nodes or associated resources.
Public function void

SetExtraEditorNodes ( const TArray< TObjectPtr< const UObject > >& InNodes
)

  
Public function Const void

Traverse ( NodeVisitorFunction visitor,
int32 graph_depth
)

 Traverse!
Public function bool

Validate ( MixUpdateCyclePtr Cycle
)

 Validate internal checks, warnings and errors, Returns true if Graph is valid and has no validation errors.

Overridden from UObject

  Type Name Description
Public function Virtual bool

Modify ( bool bAlwaysMarkDirty
)

 Overwrite the modify to also mark the transient states as dirty.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Override PostEditUndo method of UObject.
Public function Virtual void Override the PostLoad method of UObject to finalize the un-serialization and fill in the runtime fields of the graph sub objects
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Override PreSave method of UObject.
Public function Virtual void Override Serialize method of UObject.

Typedefs

Name Description
NodeVisitor Traversal Visitor function type Node visited Index of the node in the traverse order Subgraph level we are currently visiting
NodeVisitorFunction  

Constants

Name Description
LogHeaderWidth  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page