1. Epic GamesDeveloper
  3. IGraphController

IGraphController

An [IGraphController](API\Plugins\MetasoundFrontend\IGraphController) provides methods for querying and manipulating a [Metasound](API\Plugins\MetasoundGraphCore\TDataReferenceTypeInfo_FAudioBuf-) graph.

API > API/Plugins > API/Plugins/MetasoundFrontend

An IGraphController provides methods for querying and manipulating a Metasound graph.

   
Name IGraphController
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendController.h
Include Path #include "MetasoundFrontendController.h"

Syntax

class IGraphController :  
    public TSharedFromThis< IGraphController > ,  
    public Metasound::Frontend::IDocumentAccessor

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

IGraphController()

   MetasoundFrontendController.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IGraphController()

   MetasoundFrontendController.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FNodeHandle AddDuplicateNode ( const INodeController& InNodeController
)

 Add a new node to this graph by duplicating the supplied node. MetasoundFrontendController.h  

FNodeHandle AddInputVertex ( const FMetasoundFrontendClassInput& InDescription
)

 Add a new input node using the input description. MetasoundFrontendController.h  

FNodeHandle AddNode ( const FMetasoundFrontendClassMetadata& InClassMetadata,
FGuid InNodeGuid
)

 Add a new node to this graph. MetasoundFrontendController.h  

FNodeHandle AddNode ( const FNodeRegistryKey& InKey,
FGuid InNodeGuid
)

 Add a new node to this graph from the node registry. MetasoundFrontendController.h  

FNodeHandle AddOutputVertex ( const FVertexName& InName,
const FName InTypeName
)

   MetasoundFrontendController.h  

FNodeHandle AddOutputVertex ( const FMetasoundFrontendClassOutput& InDescription
)

 Add a new output node using the output description. MetasoundFrontendController.h  

FNodeHandle AddTemplateNode ( const INodeTemplate& InNodeTemplate,
FNodeTemplateGenerateInterfaceParams Params,
FGuid InNodeGuid
)

 Add a new template node to this graph, providing the defined interface as expected by the caller. MetasoundFrontendController.h  

virtual FNodeHandle AddTemplateNode ( const FNodeRegistryKey& InKey,
FMetasoundFrontendNodeInterface&& InNodeInterface,
FGuid InNodeGuid
)

   MetasoundFrontendController.h  

FVariableHandle AddVariable ( const FName& InDataTypeName
)

 Adds a new variable to the graph MetasoundFrontendController.h  

FNodeHandle AddVariableAccessorNode ( const FGuid& InVariableID
)

 Creates and returns a variable accessor node. MetasoundFrontendController.h  

FNodeHandle AddVariableDeferredAccessorNode ( const FGuid& InVariableID
)

 Creates and returns a variable deferred accessor node. MetasoundFrontendController.h  

void ClearGraph()

 Clears the graph, its associated interface, and synchronizes removed dependencies with the owning graph. MetasoundFrontendController.h  

bool ClearLiteralForInput ( const FVertexName& InInputName,
FGuid InVertexID
)

 Clear the current literal for a given input. MetasoundFrontendController.h  

bool ContainsInputVertex ( const FVertexName& InName,
const FName& InTypeName
) const

 Returns true if an input vertex with the given Name exists. MetasoundFrontendController.h  

bool ContainsInputVertexWithName ( const FVertexName& InName
) const

 Returns true if an input vertex with the given Name exists. MetasoundFrontendController.h  

bool ContainsOutputVertex ( const FVertexName& InName,
const FName& InTypeName
) const

 Returns true if an output vertex with the given Name exists. MetasoundFrontendController.h  

bool ContainsOutputVertexWithName ( const FVertexName& InName
) const

 Returns true if an output vertex with the given Name exists. MetasoundFrontendController.h  
Creates and inserts a new subgraph into this graph using the given metadata. MetasoundFrontendController.h  

FConstClassInputAccessPtr FindClassInputWithName ( const FVertexName& InName
) const

   MetasoundFrontendController.h  

FConstClassOutputAccessPtr FindClassOutputWithName ( const FVertexName& InName
) const

   MetasoundFrontendController.h  

const FMetasoundFrontendClassInput * FindInputDescriptionWithName ( const FVertexName& InName
) const

   MetasoundFrontendController.h  

const FMetasoundFrontendClassInput * FindInputDescriptionWithVertexID ( const FGuid& InVertexID
) const

   MetasoundFrontendController.h  

FNodeHandle FindOrAddVariableMutatorNode ( const FGuid& InVariableID
)

 Returns the variable mutator node. If none exist, one is created. MetasoundFrontendController.h  

const FMetasoundFrontendClassOutput * FindOutputDescriptionWithName ( const FVertexName& InName
) const

   MetasoundFrontendController.h  

const FMetasoundFrontendClassOutput * FindOutputDescriptionWithVertexID ( const FGuid& InVertexID
) const

   MetasoundFrontendController.h  

