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