1. Epic GamesDeveloper
  3. INodeController

INodeController

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

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 INodeController :  
    public TSharedFromThis< INodeController >,  
    public Metasound::Frontend::IDocumentAccessor

Remarks

An INodeController provides methods for querying and manipulating a Metasound node.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FInputHandle

AddInput ( const FVertexName& InVertexName,
const FMetasoundFrontendLiteral* InDefault
)

  
Public function FInputHandle

AddOutput ( const FVertexName& InVertexName,
const FMetasoundFrontendLiteral* InDefault
)

  
Public function Const FConstGraphHandle

AsGraph ()

 If the node is also a graph, this returns a graph handle.
Public function FGraphHandle

AsGraph ()

 If the node is also a graph, this returns a graph handle.
Public function Const bool

CanAddInput ( const FVertexName& InVertexName
)

  
Public function Const bool

CanAddOutput ( const FVertexName& InVertexName
)

  
Public function Const bool

CanAutoUpdate ( FClassInterfaceUpdates& OutInterfaceUpdates
)

 Returns whether the node is eligible for auto-updating (i.e. has undergone minor revision or the interface has changed, but no higher major revision is available).
Public function bool

ClearInputLiteral ( FGuid InVertexID
)

 Clears an input's default literal.
Public function Const bool

DiffAgainstRegistryInterface ( FClassInterfaceUpdates& OutInterfaceUpdates,
bool bInUseHighestMinorVersion
)

 Fills out the provided ClassInterfaceUpdate struct with the differences between the registry's version of the class interface and that of the node.
Public function Const FGuid Returns the ID associated with the node class.
Public function Const const FMetasoundFrontendClassInterface &  
Public function Const const FMetasoundFrontendClassMetadata &  
Public function Const const FMetasoundFrontendClassStyle &  
Public function Const TArray< FConstInputHandle > Returns all node inputs.
Public function Const FConstInputHandle  
Public function Const TArray< FConstOutputHandle > Returns all node outputs.
Public function Const FConstOutputHandle  
Public function Const const FText & Description of the given node.
Public function Const FText Returns the display name of the given node (what to distinguish and label in visual arrays, such as context menus).
Public function Const const FText & Returns the title of the given node (what to label when displayed as visual node).
Public function Const FGuid

GetID ()

 Returns the ID associated with this node.
Public function Const const FMetasoundFrontendLiteral *

GetInputLiteral ( const FGuid& InVertexID
)

 Returns an input's default literal if set, null if not.
Public function TArray< FInputHandle > Returns all node inputs.
Public function Const const FMetasoundFrontendInterfaceStyle &  
Public function Const FConstInputHandle

GetInputWithID ( FGuid InVertexID
)

 Returns an input with the given name.
Public function FInputHandle

GetInputWithID ( FGuid InVertexID
)

 Returns an input with the given id.If the input does not exist, an invalid handle is returned.
Public function FInputHandle  
Public function Const const FMetasoundFrontendVersion & Returns interface version if node is a required member of a given interface, otherwise returns invalid version.
Public function Static FNodeHandle  
Public function Const const FMetasoundFrontendNodeInterface & Returns the node interface, which may be different than the class interface if the class supports dynamic input/output behavior (ex. Templates).
Public function Const const FVertexName & Returns the name of this node.
Public function Const const FMetasoundFrontendNodeStyle &  
Public function Const int32 Returns number of node inputs.
Public function Const int32 Returns number of node outputs.
Public function TArray< FOutputHandle > Returns all node outputs.
Public function Const const FMetasoundFrontendInterfaceStyle & Returns associated node class data
Public function Const FConstOutputHandle

GetOutputWithID ( FGuid InVertexID
)

 Returns an output with the given name.
Public function FOutputHandle

GetOutputWithID ( FGuid InVertexID
)

 Returns an output with the given name.
Public function FOutputHandle  
Public function FGraphHandle Returns the graph which owns this node.
Public function Const FConstGraphHandle Returns the graph which owns this node.
Public function Const FGuid Returns the class ID of the metasound class which owns this node.
Public function Const bool Returns true if node is required to satisfy a document interface.
Public function Const bool

IsValid ()

 Returns true if the controller is in a valid state.
Public function Const void  
Public function Const void  
Public function void

IterateInputs ( TUniqueFunction< void(FInputHandle)> InFunction
)

 Iterate over inputs
Public function void Iterate over outputs
Public function bool

RemoveInput ( FGuid InVertexID
)

  
Public function bool

RemoveOutput ( FGuid InVertexID
)

  
Public function FNodeHandle

ReplaceWithVersion ( const FMetasoundFrontendVersionNumber& InNewVersion,
TArray< FVertexNameAndType >* OutDisconnectedInputs,
TArray< FVertexNameAndType >* OutDisconnectedOutputs
)

 Replaces this node with a new node of the provided version number, and attempts to rebuild edges where possible with matching vertex names that share the same DataType.
Public function void

SetDescription ( const FText& InDescription
)

 Sets the description of the node.
Public function void

SetDisplayName ( const FText& InDisplayName
)

 Sets the display name of the node.
Public function void Sets an input's default literal.
Public function void

SetNodeName ( const FVertexName& InName
)

  
Public function void  

Typedefs

Name Description
FVertexNameAndType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page