Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
Inheritance Hierarchy
- TSharedFromThis
- IDocumentAccessor
- IOutputController
References
| Module | MetasoundFrontend |
| Header | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendController.h |
| Include | #include "MetasoundFrontendController.h" |
Syntax
class IOutputController :
public TSharedFromThis< IOutputController >,
public Metasound::Frontend::IDocumentAccessor
Remarks
An IOutputController provides methods for querying and manipulating a metasound output vertex.
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| FConnectability | CanConnectTo
(
const IInputController& InController |
Returns information describing connectability between this output and the supplied input. | |
| bool | Connect
(
IInputController& InController |
Connects this output and the supplied input. | |
| bool | ConnectWithConverterNode
(
IInputController& InController, |
Connects this output to the input using a converter node. | |
| bool | Disconnect
(
IInputController& InController |
Disconnects this output from the input. | |
| bool | Disconnect () |
||
| TArray< FInputHandle > | Returns the currently connected output. | ||
| TArray< FConstInputHandle > | Returns the currently connected output. | ||
| const FName & | GetDataType () |
Returns the data type name associated with this output. | |
| FText | Returns the human readable name associated with this output. | ||
| FGuid | GetID () |
||
| FOutputHandle | |||
| const FMetasoundFrontendVertexMetadata & | GetMetadata () |
Returns all metadata associated with this output. | |
| const FVertexName & | GetName () |
Returns the name associated with this output. | |
| FNodeHandle | Returns a FNodeHandle to the node which owns this output. | ||
| FConstNodeHandle | Returns a FConstNodeHandle to the node which owns this output. | ||
| FGuid | Returns the ID of the node which owns this output. | ||
| const FText & | GetTooltip () |
Returns the tooltip associated with this output. | |
| EMetasoundFrontendVertexAccessType | Returns the vertex access type. | ||
| bool | IsConnected () |
Return true if the input is connect to an output. | |
| bool | Returns true if the output connections can be directly modified by a user. Returns false otherwise. | ||
| bool | IsValid () |
Returns true if the controller is in a valid state. | |
| void | SetName
(
const FVertexName& InName |
This should only be used as a means of fixing up vertex names for document model versioning transform(s). |