1. Epic GamesDeveloper
  3. IGraphController

IGraphController

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

API > API/Plugins > API/Plugins/MetasoundFrontend

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FNodeHandle

AddDuplicateNode ( const INodeController& InNodeController
)

 Add a new node to this graph by duplicating the supplied node.
Public function FNodeHandle

AddInputVertex ( const FMetasoundFrontendClassInput& InDescription
)

 Add a new input node using the input description.
Public function FNodeHandle

AddNode ( const FMetasoundFrontendClassMetadata& InClassMetadata,
FGuid InNodeGuid
)

 Add a new node to this graph.
Public function FNodeHandle

AddNode ( const FNodeRegistryKey& InKey,
FGuid InNodeGuid
)

 Add a new node to this graph from the node registry.
Public function FNodeHandle Add a new output node using the output description.
Public function FNodeHandle

AddOutputVertex ( const FVertexName& InName,
const FName InTypeName
)

  
Public function FNodeHandle

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

 Add a new template node to this graph, providing the defined interface as expected by the caller.
Public function FVariableHandle

AddVariable ( const FName& InDataTypeName
)

 Adds a new variable to the graph
Public function FNodeHandle

AddVariableAccessorNode ( const FGuid& InVariableID
)

 Creates and returns a variable accessor node.
Public function FNodeHandle

AddVariableDeferredAccessorNode ( const FGuid& InVariableID
)

 Creates and returns a variable deferred accessor node.
Public function Const TUniquePtr< IOperator >

BuildOperator ( const FOperatorSettings& InSettings,
const FMetasoundEnvironment& InEnvironment,
FBuildResults& OutResults
)

 Creates a runtime operator for the given graph.
Public function void Clears the graph, its associated interface, and synchronizes removed dependencies with the owning graph.
Public function bool

ClearLiteralForInput ( const FVertexName& InInputName,
FGuid InVertexID
)

 Clear the current literal for a given input.
Public function Const bool

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

 Returns true if an input vertex with the given Name exists.
Public function Const bool Returns true if an input vertex with the given Name exists.
Public function Const bool

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

 Returns true if an output vertex with the given Name exists.
Public function Const bool Returns true if an output vertex with the given Name exists.
Public function FNodeHandle Creates and inserts a new subgraph into this graph using the given metadata.
Public function Const FConstClassInputAccessPtr  
Public function Const FConstClassOutputAccessPtr  
Public function FNodeHandle

FindOrAddVariableMutatorNode ( const FGuid& InVariableID
)

 Returns the variable mutator node. If none exist, one is created.
Public function Const FConstVariableHandle

FindVariable ( const FGuid& InVariableID
)

 Finds a variable by ID.
Public function FVariableHandle

FindVariable ( const FGuid& InVariableID
)

 Finds a variable by ID.
Public function Const FConstVariableHandle

FindVariableContainingNode ( const FGuid& InNodeID
)

 Finds a variable inspecting the nodes associated with the variable.
Public function FVariableHandle

FindVariableContainingNode ( const FGuid& InNodeID
)

 Finds a variable inspecting the nodes associated with the variable.
Public function Const FGuid Returns the ClassID associated with this graph.
Public function Const TArray< FConstNodeHandle > Returns all input nodes in the graph.
Public function Const TArray< FConstNodeHandle > Returns all nodes in the graph.
Public function Const TArray< FConstNodeHandle > Returns all output nodes in the graph.
Public function Const FMetasoundFrontendLiteral

GetDefaultInput ( const FGuid& InVertexID
)

  
Public function Const FText Return the display name of the graph.
Public function Const const FMetasoundFrontendClassMetadata & Return the metadata for the current graph.
Public function Const const FMetasoundFrontendGraphClassPresetOptions & Return the preset options for the current graph.
Public function Const const FMetasoundFrontendGraphStyle & Returns graph style.
Public function Const const FText &

GetInputDescription ( const FVertexName& InName
)

 Get the description for the input with the given name.
