1. Epic GamesDeveloper
  3. FMetaSoundFrontendDocumentBuilder

FMetaSoundFrontendDocumentBuilder

Builder used to support dynamically generating MetaSound documents at runtime.

API > API/Plugins > API/Plugins/MetasoundFrontend

References

   
Module MetasoundFrontend
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendDocumentBuilder.h
Include #include "MetasoundFrontendDocumentBuilder.h"

Syntax

USTRUCT ()  
struct FMetaSoundFrontendDocumentBuilder

Remarks

Builder used to support dynamically generating MetaSound documents at runtime. Builder contains caches that speed up common search and modification operations on a given document, which may result in slower performance on construction, but faster manipulation of its managed document. The builder's managed copy of a document is expected to not be modified by any external system to avoid cache becoming stale.

Constructors

  Type Name Description
Public function   Default ctor should typically never be used directly as builder interface (and optionally delegates) should be specified on construction (Default exists only to make UObject reflection happy).

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function const FMetasoundFrontendClass *  
Public function void

AddEdge ( FMetasoundFrontendEdge&& InNewEdge,
const FGuid* InPageID
)

  
Public function bool

AddEdgesByNodeClassInterfaceBindings ( const FGuid& InFromNodeID,
const FGuid& InToNodeID,
bool bReplaceExistingConnections,
const FGuid* InPageID
)

  
Public function bool

AddEdgesFromMatchingInterfaceNodeInputsToGraphInputs ( const FGuid& InNodeID,
TArray< const FMetasoundFrontendEdge* >& OutEdgesCreated,
bool bReplaceExistingConnections,
const FGuid* InPageID
)

  
Public function bool

AddEdgesFromMatchingInterfaceNodeOutputsToGraphOutputs ( const FGuid& InNodeID,
TArray< const FMetasoundFrontendEdge* >& OutEdgesCreated,
bool bReplaceExistingConnections,
const FGuid* InPageID
)

  
Public function const FMetasoundFrontendNode *

AddGraphInput ( const FMetasoundFrontendClassInput& InClassInput,
const FGuid* InPageID
)

 Adds Graph Input to document, which in turn adds a referencing input node to ALL pages.
Public function const FMetasoundFrontendNode *

AddGraphNode ( const FMetasoundFrontendGraphClass& InClass,
FGuid InNodeID,
const FGuid* InPageID
)

 Adds node to document to the page associated with the given PageID.
Public function const FMetasoundFrontendNode *

AddGraphOutput ( const FMetasoundFrontendClassOutput& InClassOutput,
const FGuid* InPageID
)

 Adds Graph Output to document, which in turn adds a referencing output node to ALL pages.
Public function const FMetasoundFrontendGraph &

AddGraphPage ( const FGuid& InPageID,
bool bDuplicateLastGraph,
bool bSetAsBuildGraph
)

 Adds a graph page to the given builder's document.
Public function bool

AddInterface ( FName InterfaceName
)

  
Public function bool

AddNamedEdges ( const TSet< Metasound::Frontend::FNamedEdge >& ConnectionsToMake,
TArray< const FMetasoundFrontendEdge* >* OutEdgesCreated,
bool bReplaceExistingConnections,
const FGuid* InPageID
)

  
Public function const FMetasoundFrontendNode *

AddNodeByClassName ( const FMetasoundFrontendClassName& InClassName,
int32 InMajorVersion,
FGuid InNodeID,
const FGuid* InPageID
)

  
Public function const FMetasoundFrontendNode *  
Public function Const bool

CanAddEdge ( const FMetasoundFrontendEdge& InEdge,
const FGuid* InPageID
)

 Returns whether or not the given edge can be added, which requires that its input is not already connected and the edge is valid (see function 'IsValidEdge').
Public function Const TObjectType &  
Public function void Clears document completely of all graph page data (nodes, edges, & member metadata), dependencies, interfaces, member metadata, preset state, etc.
Public function void  
Public function bool

ClearMemberMetadata ( const FGuid& InMemberID
)

  
Public function Const bool  
Public function Const bool

ContainsEdge ( const FMetasoundFrontendEdge& InEdge,
const FGuid* InPageID
)

  
Public function Const bool

ContainsNode ( const FGuid& InNodeID,
const FGuid* InPageID
)

  
Public function bool  
Public function bool  
Public function const FMetasoundFrontendNode *