FVariableHandle FindVariable ( const FGuid& InVariableID
)

 Finds a variable by ID. MetasoundFrontendController.h  

FConstVariableHandle FindVariable ( const FGuid& InVariableID
) const

 Finds a variable by ID. MetasoundFrontendController.h  

FVariableHandle FindVariableContainingNode ( const FGuid& InNodeID
)

 Finds a variable inspecting the nodes associated with the variable. MetasoundFrontendController.h  

FConstVariableHandle FindVariableContainingNode ( const FGuid& InNodeID
) const

 Finds a variable inspecting the nodes associated with the variable. MetasoundFrontendController.h  

FGuid GetClassID()

 Returns the ClassID associated with this graph. MetasoundFrontendController.h  

TArray< FConstNodeHandle > GetConstInputNodes()

 Returns all input nodes in the graph. MetasoundFrontendController.h  

TArray< FConstNodeHandle > GetConstNodes()

 Returns all nodes in the graph. MetasoundFrontendController.h  

TArray< FConstNodeHandle > GetConstOutputNodes()

 Returns all output nodes in the graph. MetasoundFrontendController.h  

FMetasoundFrontendLiteral GetDefaultInput ( const FGuid& InVertexID,
TArrayView< const FGuid > InPageOrder
) const

   MetasoundFrontendController.h  

FMetasoundFrontendLiteral GetDefaultInput ( const FGuid& InVertexID
) const

   MetasoundFrontendController.h  

FText GetDisplayName()

 Return the display name of the graph. MetasoundFrontendController.h  

const FMetasoundFrontendClassMetadata & GetGraphMetadata()

 Return the metadata for the current graph. MetasoundFrontendController.h  

const FMetasoundFrontendGraphClassPresetOptions & GetGraphPresetOptions()

 Return the preset options for the current graph. MetasoundFrontendController.h  

const FMetasoundFrontendGraphStyle & GetGraphStyle()

 Returns graph style. MetasoundFrontendController.h  

const FText & GetInputDescription ( const FVertexName& InName
) const

 Get the description for the input with the given name. MetasoundFrontendController.h  

TArray< FNodeHandle > GetInputNodes()

 Returns all input nodes in the graph. MetasoundFrontendController.h  

FNodeHandle GetInputNodeWithName ( const FVertexName& InName
)

 Returns a handle to an existing input node for the given graph input name. MetasoundFrontendController.h  

FConstNodeHandle GetInputNodeWithName ( const FVertexName& InName
) const

 Returns a handle to an existing input node for the given graph input name. MetasoundFrontendController.h  

const TSet< FName > & GetInputsInheritingDefault()

 Returns a set of all input names that are managed MetasoundFrontendController.h  

const FMetasoundFrontendInterfaceStyle & GetInputStyle()

   MetasoundFrontendController.h  

TArray< FVertexName > GetInputVertexNames()

   MetasoundFrontendController.h  

TArray< FNodeHandle > GetNodes()

 Returns all nodes in the graph. MetasoundFrontendController.h  

FNodeHandle GetNodeWithID ( FGuid InNodeID
)

 Returns a node by NodeID. If the node does not exist, an invalid handle is returned. MetasoundFrontendController.h  

FConstNodeHandle GetNodeWithID ( FGuid InNodeID
) const

 Returns a node by NodeID. If the node does not exist, an invalid handle is returned. MetasoundFrontendController.h  

const FText & GetOutputDescription ( const FVertexName& InName
) const

 Get the description for the output with the given name. MetasoundFrontendController.h  

TArray< FNodeHandle > GetOutputNodes()

 Returns all output nodes in the graph. MetasoundFrontendController.h  

FConstNodeHandle GetOutputNodeWithName ( const FVertexName& InName
) const

 Returns a handle to an existing output node for the given graph output name. MetasoundFrontendController.h  

FNodeHandle GetOutputNodeWithName ( const FVertexName& InName
)

 Returns a handle to an existing output node for the given graph output name. MetasoundFrontendController.h  

const FMetasoundFrontendInterfaceStyle & GetOutputStyle()

   MetasoundFrontendController.h  

TArray< FVertexName > GetOutputVertexNames()

   MetasoundFrontendController.h  

FDocumentHandle GetOwningDocument ()

 Returns a handle to the document owning this graph. MetasoundFrontendController.h  

FConstDocumentHandle GetOwningDocument ()

 Returns a handle to the document owning this graph. MetasoundFrontendController.h  

ELiteralType GetPreferredLiteralTypeForInputVertex ( const FVertexName& InInputName
) const

 Returns the preferred literal argument type for a given input. MetasoundFrontendController.h  

int32 GetSortOrderIndexForInput ( const FVertexName& InName
) const

 Returns the sort order index for the input with the given name. Returns 0 if not found or unset. MetasoundFrontendController.h  

