1. Epic GamesDeveloper
  3. INodeController

INodeController

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

API > API/Plugins > API/Plugins/MetasoundFrontend

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

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

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

INodeController()

   MetasoundFrontendController.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~INodeController()

   MetasoundFrontendController.h  

Typedefs

Name Type Remarks Include Path
FVertexNameAndType TTuple< FVertexName, FName >   MetasoundFrontendController.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   MetasoundFrontendController.h  

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

   MetasoundFrontendController.h  

FConstGraphHandle AsGraph ()

 If the node is also a graph, this returns a graph handle. MetasoundFrontendController.h  

FGraphHandle AsGraph ()

 If the node is also a graph, this returns a graph handle. MetasoundFrontendController.h  

bool CanAddInput ( const FVertexName& InVertexName
) const

   MetasoundFrontendController.h  

bool CanAddOutput ( const FVertexName& InVertexName
) const

   MetasoundFrontendController.h  

bool CanAutoUpdate ( FClassInterfaceUpdates& OutInterfaceUpdates
) const

 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). MetasoundFrontendController.h  

bool ClearInputLiteral ( FGuid InVertexID
)

 Clears an input's default literal. MetasoundFrontendController.h  

bool DiffAgainstRegistryInterface ( FClassInterfaceUpdates& OutInterfaceUpdates,
bool bInUseHighestMinorVersion,
bool bInForceRegenerateClassInterfaceOverride
) const

 Fills out the provided ClassInterfaceUpdate struct with the differences between the registry's version of the class interface and that of the node. MetasoundFrontendController.h  

FGuid GetClassID()

 Returns the ID associated with the node class. MetasoundFrontendController.h  

const FMetasoundFrontendClassInterface & GetClassInterface()

   MetasoundFrontendController.h  

const FMetasoundFrontendClassMetadata & GetClassMetadata()

   MetasoundFrontendController.h  

const FMetasoundFrontendClassStyle & GetClassStyle()

   MetasoundFrontendController.h  

TArray< FConstInputHandle > GetConstInputs()

 Returns all node inputs. MetasoundFrontendController.h  

FConstInputHandle GetConstInputWithVertexName ( const FVertexName& InName
) const

   MetasoundFrontendController.h  

TArray< FConstOutputHandle > GetConstOutputs()

 Returns all node outputs. MetasoundFrontendController.h  

FConstOutputHandle GetConstOutputWithVertexName ( const FVertexName& InName
) const

   MetasoundFrontendController.h  

const FText & GetDescription()

 Description of the given node. MetasoundFrontendController.h  

FText GetDisplayName()

 Returns the display name of the given node (what to distinguish and label in visual arrays, such as context menus). MetasoundFrontendController.h  

const FText & GetDisplayTitle()

 Returns the title of the given node (what to label when displayed as visual node). MetasoundFrontendController.h  

FGuid GetID()

 Returns the ID associated with this node. MetasoundFrontendController.h  

const FMetasoundFrontendLiteral * GetInputLiteral ( const FGuid& InVertexID
) const

 Returns an input's default literal if set, null if not. MetasoundFrontendController.h  

TArray< FInputHandle > GetInputs()

 Returns all node inputs. MetasoundFrontendController.h  

const FMetasoundFrontendInterfaceStyle & GetInputStyle()

   MetasoundFrontendController.h  

FConstInputHandle GetInputWithID ( FGuid InVertexID
) const

 Returns an input with the given name. MetasoundFrontendController.h  

FInputHandle GetInputWithID ( FGuid InVertexID
)

 Returns an input with the given id.If the input does not exist, an invalid handle is returned. MetasoundFrontendController.h  

FInputHandle GetInputWithVertexName ( const FVertexName& InName
)

   MetasoundFrontendController.h  

const FMetasoundFrontendVersion & GetInterfaceVersion()

 Returns interface version if node is a required member of a given interface, otherwise returns invalid version. MetasoundFrontendController.h  
  MetasoundFrontendController.h  

const FMetasoundFrontendNodeInterface & GetNodeInterface()

 Returns the node interface, which may be different than the class interface if the class supports dynamic input/output behavior (ex. Templates). MetasoundFrontendController.h  

const FVertexName & GetNodeName()

 Returns the name of this node. MetasoundFrontendController.h  

const FMetasoundFrontendNodeStyle & GetNodeStyle()

   MetasoundFrontendController.h  

int32 GetNumInputs()

 Returns number of node inputs. MetasoundFrontendController.h  

int32 GetNumOutputs()

 Returns number of node outputs. MetasoundFrontendController.h  

TArray< FOutputHandle > GetOutputs()

 Returns all node outputs. MetasoundFrontendController.h  

const FMetasoundFrontendInterfaceStyle & GetOutputStyle()

 Returns associated node class data MetasoundFrontendController.h  

FConstOutputHandle GetOutputWithID ( FGuid InVertexID
) const

 Returns an output with the given name. MetasoundFrontendController.h  

FOutputHandle GetOutputWithID ( FGuid InVertexID
)

 Returns an output with the given name. MetasoundFrontendController.h  

FOutputHandle GetOutputWithVertexName ( const FVertexName& InName
)

   MetasoundFrontendController.h  

FGraphHandle GetOwningGraph ()

 Returns the graph which owns this node. MetasoundFrontendController.h  

FConstGraphHandle GetOwningGraph ()

 Returns the graph which owns this node. MetasoundFrontendController.h  

FGuid GetOwningGraphClassID()

 Returns the class ID of the metasound class which owns this node. MetasoundFrontendController.h  

bool IsInterfaceMember()

 Returns true if node is required to satisfy a document interface. MetasoundFrontendController.h  

bool IsValid()

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

void IterateConstInputs ( TUniqueFunction< void(FConstInputHandle)> InFunction
) const

   MetasoundFrontendController.h  

void IterateConstOutputs ( TUniqueFunction< void(FConstOutputHandle)> InFunction
) const

   MetasoundFrontendController.h  

void IterateInputs ( TUniqueFunction< void(FInputHandle)> InFunction
)

 Iterate over inputs MetasoundFrontendController.h  

void IterateOutputs ( TUniqueFunction< void(FOutputHandle)> InFunction
)

 Iterate over outputs MetasoundFrontendController.h  

bool RemoveInput ( FGuid InVertexID
)

   MetasoundFrontendController.h  

bool RemoveOutput ( FGuid InVertexID
)

   MetasoundFrontendController.h  

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. MetasoundFrontendController.h  

void SetDescription ( const FText& InDescription
)

 Sets the description of the node. MetasoundFrontendController.h  

void SetDisplayName ( const FText& InDisplayName
)

 Sets the display name of the node. MetasoundFrontendController.h  

void SetInputLiteral ( const FMetasoundFrontendVertexLiteral& InVertexLiteral
)

 Sets an input's default literal. MetasoundFrontendController.h  

void SetNodeConfiguration ( TInstancedStruct< FMetaSoundFrontendNodeConfiguration > InConfig
)

   MetasoundFrontendController.h  

void SetNodeName ( const FVertexName& InName
)

   MetasoundFrontendController.h  

void SetNodeStyle ( const FMetasoundFrontendNodeStyle& InStyle
)

   MetasoundFrontendController.h  

Static

Name Remarks Include Path Unreal Specifiers

static FNodeHandle 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