DuplicateGraphInput ( const FMetasoundFrontendClassInput& InClassInput,
const FName InName,
const FGuid* InPageID
)

  
Public function const FMetasoundFrontendNode *

DuplicateGraphOutput ( const FMetasoundFrontendClassOutput& InClassOutput,
const FName InName,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendGraph & Accessor for the currently set build graph.
Public function Const const FMetasoundFrontendEdgeStyle *

FindConstEdgeStyle ( const FGuid& InNodeID,
FName OutputName,
const FGuid* InPageID
)

  
Public function Static bool  
Public function Const bool  
Public function Const const FMetasoundFrontendClass *  
Public function Const const FMetasoundFrontendClass *

FindDependency ( const FGuid& InClassID
)

  
Public function Const TArray< const FMetasoundFrontendEdge * >

FindEdges ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function FMetasoundFrontendEdgeStyle *

FindEdgeStyle ( const FGuid& InNodeID,
FName OutputName,
const FGuid* InPageID
)

  
Public function FMetaSoundFrontendGraphComment *

FindGraphComment ( const FGuid& InCommentID,
const FGuid* InPageID
)

  
Public function Const const FMetaSoundFrontendGraphComment *

FindGraphComment ( const FGuid& InCommentID,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendClassInput *

FindGraphInput ( FName InputName
)

  
Public function Const const FMetasoundFrontendNode *

FindGraphInputNode ( FName InputName,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendClassOutput *

FindGraphOutput ( FName OutputName
)

  
Public function Const const FMetasoundFrontendNode *

FindGraphOutputNode ( FName OutputName,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendVariable *

FindGraphVariable ( FName InVariableName,
const FGuid* InPageID
)

  
Public function Const bool

FindInterfaceInputNodes ( FName InterfaceName,
TArray< const FMetasoundFrontendNode* >& OutInputs,
const FGuid* InPageID
)

  
Public function Const bool

FindInterfaceOutputNodes ( FName InterfaceName,
TArray< const FMetasoundFrontendNode* >& OutOutputs,
const FGuid* InPageID
)

  
Public function UMetaSoundFrontendMemberMetadata *

FindMemberMetadata ( const FGuid& InMemberID
)

  
Public function Const const FMetasoundFrontendNode *

FindNode ( const FGuid& InNodeID,
const FGuid* InPageID
)

  
Public function Const const TArray< FMetasoundFrontendClassInputDefault > *

FindNodeClassInputDefaults ( const FGuid& InNodeID,
FName InVertexName,
const FGuid* InPageID
)

 Returns class defaults associated with the given node input (as defined in the associated node's dependency)
Public function Const const FMetasoundFrontendVertex *

FindNodeInput ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendVertex *

FindNodeInput ( const FGuid& InNodeID,
FName InVertexName,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendVertexLiteral *

FindNodeInputDefault ( const FGuid& InNodeID,
FName InVertexName,
const FGuid* InPageID
)

 Returns node input's vertex default if valid and assigned.
Public function Const const FMetasoundFrontendVertexLiteral *

FindNodeInputDefault ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

 Returns node input's vertex default if valid and assigned.
Public function Const TArray< const FMetasoundFrontendVertex * >

FindNodeInputs ( const FGuid& InNodeID,
FName TypeName,
const FGuid* InPageID
)

  
Public function Const TArray< const FMetasoundFrontendVertex * >

FindNodeInputsConnectedToNodeOutput ( const FGuid& InOutputNodeID,
const FGuid& InOutputVertexID,
TArray< const FMetasoundFrontendNode* >* ConnectedInputNodes,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendVertex *

FindNodeOutput ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendVertex *

FindNodeOutput ( const FGuid& InNodeID,
FName InVertexName,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendVertex *

FindNodeOutputConnectedToNodeInput ( const FGuid& InInputNodeID,
const FGuid& InInputVertexID,
const FMetasoundFrontendNode** ConnectedOutputNode,
const FGuid* InPageID
)

  
Public function Const TArray< const FMetasoundFrontendVertex * >

FindNodeOutputs ( const FGuid& InNodeID,
FName TypeName,
const FGuid* InPageID
)

  
Public function FMetasoundFrontendEdgeStyle &

FindOrAddEdgeStyle ( const FGuid& InNodeID,
FName OutputName,
const FGuid* InPageID
)

  
Public function FMetaSoundFrontendGraphComment &

FindOrAddGraphComment ( const FGuid& InCommentID,
const FGuid* InPageID
)

  
Public function void  
Public function FMetasoundFrontendClassName Generates and returns new class name for the given builder's document.
Public function Const const FGuid & The graph ID used when requests are made to mutate specific paged graph topology (ex. adding or removing nodes or edges)
Public function Const const FMetasoundFrontendDocument &  
Public function Const const IMetaSoundDocumentInterface &  
Public function Const const FString  
Public function Const const FMetasoundFrontendDocument &  
Public function Metasound::Frontend::FDocumentModifyDelegates &  
Public function Const const IMetaSoundDocumentInterface &  
Public function TArray< const FMetasoundFrontendNode * >

GetGraphInputTemplateNodes ( FName InInputName,
const FGuid* InPageID
)

  
Public function Const const bool

GetIsAdvancedDisplay ( const FName MemberName,
const EMetasoundFrontendClassType Type
)

  
Public function Const FMetasoundAssetBase &  
Public function Const EMetasoundFrontendVertexAccessType

GetNodeInputAccessType ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendLiteral *

GetNodeInputClassDefault ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function Const const FMetasoundFrontendLiteral *

GetNodeInputDefault ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function Const EMetasoundFrontendVertexAccessType

GetNodeOutputAccessType ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function const FMetasoundFrontendNodeStyle *

GetNodeStyle ( const FGuid& InNodeID,
const FGuid* InPageID
)

 Gets the editor-only style of a node with the given ID.
Public function Const FMetasoundAssetBase * Get the asset referenced by this builder's preset asset, nullptr if builder is not a preset.
Public function Const int32  
Public function void

InitDocument ( const FMetasoundFrontendDocument* InDocumentTemplate,
const FMetasoundFrontendClassName* InNewClassName,
bool bResetVersion
)

 Initializes the builder's document, using the (optional) provided document template, (optional) class name, and (optionally) whether or not to reset the existing class version.
Public function Static void

InitGraphClassMetadata ( FMetasoundFrontendClassMetadata& InOutMetadata,
bool bResetVersion,
const FMetasoundFrontendClassName* NewClassName
)

 Initializes GraphClass Metadata, optionally resetting the version back to 1.0 and/or creating a unique class name if a name is not provided.
Public function void

InitGraphClassMetadata ( bool bResetVersion,
const FMetasoundFrontendClassName* NewClassName
)

  
Public function void  
Public function void  
Public function Const bool

IsDependencyReferenced ( const FGuid& InClassID
)

  
Public function Const bool

IsInterfaceDeclared ( const FMetasoundFrontendVersion& InInterfaceVersion
)

  
Public function Const bool

IsInterfaceDeclared ( FName InInterfaceName
)

  
Public function Const bool

IsNodeInputConnected ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function Const bool

IsNodeOutputConnected ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function Const bool  
Public function Const bool

IsValid ()

 Returns whether or not builder is attached to a DocumentInterface and is valid to build or act on a document.
Public function Const Metasound::Frontend::EInvalidEdgeReason

IsValidEdge ( const FMetasoundFrontendEdge& InEdge,
const FGuid* InPageID
)

 Returns whether or not the given edge is valid (i.e. represents an input and output that equate in data and access types) or malformed.
Public function Const void Iterates nodes that are filtered by only subscribing to a class with the given type (asserts if provided invalid class type).
Public function bool  
Public function void  
Public function void  
Public function bool

RemoveDependency ( EMetasoundFrontendClassType ClassType,
const FMetasoundFrontendClassName& InClassName,
const FMetasoundFrontendVersionNumber& InClassVersionNumber
)

  
Public function bool

RemoveDependency ( const FGuid& InClassID
)

  
Public function bool

RemoveEdge ( const FMetasoundFrontendEdge& EdgeToRemove,
const FGuid* InPageID
)

  
Public function bool

RemoveEdges ( const FGuid& InNodeID,
const FGuid* InPageID
)

 Removes all edges connected to an input or output vertex associated with the node of the given ID.
Public function bool

RemoveEdgesByNodeClassInterfaceBindings ( const FGuid& InOutputNodeID,
const FGuid& InInputNodeID,
const FGuid* InPageID
)

  
Public function bool

RemoveEdgesFromNodeOutput ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function bool

RemoveEdgeStyle ( const FGuid& InNodeID,
FName OutputName,
const FGuid* InPageID
)

  
Public function bool

RemoveEdgeToNodeInput ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function bool

RemoveGraphComment ( const FGuid& InCommentID,
const FGuid* InPageID
)

  
Public function bool

RemoveGraphInput ( FName InInputName
)

  
Public function bool

RemoveGraphInputDefault ( FName InputName,
const FGuid& InPageID,
bool bClearInheritsDefault
)

  
Public function bool

RemoveGraphOutput ( FName InOutputName
)

  
Public function bool

RemoveGraphPage ( const FGuid& InPageID
)

  
Public function bool

RemoveInterface ( FName InName
)

  
Public function bool

RemoveNamedEdges ( const TSet< Metasound::Frontend::FNamedEdge >& InNamedEdgesToRemove,
TArray< FMetasoundFrontendEdge >* OutRemovedEdges,
const FGuid* InPageID
)

  
Public function bool

RemoveNode ( const FGuid& InNodeID,
const FGuid* InPageID
)

  
Public function bool

RemoveNodeInputDefault ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FGuid* InPageID
)

  
Public function int32

RemoveNodeLocation ( const FGuid& InNodeID,
const FGuid* InLocationGuid,
const FGuid* InPageID
)

  
Public function bool  
Public function bool  
Public function bool  
Public function void

ResetGraphPages ( bool bClearDefaultGraph
)

 Removes all graph pages except the default. If bClearDefaultPage is true, clears the default graph page implementation.
Public function void

SetAuthor ( const FString& InAuthor
)

  
Public function bool

SetBuildPageID ( const FGuid& InBuildPageID,
bool bBroadcastDelegate
)

 Sets the builder's targeted paged graph ID to the given ID if it exists.
Public function void

SetDisplayName ( const FText& InDisplayName
)

  
Public function bool Sets the given graph output's access type.
Public function bool

SetGraphOutputAdvancedDisplay ( const FName OutputName,
const bool InAdvancedDisplay
)

 Sets the given input`s IsAdvancedDisplay state.
Public function bool

SetGraphOutputDataType ( FName OutputName,
FName DataType
)

 Sets the given graph output's data type.
Public function bool

SetGraphOutputName ( FName InputName,
FName InName
)

 Sets a given graph output's name to a new name. Succeeds if the graph output exists and the new name is set (or is the same as the old name).
Public function bool

SetGraphVariableDefault ( FName VariableName,
FMetasoundFrontendLiteral InDefaultLiteral,
const FGuid* InPageID
)

 Sets the given graph variable's default.
Public function void  
Public function bool

SetNodeComment ( const FGuid& InNodeID,
FString&& InNewComment,
const FGuid* InPageID
)

 Sets the editor-only comment to the provided value.
Public function bool

SetNodeCommentVisible ( const FGuid& InNodeID,
bool bIsVisible,
const FGuid* InPageID
)

 Sets the editor-only comment visibility.
Public function bool

SetNodeInputDefault ( const FGuid& InNodeID,
const FGuid& InVertexID,
const FMetasoundFrontendLiteral& InLiteral,
const FGuid* InPageID
)

  
Public function bool

SetNodeLocation ( const FGuid& InNodeID,
const FVector2D& InLocation,
const FGuid* InLocationGuid,
const FGuid* InPageID
)

 Sets the editor-only node location of a node with the given ID to the provided location.
Public function bool

SetNodeUnconnectedPinsHidden ( const FGuid& InNodeID,
const bool bUnconnectedPinsHidden,
const FGuid* InPageID
)

 Sets the editor-only Unconnected Pins Hidden for a node with the given ID.
Public function void

SetVersionNumber ( const FMetasoundFrontendVersionNumber& InDocumentVersionNumber
)

 Sets the document's version number. Should only be called by document versioning.
Public function bool

SwapGraphInput ( const FMetasoundFrontendClassVertex& InExistingInputVertex,
const FMetasoundFrontendClassVertex& NewInputVertex
)

  
Public function bool

SwapGraphOutput ( const FMetasoundFrontendClassVertex& InExistingOutputVertex,
const FMetasoundFrontendClassVertex& NewOutputVertex
)

  
Public function bool Transforms template nodes within the given builder's document, which can include swapping associated edges and/or replacing nodes with other, registry-defined concrete node class instances.
Public function bool  
Public function bool  
Public function bool Versions legacy document members that contained interface information

Classes

  Type Name Description
Public struct IPropertyVersionTransform Struct enabling property migration of data that must be applied prior to versioning logic.  

Typedefs

Name Description
FFinalizeNodeFunctionRef  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page