1. Epic GamesDeveloper
  3. FGraph

FGraph

[FGraph](API\Plugins\MetasoundGraphCore\FGraph) contains the edges between nodes as well as input and output vertices.

API > API/Plugins > API/Plugins/MetasoundGraphCore

Inheritance Hierarchy

References

   
Module MetasoundGraphCore
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundGraphCore/Public/MetasoundGraph.h
Include #include "MetasoundGraph.h"

Syntax

class FGraph : public Metasound::IGraph

Remarks

FGraph contains the edges between nodes as well as input and output vertices. FGraph does not maintain ownership over any node. Nodes used within the graph must be valid for the lifetime of the graph.

Constructors

  Type Name Description
Public function  

FGraph ( const FString& InInstanceName,
const FGuid& InInstanceID
)

  

Destructors

  Type Name Description
Public function Virtual  

~FGraph ()

  

Functions

  Type Name Description
Public function bool

AddDataEdge ( const INode& FromNode,
const FVertexName& FromVertexKey,
const INode& ToNode,
const FVertexName& ToVertexKey
)

 Add an edge to the graph, connecting two vertices from two nodes.
Public function void

AddDataEdge ( const FDataEdge& InEdge
)

 Add an edge to the graph.
Public function bool

AddInputDataDestination ( const INode& InNode,
const FVertexName& InVertexName
)

 Add an input data destination to describe how data provided outside this graph should be routed internally.
Public function void Add an input data destination to describe how data provided outside this graph should be routed internally.
Public function void

AddNode ( const FGuid& InNodeID,
TSharedPtr< const INode > InNode
)

 Store a node on this graph.
Public function void Add an output data source which describes routing of data which is owned this graph and exposed externally.
Public function bool

AddOutputDataSource ( const INode& InNode,
const FVertexName& InVertexName
)

 Add an output data source which describes routing of data which is owned this graph and exposed externally.
Public function Const const INode *

FindNode ( const FGuid& InNodeID
)

 Retrieve node by node ID.
Public function Const int32

FindUnconnectedNodes ( TArray< TPair< FGuid, const INode* >>& OutUnconnectedNodes
)

 Populates an array with all nodes which exist in the graph but do not have any connections.
Public function bool

RemoveDataEdge ( const INode& FromNode,
const FVertexName& FromVertexKey,
const INode& ToNode,
const FVertexName& ToVertexKey
)

 Remove the given data edge.
Public function void

RemoveDataEdgesWithNode ( const INode& InNode
)

 Removes all edges with connected to the node.
Public function bool

RemoveInputDataDestination ( const FVertexName& InVertexName
)

 Remove an input data destination by vertex name
Public function bool

RemoveNode ( const FGuid& InNodeID,
bool bInRemoveDataEdgesWithNode
)

 Removes node from graph.
Public function bool

RemoveOutputDataSource ( const FVertexName& InVertexName
)

 Remove an output data source by vertex name

Overridden from IGraph

  Type Name Description
Public function Virtual Const const TArray< FDataEdge > & Retrieve all the edges associated with a graph.
Public function Virtual Const const FInputDataDestinationCollection & Get vertices which contain input parameters.
Public function Virtual Const const FOutputDataSourceCollection & Get vertices which contain output parameters.

Overridden from INode

  Type Name Description
Public function Virtual Const FOperatorFactorySharedRef Return a reference to the default operator factory.

Overridden from INodeBase

  Type Name Description
Public function Virtual Const const FGuid & Return the ID of this specific instance of the node class.
Public function Virtual Const const FVertexName & Return the name of this specific instance of the node class.
Public function Virtual Const const FNodeClassMetadata & Return metadata about this graph.
Public function Virtual Const const FVertexInterface & Return the current vertex interface.
Public function Virtual Const bool Expresses whether a specific vertex interface is supported.
Public function Virtual bool

SetVertexInterface ( const FVertexInterface& InInterface
)

 Set the vertex interface. If the vertex was successfully changed, returns true.

Deprecated Functions

  Type Name Description
Public function void

RemoveDataEdgeByPredicate ( const PredicateType& Predicate
)

 Removing data edges by predicate is no longer supported

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page