int32 GetSortOrderIndexForOutput ( const FVertexName& InName
) const

 Returns the sort order index for the input with the given name. Returns 0 if not found or unset. MetasoundFrontendController.h  

UClass * GetSupportedClassForInputVertex ( const FVertexName& InInputName
)

 Return the UObject class corresponding an input. MetasoundFrontendController.h  

TArray< FConstVariableHandle > GetVariables ()

 Returns an array of all variables associated with the graph. MetasoundFrontendController.h  

TArray< FVariableHandle > GetVariables ()

 Returns an array of all variables associated with the graph. MetasoundFrontendController.h  

FGuid GetVertexIDForInputVertex ( const FVertexName& InInputName
) const

   MetasoundFrontendController.h  

FGuid GetVertexIDForOutputVertex ( const FVertexName& InOutputName
) const

   MetasoundFrontendController.h  

bool IsValid()

 Returns true if the controller is in a valid state. MetasoundFrontendController.h  

void IterateConstNodes ( TFunctionRef< void(FConstNodeHandle)> InFunction,
EMetasoundFrontendClassType InClassType
) const

 Iterate over all nodes with the given function. MetasoundFrontendController.h  

void IterateNodes ( TFunctionRef< void(FNodeHandle)> InFunction,
EMetasoundFrontendClassType InClassType
)

 Iterate over all input nodes with the given function. MetasoundFrontendController.h  

bool RemoveInputVertex ( const FVertexName& InputName
)

 Remove the input with the given name. Returns true if successfully removed, false otherwise. MetasoundFrontendController.h  

bool RemoveNode ( INodeController& InNode
)

 Remove the node corresponding to this node handle. MetasoundFrontendController.h  

bool RemoveOutputVertex ( const FVertexName& OutputName
)

 Remove the output with the given name. Returns true if successfully removed, false otherwise. MetasoundFrontendController.h  

bool RemoveVariable ( const FGuid& InVariableID
)

 Removes the variable with the given ID. MetasoundFrontendController.h  

bool SetDefaultInput ( const FGuid& InVertexID,
const FMetasoundFrontendLiteral& InLiteral,
TArrayView< const FGuid > InPageOrder
)

   MetasoundFrontendController.h  

bool SetDefaultInput ( const FGuid& InVertexID,
const FMetasoundFrontendLiteral& InLiteral
)

 These can be used to set the default value for a given input on this graph. MetasoundFrontendController.h  

bool SetDefaultInputToDefaultLiteralOfType ( const FGuid& InVertexID
)

 Set the default value for the graph input. MetasoundFrontendController.h  

void SetGraphMetadata ( const FMetasoundFrontendClassMetadata& InMetadata
)

 Sets the metadata for the current graph. MetasoundFrontendController.h  

void SetGraphPresetOptions ( const FMetasoundFrontendGraphClassPresetOptions& InPresetOptions
)

 Sets the preset options for the current graph. MetasoundFrontendController.h  

void SetGraphStyle ( FMetasoundFrontendGraphStyle Style
)

 Sets graph style. MetasoundFrontendController.h  

void SetInputDescription ( const FVertexName& InName,
const FText& InDescription
)

 Set the description for the input with the given name. MetasoundFrontendController.h  

void SetInputDisplayName ( const FVertexName& InName,
const FText& InDisplayName
)

 Set the display name for the input with the given name. MetasoundFrontendController.h  

bool SetInputInheritsDefault ( FName InName,
bool bDefaultIsInherited
)

 If true, adds an item to the set of all input names that are managed. MetasoundFrontendController.h  

void SetInputsInheritingDefault ( TSet< FName >&& InNames
)

 Sets managed input names MetasoundFrontendController.h  

void SetInputStyle ( FMetasoundFrontendInterfaceStyle Style
)

 Sets the input style for the graph. MetasoundFrontendController.h  

void SetOutputDescription ( const FVertexName& InName,
const FText& InDescription
)

 Set the description for the output with the given name. MetasoundFrontendController.h  

void SetOutputDisplayName ( const FVertexName& InName,
const FText& InDisplayName
)

 Set the display name for the output with the given name. MetasoundFrontendController.h  

void SetOutputStyle ( FMetasoundFrontendInterfaceStyle Style
)

 Sets the output style for the graph. MetasoundFrontendController.h  

void SetSortOrderIndexForInput ( const FVertexName& InName,
int32 InSortOrderIndex
)

 Sets the sort order index for the input with the given name. No-ops if input not found. MetasoundFrontendController.h  

void SetSortOrderIndexForOutput ( const FVertexName& InName,
int32 InSortOrderIndex
)

 Sets the sort order index for the output with the given name. No-ops if output not found. MetasoundFrontendController.h  
Updates the ChangeID for the class interface, which signals AutoUpdate to attempt to patch class references at runtime even if the graph class has not been versioned. MetasoundFrontendController.h  

Static

Name Remarks Include Path Unreal Specifiers

static FGraphHandle GetInvalidHandle()

   MetasoundFrontendController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page