Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UMetaSoundBuilderBase

UMetaSoundBuilderBase

Base implementation of MetaSound builder

API > API/Plugins > API/Plugins/MetasoundEngine

Inheritance Hierarchy

References

   
Module MetasoundEngine
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundBuilderBase.h
Include #include "MetasoundBuilderBase.h"

Syntax

UCLASS (Abstract, BlueprintType, Transient, Meta=(DisplayName="MetaSound Builder Base"))  
class UMetaSoundBuilderBase : public UObject

Remarks

Base implementation of MetaSound builder

Variables

  Type Name Description
Public variable path keys kept aligned  
Protected variable UProperty Meta bool bIsAttached  
Public variable FNameFMetasoundFrontendLiteralEMetaSoundBuilderResult bool bIsConstructorInput  
Public variable FNameFMetasoundFrontendLiteralEMetaSoundBuilderResult bool bIsConstructorOutput  
Protected variable UProperty FMetaSoundFrontendDocumentBuilder Builder  
Protected variable UProperty Meta FMetasoundFrontendClassName ClassName  
Public variable const FMetaSoundBuilderOptions &Options const  
Public variable const FMetaSoundBuilderNodeInputHandle &InputHandle const  
Public variable FName DataType  
Public variable EMetaSoundBuilderResultFName DataType  
Public variable FNameFMetasoundFrontendLiteral DefaultValue  
Public variable FName InputName  
Public variable EMetaSoundBuilderResultint32 MajorVersion  
Public variable int32 MajorVersion  
Public variable FName OutputName  
Public variable EMetaSoundBuilderResult & OutResult  
Public variable int32EMetaSoundBuilderResult & OutResult  
Public variable FNameEMetaSoundBuilderResult & OutResult  
Public variable FNameFMetasoundFrontendLiteralEMetaSoundBuilderResult & OutResult  

Functions

  Type Name Description
Public function void

AddGraphPage ( FName PageName,
bool bDuplicateLastGraph,
bool bSetAsBuildGraph,
EMetaSoundBuilderResult& OutResult
)

 Adds a graph page to the given builder's document.
Public function UFunction BlueprintCallable, Category, Meta void

AddInterface ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

 Adds an interface registered with the given name to the graph, adding associated input and output nodes.
Public function void Adds transaction listener which allows objects to respond to when certain graph operations are applied from anywhere (adding or removing nodes, edges, pages, etc.) Currently there is no guarantee all transactions will be represented until the Controller API is fully deprecated! (ex. if a node or edge is added or removed via a controller API call, the transaction will be missed).
Public function Const TScriptInterface< IMetaSoundDocumentInterface >  
Public function UFunction BlueprintCallable, Category, Meta void

BuildAndOverwriteMetaSound ( UPARAM(DisplayName="Existing MetaSound") TScriptInterface< IMetaSoundDocumentInterface > ExistingMet...,
bool bForceUniqueClassName
)

 Copies a transient MetaSound with the provided builder options, copying the underlying MetaSound managed by this builder and registering it with the MetaSound Node Registry as a unique name.
Protected function Virtual Const void

BuildAndOverwriteMetaSoundInternal ( TScriptInterface< IMetaSoundDocumentInterface > ExistingMetaSound,
bool bForceUniqueClassName
)

  
Protected function Const UClassType &

BuildInternal ( UObject* Parent,
constFMetaSoundBuilderOptions& BuilderOptions
)

 Runs build, conforming the document and corresponding object data on a MetaSound UObject to that managed by this builder.
Public function bool  
Public function Virtual bool  
Public function UFunction BlueprintCallable, Category, Meta void Connects a given node input to the graph input with the given name.
Public function UFunction BlueprintCallable, Category, Meta void Connects a given node output to the graph output with the given name.
Public function UFunction BlueprintCallable, Category, Meta void Connects node output to a node input.
Public function UFunction BlueprintCallable, Category, Meta void Connects two nodes using defined MetaSound Interface Bindings registered with the MetaSound Interface registry.
Public function UFunction BlueprintCallable, Category, Meta void Converts this preset to a fully accessible MetaSound; sets result to succeeded if it was converted successfully and failed if it was not.
Public function UFunction BlueprintCallable, Category, Meta void Convert this builder to a MetaSound source preset with the given referenced source builder.
Protected function Virtual void  
Protected function Const UMetaSoundBuilderDocument *  
Public function UFunction BlueprintCallable, Category, Meta void Removes connection to a given node input. Returns success if connection was removed, failed if not.
Public function UFunction BlueprintCallable, Category, Meta void Removes all connections from a given node output. Returns success if all connections were removed, failed if not.
Public function UFunction BlueprintCallable, Category, Meta void Disconnects node output to a node input. Returns success if connection was removed, failed if not.
Public function UFunction BlueprintCallable, Category, Meta void Disconnects two nodes using defined MetaSound Interface Bindings registered with the MetaSound Interface registry.
Public function Const constFMetaSoundFrontendGraphComment *

