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&40;&41;  
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   Exists only to make UObject reflection happy.
Public function    
Public function    

Functions

  Type Name Description
Public function const FMetasoundFrontendClass *  
Public function void  
Public function bool

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

  
Public function bool

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

  
Public function bool

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

  
Public function const FMetasoundFrontendNode *  
Public function const FMetasoundFrontendNode *

AddGraphNode ( const FMetasoundFrontendGraphClass& InClass,
FGuid InNodeID
)

  
Public function const FMetasoundFrontendNode *  
Public function bool

AddInterface ( FName InterfaceName
)

  
Public function bool

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

  
Public function const FMetasoundFrontendNode *

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

  
Public function Const bool 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 void  
Public function Const bool  
Public function Const bool

ContainsNode ( const FGuid& InNodeID
)

  
Public function bool  
Public function bool

ConvertToPreset ( const FMetasoundFrontendDocument& InReferencedDocument
)

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

FindDependency ( const FGuid& InClassID
)

  
Public function Const const FMetasoundFrontendClass *  
Public function Const const FMetasoundFrontendClassInput *

FindGraphInput ( FName InputName
)

  
Public function Const const FMetasoundFrontendNode *

FindGraphInputNode ( FName InputName
)

  
Public function Const const FMetasoundFrontendClassOutput *

FindGraphOutput ( FName OutputName
)

  
Public function Const const FMetasoundFrontendNode *

FindGraphOutputNode ( FName OutputName
)

  
Public function Const bool

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

  
Public function Const bool

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

  
Public function Const const FMetasoundFrontendNode *

FindNode ( const FGuid& InNodeID
)

  
Public function Const const FMetasoundFrontendVertex *

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

  
Public function Const const FMetasoundFrontendVertex *

FindNodeInput ( const FGuid& InNodeID,
FName InVertexName
)

  
Public function Const TArray< const FMetasoundFrontendVertex * >

FindNodeInputs ( const FGuid& InNodeID,
FName TypeName
)

  
Public function Const TArray< const FMetasoundFrontendVertex * >

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

  
Public function Const const FMetasoundFrontendVertex *

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

  
Public function Const const FMetasoundFrontendVertex *

FindNodeOutput ( const FGuid& InNodeID,
FName InVertexName
)

  
Public function Const const FMetasoundFrontendVertex *

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

  
Public function Const TArray< const FMetasoundFrontendVertex * >

FindNodeOutputs ( const FGuid& InNodeID,
FName TypeName
)

  
Public function Const const FMetasoundFrontendDocument &  
Public function Const const Metasound::Frontend::FDocumentModifyDelegates &  
Public function Const const IMetaSoundDocumentInterface &  
Public function Const const FMetasoundFrontendLiteral *

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

  
Public function Const const FMetasoundFrontendLiteral *

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

  
Public function void  
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  
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
)

  
Public function Const bool

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

  
Public function Const bool  
Public function Const Metasound::Frontend::EInvalidEdgeReason 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 bool  
Public function void Primarily used by editor transaction stack to avoid corruption when object is changed outside of the builder API.
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
)

  
Public function bool

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

  
Public function bool

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

  
Public function bool

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

  
Public function bool

RemoveGraphInput ( FName InInputName
)

  
Public function bool

RemoveGraphOutput ( FName InOutputName
)

  
Public function bool

RemoveInterface ( FName InName
)

  
Public function bool

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

  
Public function bool

RemoveNode ( const FGuid& InNodeID
)

  
Public function bool

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

  
Public function bool  
Public function bool  
Public function void

SetAuthor ( const FString& InAuthor
)

  
Public function bool

SetGraphInputDefault ( FName InputName,
const FMetasoundFrontendLiteral& InDefaultLiteral
)

  
Public function bool

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

  
Public function bool

SetNodeLocation ( const FGuid& InNodeID,
const FVector2D& InLocation
)

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

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

  
Public function bool

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

  
Public function bool  

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