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

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.

   
Name FGraph
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundGraphCore/Public/MetasoundGraph.h
Include Path #include "MetasoundGraph.h"

Syntax

class FGraph : public Metasound::IGraph

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FGraph ( const FString& InInstanceName,
const FGuid& InInstanceID,
TSharedPtr< const IOperatorData > InNodeConfig
)

   MetasoundGraph.h  

FGraph ( const FName& InInstanceName,
const FGuid& InInstanceID,
TSharedPtr< const IOperatorData > InNodeConfig
)

 Constructor to be used for dynamically generated MetaSounds not associated with a given asset (ex. test graphs, graphs not represented by an asset-contained frontend document, etc.) MetasoundGraph.h  

FGraph ( const FTopLevelAssetPath& InAssetPath,
const FGuid& InInstanceID,
TSharedPtr< const IOperatorData > InNodeConfig
)

 Constructor to be used for MetaSounds associated with a given asset. MetasoundGraph.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FGraph()

   MetasoundGraph.h  

Classes

Name Remarks
FFactory  

Structs

Name Remarks
FDeprecationNodeStorageAdapter This struct is used to handle back-compatibility with the deprecated API.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AssetPath FTopLevelAssetPath   MetasoundGraph.h  
Edges TArray< FDataEdge >   MetasoundGraph.h  
InputDestinations FInputDataDestinationCollection   MetasoundGraph.h  
InstanceID FGuid   MetasoundGraph.h  
InstanceName FVertexName   MetasoundGraph.h  
Metadata FNodeClassMetadata   MetasoundGraph.h  
Nodes TSortedMap< FGuid, FDeprecationNodeStorageAdapter >   MetasoundGraph.h  
OperatorData TSharedPtr< const IOperatorData >   MetasoundGraph.h  
OutputSources FOutputDataSourceCollection   MetasoundGraph.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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. MetasoundGraph.h  

void AddDataEdge ( const FDataEdge& InEdge
)

 Add an edge to the graph. MetasoundGraph.h  

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. MetasoundGraph.h  

void AddInputDataDestination ( const FInputDataDestination& InDestination
)

 Add an input data destination to describe how data provided outside this graph should be routed internally. MetasoundGraph.h  

void AddInputNode ( FGuid InNodeID,
const FVertexName& InVertexName,
TUniquePtr< INode > InNode
)

 Add an input node to this graph. MetasoundGraph.h  

void AddInputNode ( FGuid InNodeID,
const FVertexName& InVertexName,
TSharedPtr< const INode > InNode
)

 Add an input node to this graph. MetasoundGraph.h  

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

 Store a node on this graph. MetasoundGraph.h  

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

   MetasoundGraph.h  

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. MetasoundGraph.h  

void AddOutputDataSource ( const FOutputDataSource& InSource
)

 Add an output data source which describes routing of data which is owned this graph and exposed externally. MetasoundGraph.h  

void AddOutputNode ( FGuid InNodeID,
const FVertexName& InVertexName,
TUniquePtr< INode > InNode
)

 Add an output node to this graph. MetasoundGraph.h  

void AddOutputNode ( FGuid InNodeID,
const FVertexName& InVertexName,
TSharedPtr< const INode > InNode
)

 Add an output node to this graph. MetasoundGraph.h  

const INode * FindNode ( const FGuid& InNodeID
) const

 Retrieve node by node ID. MetasoundGraph.h  

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

 Populates an array with all nodes which exist in the graph but do not have any connections. MetasoundGraph.h  

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

 Remove the given data edge. MetasoundGraph.h  

void RemoveDataEdgeByPredicate ( const PredicateType& Predicate
)

 Removes all edges for which that predicate returns true. MetasoundGraph.h  

void RemoveDataEdgesWithNode ( const INode& InNode
)

 Removes all edges with connected to the node. MetasoundGraph.h  

bool RemoveInputDataDestination ( const FVertexName& InVertexName
)

 Remove an input data destination by vertex name MetasoundGraph.h  

bool RemoveNode ( const FGuid& InNodeID,
bool bInRemoveDataEdgesWithNode
)

 Removes node from graph. MetasoundGraph.h  

bool RemoveOutputDataSource ( const FVertexName& InVertexName
)

 Remove an output data source by vertex name MetasoundGraph.h  

void SetNodeDefaultInput ( const FGuid& InNodeID,
const FVertexName& InVertexName,
const FLiteral& InLiteral
)

 Set the input default literal for a node that exists in the graph. MetasoundGraph.h  

Overridden from IGraph

Name Remarks Include Path Unreal Specifiers

virtual const FTopLevelAssetPath & GetAssetPath()

 Returns path to graph's authoring content (invalid if generated dynamically). MetasoundGraph.h  

virtual const TArray< FDataEdge > & GetDataEdges()

 Retrieve all the edges associated with a graph. MetasoundGraph.h  

virtual const FInputDataDestinationCollection & GetInputDataDestinations()

 Get vertices which contain input parameters. MetasoundGraph.h  

virtual const FOutputDataSourceCollection & GetOutputDataSources()

 Get vertices which contain output parameters. MetasoundGraph.h  

Overridden from INode

Name Remarks Include Path Unreal Specifiers

virtual FOperatorFactorySharedRef GetDefaultOperatorFactory()

 Return a reference to the default operator factory. MetasoundGraph.h  

Overridden from INodeBase

Name Remarks Include Path Unreal Specifiers

virtual const FGuid & GetInstanceID()

 Return the ID of this specific instance of the node class. MetasoundGraph.h  

virtual const FVertexName & GetInstanceName()

 Return the name of this specific instance of the node class. MetasoundGraph.h  

virtual const FNodeClassMetadata & GetMetadata()

 Return metadata about this graph. MetasoundGraph.h  

virtual TSharedPtr< const IOperatorData > GetOperatorData()

 Return the configuration for this graph. MetasoundGraph.h  

virtual const FVertexInterface & GetVertexInterface()

 Return the current vertex interface. MetasoundGraph.h  

virtual bool IsVertexInterfaceSupported ( const FVertexInterface& InInterface
) const

 Expresses whether a specific vertex interface is supported. MetasoundGraph.h  

virtual void SetDefaultInput ( const FVertexName& InVertexName,
const FLiteral& InLiteral
)

 Set the default value associated with an input vertex. MetasoundGraph.h  

virtual bool SetVertexInterface ( const FVertexInterface& InInterface
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page