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