FindGraphComment ( constFGuid& InCommentID
)

  
Public function FMetaSoundFrontendGraphComment *

FindGraphComment ( constFGuid& InCommentID
)

  
Public function UMetaSoundFrontendMemberMetadata *

FindMemberMetadata ( constFGuid& InMemberID
)

  
Public function FMetaSoundFrontendGraphComment &  
Public function Virtual Const constUClass & Returns the base class registered with the MetaSound UObject registry.
Public function FMetaSoundFrontendDocumentBuilder &  
Public function Metasound::Frontend::FDocumentModifyDelegates &  
Public function Virtual Const constUClass &  
Public function Const constFMetaSoundFrontendDocumentBuilder &  
Public function Const int32  
Public function UFunction BlueprintCallable, Category, Meta void Returns node input's data if valid (including things like name and datatype).
Public function UFunction BlueprintCallable, Category, Meta void Returns node output's data if valid (including things like name and datatype).
Protected function Virtual void  
Public function Virtual void  
Public function void Resets FrontendBuilder instance, creating a transient MetaSound document that is managed by this UObject Builder.
Public function Virtual void Initializes and ensures all nodes have a position (required prior to exporting to an asset if expected to be viewed in the editor).
Public function void

InjectInputTemplateNodes ( bool bForceNodeCreation,
EMetaSoundBuilderResult& OutResult
)

 Injects template nodes between builder's document inputs not connected to existing template inputs, copying locational data from the represented input metadata.
Protected function void

InvalidateCache ( bool bPrimeCache
)

  
Protected function Virtual void  
Protected function Virtual void  
Protected function Static void Only registers provided MetaSound's graph class and referenced graphs recursively if it has yet to be registered or if it has an attached builder reporting outstanding transactions that have yet to be registered.
Public function path keys kept and priming managed internally void

ReloadCache ( bool bPrimeCache
)

  
Public function bool

RemoveGraphComment ( constFGuid& InCommentID
)

  
Public function UFunction BlueprintCallable, Category, Meta void Removes graph input if it exists; sets result to succeeded if it was removed and failed if it was not.
Public function UFunction BlueprintCallable, Category, Meta void Removes graph output if it exists; sets result to succeeded if it was removed and failed if it was not.
Public function void Removes a graph page with the given name, setting result to failed if the name was not found or was invalid.
Public function UFunction BlueprintCallable, Category, Meta void

RemoveInterface ( FName InterfaceName,
EMetaSoundBuilderResult& OutResult
)

 Removes the interface with the given name from the builder's MetaSound.
Public function UFunction BlueprintCallable, Category, Meta void

RemoveNode ( constFMetaSoundNodeHandle& NodeHandle,
EMetaSoundBuilderResult& OutResult,
bool bRemoveUnusedDependencies
)

 Removes node and any associated connections from the builder's MetaSound.
Public function UFunction BlueprintCallable, Category, Meta void Removes node input literal default if set, reverting the value to be whatever the node class defaults the value to.
Public function void

RemoveTransactionListener ( FDelegateHandle BuilderListenerDelegateHandle
)

 Explicitly remove transaction listener from builder (see corresponding 'AddTransactionListener' function).
Public function UFunction BlueprintCallable, Category void Removes dependencies in document that are no longer referenced by nodes.
Public function void  
Public function void

ResetGraphPages ( bool bClearDefaultPage
)

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

SetAuthor ( constFString& InAuthor
)

 Sets the author of the MetaSound.
Public function UFunction BlueprintCallable, Category, Meta void Disconnects the given graph input's respective template nodes and sets the graph input's AccessType should it not match the current AccessType.
Public function UFunction BlueprintCallable, Category, Meta void

SetGraphInputDataType ( FName InputName,
FName DataType,
EMetaSoundBuilderResult& OutResult
)

 Disconnects the given graph input's respective template nodes and sets the graph input's DataType should it not match the current DataType.
Public function UFunction BlueprintCallable, Category, Meta void Sets the input node's default value, overriding the default provided by the referenced graph if the graph is a preset.
Public function UFunction BlueprintCallable, Category, Meta void

SetGraphInputName ( FName InputName,
FName NewName,
EMetaSoundBuilderResult& OutResult
)

 Sets the given graph input's name to the new name.
Public function UFunction BlueprintCallable, Category, Meta void Disconnects the given graph output's respective template nodes and sets the graph output's AccessType should it not match the current AccessType.
Public function UFunction BlueprintCallable, Category, Meta void

SetGraphOutputDataType ( FName OutputName,
FName DataType,
EMetaSoundBuilderResult& OutResult
)

 Disconnects the given graph output's respective template nodes and sets the graph output's DataType should it not match the current DataType.
