FGraph

A Dataflow graph is a collection of interconnected nodes Each node has aunique Guid and name and a list of inputs and outputs ( see [FDataflowNode](API\Runtime\DataflowCore\FDataflowNode) )

API > API/Runtime > API/Runtime/DataflowCore

A Dataflow graph is a collection of interconnected nodes Each node has aunique Guid and name and a list of inputs and outputs ( see FDataflowNode )

   
Name FGraph
Type class
Header File /Engine/Source/Runtime/Dataflow/Core/Public/Dataflow/DataflowGraph.h
Include Path #include "Dataflow/DataflowGraph.h"

Syntax

class FGraph

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FGraph ( FGuid InGuid
)

   Dataflow/DataflowGraph.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FGraph()

   Dataflow/DataflowGraph.h  

Enums

Public

Name Remarks
EConnectType  

Typedefs

Name Type Remarks Include Path
FConstNodeSharedPtr TSharedPtr< const FDataflowNode >   Dataflow/DataflowGraph.h
FNodeSharedPtr TSharedPtr< FDataflowNode >   Dataflow/DataflowGraph.h

Constants

Name Type Remarks Include Path
RegisteredFilters TSet< FName > Node filter type that could be used for fast access Dataflow/DataflowGraph.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Connections TArray< FLink >   Dataflow/DataflowGraph.h  
DisabledNodes TSet< FName >   Dataflow/DataflowGraph.h  
FilteredNodes TMap< FName, TArray< FNodeSharedPtr > >   Dataflow/DataflowGraph.h  
GraphTopologyGuid FGuid This guid changes whenever the topology of the graph changes (Add/Remove nodes, Connect/Disconnect input and/or outputs) Dataflow/DataflowGraph.h  
Guid FGuid   Dataflow/DataflowGraph.h  
Nodes TArray< FNodeSharedPtr >   Dataflow/DataflowGraph.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FNodeSharedPtr AddNode ( FNodeSharedPtr NewNode
)

 Add a new Dataflow node to the graph Dataflow/DataflowGraph.h  

TSharedPtr< T > AddNode ( TUniquePtr< T >&& InNode
)

   Dataflow/DataflowGraph.h  

TSharedPtr< T > AddNode ( T* InNode
)

   Dataflow/DataflowGraph.h  

void AddReferencedObjects ( FReferenceCollector& Collector
)

   Dataflow/DataflowGraph.h  

bool CanConnect ( const FDataflowOutput& Output,
const FDataflowInput& Input
) const

   Dataflow/DataflowGraph.h  

void ClearConnections ( FDataflowConnection* ConnectionBase
)

   Dataflow/DataflowGraph.h  
  Dataflow/DataflowGraph.h  
  Dataflow/DataflowGraph.h  

void Connect ( FDataflowOutput* OutputConnection,
FDataflowInput* InputConnection
)

   Dataflow/DataflowGraph.h  

bool Connect ( FDataflowConnection* ConnectionA,
FDataflowConnection* ConnectionB
)

   Dataflow/DataflowGraph.h  

bool Connect ( FDataflowOutput& Output,
FDataflowInput& Input
)

   Dataflow/DataflowGraph.h  

void Disconnect ( FDataflowOutput* OutputConnection,
FDataflowInput* InputConnection
)

   Dataflow/DataflowGraph.h  

FNodeSharedPtr FindBaseNode ( FName InName
)

 Find a node by its name (non-const method) Dataflow/DataflowGraph.h  

FConstNodeSharedPtr FindBaseNode ( FGuid InGuid
) const

 Find a node by its unique identifier (const method) Dataflow/DataflowGraph.h  

FNodeSharedPtr FindBaseNode ( FGuid InGuid
)

 Find a node by its unique identifier (non-const method) Dataflow/DataflowGraph.h  

FConstNodeSharedPtr FindBaseNode ( FName InName
) const

 Find a node by its name (const method) Dataflow/DataflowGraph.h  

FNodeSharedPtr FindFilteredNode ( const FName& NodeFilter,
FName InName
) const

 Find a node by name from a named filter ( Dataflow/DataflowGraph.h  

const TArray< FLink > & GetConnections()

 Get all the graph connections This includes all the subgraph connections as well Dataflow/DataflowGraph.h  

EConnectType GetConnectType ( const FDataflowOutput& Output,
const FDataflowInput& Input
) const

   Dataflow/DataflowGraph.h  

const TSet< FName > & GetDisabledNodes()

   Dataflow/DataflowGraph.h  

const TArray< FNodeSharedPtr > & GetFilteredNodes ( const FName& NodeFilter
) const

 Get the list of node matching a specific named filter ( Dataflow/DataflowGraph.h  

const FGuid & GetGraphTopologyGuid()

   Dataflow/DataflowGraph.h  

TArray< FNodeSharedPtr > & GetNodes ()

 Get all the nodes of the graph ( non-const method ) this includes the node in all subgraphs Dataflow/DataflowGraph.h  

const TArray< FNodeSharedPtr > & GetNodes ()

 Get all the nodes of the graph ( const method ) this includes the node in all subgraphs Dataflow/DataflowGraph.h  

int32 NumNodes()

 Get the number of nodes in the graph including the ones in the subgraphs Dataflow/DataflowGraph.h  

void RemoveNode ( FNodeSharedPtr Node
)

 Remove a specific node from the graph Removal of the node will automatically disconnect the inputs and outputs this will also remove the node from any filters it may be in Dataflow/DataflowGraph.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar,
UObject* OwningObject
)

   Dataflow/DataflowGraph.h  

Static

Name Remarks Include Path Unreal Specifiers

static void SerializeForLoading ( FArchive& Ar,
FGraph* InGraph,
UObject* OwningObject
)

   Dataflow/DataflowGraph.h  

static void SerializeForSaving ( FArchive& Ar,
FGraph* InGraph,
TArray< TSharedPtr< FDataflowNode > >& InNodes,
TArray< FLink >& InConnections
)

   Dataflow/DataflowGraph.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page