FClassInterface | Unreal Engine 5.8 Documentation

API > API/Plugins > API/Plugins/MetasoundGraphCore

An FClassInterface defines the class interface of a MetaSound C++ node class. This interface may contain basic vertices, but also subinterfaces and variants.

The FClassInterface is used to create the FVertexInterface for individual node instances. It does so by combining the FClassInterface definition with subinterface and variant configurations.


Name	FClassInterface
Type	class
Header File	/Engine/Plugins/Runtime/Metasound/Source/MetasoundGraphCore/Public/MetasoundVertex.h
Include Path	#include "MetasoundVertex.h"

Syntax

class FClassInterface

Constructors

Name	Remarks	Include Path
FClassInterface ()		MetasoundVertex.h
FClassInterface ( const FClassInterface& Other )	Copy constructor (deep-copies schema data).	MetasoundVertex.h
FClassInterface ( FClassInterface&& )	Move constructor.	MetasoundVertex.h
FClassInterface ( const FVertexInterface& InVertexInterface )	Construct from a FVertexInterface.	MetasoundVertex.h
FClassInterface ( const VertexPrivate::FClassInterfaceData& InClassInterfaceData )		MetasoundVertex.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FClassInterface()		MetasoundVertex.h

Variables

Protected

Name	Type	Remarks	Include Path
EnvironmentVariables	TArray< FEnvironmentVertex >		MetasoundVertex.h
Inputs	TArray< FInputDataVertex, TInlineAllocator< 1 > >		MetasoundVertex.h
Outputs	TArray< FOutputDataVertex, TInlineAllocator< 1 > >		MetasoundVertex.h
SubInterfaceSchema	TUniquePtr< VertexPrivate::FSubInterfaceSchema >		MetasoundVertex.h
VariantSchema	TUniquePtr< VertexPrivate::FVariantSchema >	Many nodes do not need this extra configurable information.	MetasoundVertex.h

Functions

Public

Name	Remarks	Include Path
bool ContainsSubInterfaces()	Returns true if this class interface contains sub-interface definitions.	MetasoundVertex.h
bool ContainsVariants()	Returns true if this class interface contains variant definitions.	MetasoundVertex.h
FVertexInterface CreateVertexInterface ( const TMap< FName, uint32 >& InSubInterfaceCounts, const TMap< FName, FName >& InVariantSelections ) const	Create a FVertexInterface with the given configuration.	MetasoundVertex.h
FVertexInterface CreateVertexInterface ()	Create a FVertexInterface with default configuration (no sub-interface or variant overrides).	MetasoundVertex.h
const FVariantDescription * FindVariantDescriptionForInput ( const FVertexName& InVertexName ) const	Return a variant description for a given input vertex if the vertex is associated with a variant.	MetasoundVertex.h
const FVariantDescription * FindVariantDescriptionForOutput ( const FVertexName& InVertexName ) const	Return a variant description for a given output vertex if the vertex is associated with a variant.	MetasoundVertex.h
TConstArrayView< FSubInterfaceDescription > GetSubInterfaceDescriptions()	Return any sub interfaces on this class interface.	MetasoundVertex.h
TConstArrayView< FVariantDescription > GetVariantDescriptions()	Return any variants on this class interface.	MetasoundVertex.h

Operators

Name	Remarks	Include Path
operator FVertexInterface()	Conversion to FVertexInterface.	MetasoundVertex.h
FClassInterface & operator= ( const FClassInterface& Other )	Copy assignment (deep-copies schema data).	MetasoundVertex.h
FClassInterface & operator= ( FClassInterface&& )	Move assignment.	MetasoundVertex.h

Navigation