Public function UFunction BlueprintCallable, Category, Meta void

SetGraphOutputName ( FName OutputName,
FName NewName,
EMetaSoundBuilderResult& OutResult
)

 Sets the given graph output's name to the new name.
Public function void  
Public function void

SetNodeComment ( constFMetaSoundNodeHandle& InNodeHandle,
constFString& InNewComment,
EMetaSoundBuilderResult& OutResult
)

  
Public function void

SetNodeCommentVisible ( constFMetaSoundNodeHandle& InNodeHandle,
bool bIsVisible,
EMetaSoundBuilderResult& OutResult
)

  
Public function UFunction BlueprintCallable, Category, Meta void Sets the node's input default value (used if no connection to the given node input is present)
Public function void  
Public function void

SetNodeLocation ( constFMetaSoundNodeHandle& InNodeHandle,
constFVector2D& InLocation,
constFGuid& InLocationGuid,
EMetaSoundBuilderResult& OutResult
)

  
Public function UFunction BlueprintCallable, Category, Meta    
Public function Const UFunction BlueprintCallable, Category, Meta   Returns node input's literal value if set on graph, otherwise fails and returns default literal.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns input's parent node if the input is valid, otherwise returns invalid node handle.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns output's parent node if the input is valid, otherwise returns invalid node handle.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns output's parent node if the input is valid, otherwise returns invalid node handle.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns the MetaSound asset's graph class name (used by the MetaSound Node Class Registry)
Public function Const UFunction BlueprintCallable, Category, Meta   Returns node input's class literal value if set, otherwise fails and returns default literal.
Public function Const UFunction BlueprintCallable, Category   Returns if a given node input has connections.
Public function Const UFunction BlueprintCallable, Category   Returns whether the given node output is a constructor pin.
Public function Const UFunction BlueprintCallable, Category   Return the asset referenced by this preset builder. Returns nullptr if the builder is not a preset.
Public function Const UFunction BlueprintCallable, Category   Returns if a given interface is declared.
Public function Const UFunction BlueprintCallable, Category   Returns if a given node output and node input are connected.
Public function UFunction BlueprintCallable, Category, Meta    
Public function Const UFunction BlueprintCallable, Category   Returns if a given node output is connected.
Public function Const UFunction BlueprintCallable, Category   Returns whether this is a preset.
Public function Const UFunction BlueprintCallable, Category   Returns whether the given node input is a constructor pin.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns node outputs by the given DataType (ex. "Audio", "Trigger", "String", "Bool", "Float", "Int32", etc.).
Public function UFunction BlueprintCallable, Category, Meta   Returns graph input node by the given name if it exists, or an invalid handle if not found.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns node output by the given name.
Public function Virtual UFunction BlueprintCallable, Category, Meta    
Public function UFunction BlueprintCallable, Category, Meta   Adds a graph input node with the given name, DataType, and sets the graph input to default value.
Public function UFunction BlueprintCallable, Category, Meta   Adds a graph output node with the given name, DataType, and sets output node's input to default value.
Public function Const UFunction BlueprintCallable, Category, Meta displayname   Adds a node to the graph using the provided MetaSound asset as its defining NodeClass.
Public function Const UFunction BlueprintCallable, Category, Meta displayname   Adds node referencing the highest native class version of the given class name to the document.
Public function Const    
Public function Const UFunction BlueprintCallable, Category, Meta   Returns all node outputs.
Public function Const UFunction BlueprintCallable, Category, Meta   Connects a given node's outputs to all graph outputs for shared interfaces implemented on both the node's referenced class and the builder's MetaSound graph. Returns inputs of connected output nodes.
Public function Const UFunction BlueprintCallable, Category   Returns whether node exists.
Public function Const UFunction BlueprintCallable, Category   Returns whether node input exists.
Public function Const UFunction BlueprintCallable, Category   Returns whether node output exists.
Public function UFunction BlueprintCallable, Category, Meta   Returns graph output node by the given name if it exists, or an invalid handle if not found.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns node input by the given name if it exists, or an invalid handle if not found.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns all node inputs.
Public function Const UFunction BlueprintCallable, Category, Meta   Returns node inputs by the given DataType (ex. "Audio", "Trigger", "String", "Bool", "Float", "Int32", etc.).
Public function Const UFunction BlueprintCallable, Category, Meta   Connects a given node's inputs to all graph inputs for shared interfaces implemented on both the node's referenced class and the builder's MetaSound graph. Returns outputs of connected input nodes.
Public function Virtual Const UFunction BlueprintCallable, Category, Meta   Builds a transient MetaSound with the provided builder options, copying the underlying MetaSound managed by this builder and registering it with the MetaSound Node Registry as a unique class.
Public function void  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page