FMetaSoundFrontendDocumentVertexTemplate

Template of a MetaSound that stores vertex (input or output) Metadata to display alongside standard properties in MetaSound vertex editors.

API > API/Plugins > API/Plugins/MetasoundFrontend

Template of a MetaSound that stores vertex (input or output) Metadata to display alongside standard properties in MetaSound vertex editors.

   
Name FMetaSoundFrontendDocumentVertexTemplate
Type struct
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h
Include Path #include "DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h"

Syntax

USTRUCT (BlueprintType , Meta=(Hidden))  
struct FMetaSoundFrontendDocumentVertexTemplate : public FMetaSoundFrontendDocumentTemplate

Inheritance Hierarchy

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMetaSoundFrontendDocumentVertexTemplate()

   DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
VertexMetadata TMap< FGuid, TInstancedStruct< FMetaSoundFrontendDocumentTemplateVertexMetadata > >   DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Creates and stores new VertexMetadata. DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

TTemplateVertexMetadata * AddVertexMetadata ( const FMetaSoundFrontendDocumentBuilder& Builder,
const FMetasoundFrontendClassVertex& InVertex
)

 Creates and stores new VertexMetadata with the provided type and name, asserting that the type created by the overloaded template matches the template type. DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

bool ContainsVertexMetadata ( const FGuid& NodeID
) const

 Returns whether or not there is existing Metadata with the given NodeID. DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

const TTemplateVertexMetadata * FindConstVertexMetadata ( const FGuid& NodeID
) const

 Helper function to returns VertexMetadata with the provided class type and name and cast to underlying config type. DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

TTemplateVertexMetadata * FindVertexMetadata ( const FGuid& NodeID
)

 Helper function to returns VertexMetadata with the provided class type and name and cast to underlying config type. DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

const UScriptStruct * GetVertexMetadataStruct ( const FGuid& NodeID
) const

   DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

bool RemoveVertexMetadata ( const FGuid& NodeID
)

 Removes VertexMetadata with the provided NodeID. Returns if Metadata was found and removed or not. DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

Public Virtual

Protected Virtual

Name Remarks Include Path Unreal Specifiers
  DocumentTemplates/MetasoundFrontendDocumentVertexTemplate.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page