Public function TArray< FNodeHandle > Returns all input nodes in the graph.
Public function FNodeHandle

GetInputNodeWithName ( const FVertexName& InName
)

 Returns a handle to an existing input node for the given graph input name.
Public function Const FConstNodeHandle

GetInputNodeWithName ( const FVertexName& InName
)

 Returns a handle to an existing input node for the given graph input name.
Public function Const const TSet< FName > & Returns a set of all input names that are managed
Public function Const const FMetasoundFrontendInterfaceStyle &  
Public function Const TArray< FVertexName >  
Public function Static FGraphHandle  
Public function TArray< FNodeHandle > Returns all nodes in the graph.
Public function FNodeHandle

GetNodeWithID ( FGuid InNodeID
)

 Returns a node by NodeID. If the node does not exist, an invalid handle is returned.
Public function Const FConstNodeHandle

GetNodeWithID ( FGuid InNodeID
)

 Returns a node by NodeID. If the node does not exist, an invalid handle is returned.
Public function Const const FText &

GetOutputDescription ( const FVertexName& InName
)

 Get the description for the output with the given name.
Public function TArray< FNodeHandle > Returns all output nodes in the graph.
Public function Const FConstNodeHandle Returns a handle to an existing output node for the given graph output name.
Public function FNodeHandle Returns a handle to an existing output node for the given graph output name.
Public function Const const FMetasoundFrontendInterfaceStyle &  
Public function Const TArray< FVertexName >  
Public function FDocumentHandle Returns a handle to the document owning this graph.
Public function Const FConstDocumentHandle Returns a handle to the document owning this graph.
Public function Const ELiteralType Returns the preferred literal argument type for a given input.
Public function Const int32 Returns the sort order index for the input with the given name. Returns 0 if not found or unset.
Public function Const int32 Returns the sort order index for the input with the given name. Returns 0 if not found or unset.
Public function UClass * Return the UObject class corresponding an input.
Public function Const TArray< FConstVariableHandle > Returns an array of all variables associated with the graph.
Public function TArray< FVariableHandle > Returns an array of all variables associated with the graph.
Public function Const FGuid

GetVertexIDForInputVertex ( const FVertexName& InInputName
)

  
Public function Const FGuid

GetVertexIDForOutputVertex ( const FVertexName& InOutputName
)

  
Public function Const bool

IsValid ()

 Returns true if the controller is in a valid state.
Public function Const void Iterate over all nodes with the given function.
Public function void Iterate over all input nodes with the given function.
Public function bool

RemoveInputVertex ( const FVertexName& InputName
)

 Remove the input with the given name. Returns true if successfully removed, false otherwise.
Public function bool Remove the node corresponding to this node handle.
Public function bool

RemoveOutputVertex ( const FVertexName& OutputName
)

 Remove the output with the given name. Returns true if successfully removed, false otherwise.
Public function bool

RemoveVariable ( const FGuid& InVariableID
)

 Removes the variable with the given ID.
Public function bool

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

  
Public function bool Set the default value for the graph input.
Public function void Sets the metadata for the current graph.
Public function void Sets the preset options for the current graph.
Public function void Sets graph style.
Public function void

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

 Set the description for the input with the given name.
Public function void

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

 Set the display name for the input with the given name.
Public function bool

SetInputInheritsDefault ( FName InName,
bool bDefaultIsInherited
)

 If true, adds an item to the set of all input names that are managed.
Public function void Sets managed input names
Public function void Sets the input style for the graph.
Public function void

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

 Set the description for the output with the given name.
Public function void

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

 Set the display name for the output with the given name.
Public function void Sets the output style for the graph.
Public function 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.
Public function 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.
Public function void 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.

Deprecated Functions

  Type Name Description
Public function FNodeHandle

AddInputVertex ( const FVertexName& InName,
const FName InTypeName,
const FMetasoundFrontendLiteral* InDefaultValue
)

 Use AddInputVertex method which specifies EMetasoundFrontendVertexAccessType

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page