INodeController

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

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function

INodeController()

Destructors

Name Description

Public function Virtual

~INodeController()

Functions

Name Description

Public function

FInputHandle

 

AddInput

(
    const FVertexName& InVertexName,
    const FMetasoundFrontendLiteral...
)

Public function

FInputHandle

 

AddOutput

(
    const FVertexName& InVertexName,
    const FMetasoundFrontendLiteral...
)

Public function Const

FConstGraphH...

 

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* OutInt...
)

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. Optionally provide interface updates to be populate with any information regarding interface updates.

Public function

bool

 

ClearInputLiteral

(
    FGuid InVertexID
)

Clears an input's default literal.

Public function Const

bool

 

DiffAgainstRegistryInterface

(
    FClassInterfaceUpdates& OutInterfa...,
    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

FMetasoundFr...

 

FindHighestMinorVersionInRegistry()

Returns the highest version number available from the class registry that shares this node's name.

Public function Const

FMetasoundFr...

 

FindHighestVersionInRegistry()

Returns the highest minor version number available from the class registry that shares this node's name & major version.

Public function Const

FGuid

 

GetClassID()

Returns the ID associated with the node class.

Public function Const

const FMetas...

 

GetClassInterface()

Returns associated node class data

Public function Const

const FMetas...

 

GetClassMetadata()

Public function Const

const FMetas...

 

GetClassStyle()

Public function Const

TArray< FCon...

 

GetConstInputs()

Returns all node inputs.

Public function Const

FConstInputH...

 

GetConstInputWithVertexName

(
    const FVertexName& InName
)

Public function Const

TArray< FCon...

 

GetConstOutputs()

Returns all node outputs.

Public function Const

FConstOutput...

 

GetConstOutputWithVertexName

(
    const FVertexName& InName
)

Public function Const

const FText ...

 

GetDescription()

Description of the given node.

Public function Const

FText

 

GetDisplayName()

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

 

GetDisplayTitle()

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 FMetas...

 

GetInputLiteral

(
    const FGuid& InVertexID
)

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

Public function

TArray< FInp...

 

GetInputs()

Returns all node inputs.

Public function Const

const FMetas...

 

GetInputStyle()

Public function Const

FConstInputH...

 

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

 

GetInputWithVertexName

(
    const FVertexName& InName
)

Public function Const

const FMetas...

 

GetInterfaceVersion()

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

Public function Static

FNodeHandle

 

GetInvalidHandle()

Public function Const

const FVerte...

 

GetNodeName()

Returns the name of this node.

Public function Const

const FMetas...

 

GetNodeStyle()

Public function Const

int32

 

GetNumInputs()

Returns number of node inputs.

Public function Const

int32

 

GetNumOutputs()

Returns number of node outputs.

Public function

TArray< FOut...

 

GetOutputs()

Returns all node outputs.

Public function Const

const FMetas...

 

GetOutputStyle()

Public function Const

FConstOutput...

 

GetOutputWithID

(
    FGuid InVertexID
)

Returns an output with the given name.

Public function

FOutputHandl...

 

GetOutputWithID

(
    FGuid InVertexID
)

Returns an output with the given name.

Public function

FOutputHandl...

 

GetOutputWithVertexName

(
    const FVertexName& InName
)

Public function

FGraphHandle

 

GetOwningGraph()

Returns the graph which owns this node.

Public function Const

FConstGraphH...

 

GetOwningGraph()

Returns the graph which owns this node.

Public function Const

FGuid

 

GetOwningGraphClassID()

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

Public function Const

bool

 

IsInterfaceMember()

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

 

IterateConstInputs

(
    TUniqueFunction< void...
)

Public function Const

void

 

IterateConstOutputs

(
    TUniqueFunction< void...
)

Public function

void

 

IterateInputs

(
    TUniqueFunction< void)...
)

Iterate over inputs

Public function

void

 

IterateOutputs

(
    TUniqueFunction< void...
)

Iterate over outputs

Public function

bool

 

RemoveInput

(
    FGuid InVertexID
)

Public function

bool

 

RemoveOutput

(
    FGuid InVertexID
)

Public function

FNodeHandle

 

ReplaceWithVersion

(
    const FMetasoundFrontendVersionNumb...
)

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

 

SetInputLiteral

(
    const FMetasoundFrontendVertexLiter...
)

Sets an input's default literal.

Public function

void

 

SetNodeName

(
    const FVertexName& InName
)

Public function

void

 

SetNodeStyle

(
    const FMetasoundFrontendNodeStyle&...
)