1. Epic GamesDeveloper
  3. INodeTemplate

INodeTemplate

Base interface for a node template, which acts in place of frontend node class and respective instance(s).

API > API/Plugins > API/Plugins/MetasoundFrontend

Base interface for a node template, which acts in place of frontend node class and respective instance(s). Instances are preprocessed, allowing for custom graph manipulation prior to generating a respective runtime graph operator representation.

   
Name INodeTemplate
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendNodeTemplateRegistry.h
Include Path #include "MetasoundFrontendNodeTemplateRegistry.h"

Syntax

class INodeTemplate

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~INodeTemplate()

   MetasoundFrontendNodeTemplateRegistry.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TInstancedStruct< FMetaSoundFrontendTemplateNodeConfiguration > CreateFrontendTemplateNodeConfiguration()

 Create a node configuration for the node template. MetasoundFrontendNodeTemplateRegistry.h  

const TArray< FMetasoundFrontendClassInputDefault > * FindNodeClassInputDefaults ( const FMetaSoundFrontendDocumentBuilder& InBuilder,
const FGuid& InPageID,
const FGuid& InNodeID,
FName VertexName
) const

   MetasoundFrontendNodeTemplateRegistry.h  
  MetasoundFrontendNodeTemplateRegistry.h  

TUniquePtr< INodeTemplateTransform > GenerateNodeTransform()

 Generates node transform that is used to preprocess nodes. MetasoundFrontendNodeTemplateRegistry.h  

const FMetasoundFrontendClassName & GetClassName()

 Returns note template class name. MetasoundFrontendNodeTemplateRegistry.h  

const FMetasoundFrontendClass & GetFrontendClass()

 Returns the class definition for the given node class template. MetasoundFrontendNodeTemplateRegistry.h  

FText GetInputVertexDisplayName ( const FMetaSoundFrontendDocumentBuilder& InBuilder,
const FGuid& InPageID,
const FGuid& InNodeID,
FName InputName
) const

   MetasoundFrontendNodeTemplateRegistry.h  

FText GetNodeDisplayName ( const IMetaSoundDocumentInterface& Interface,
const FGuid& InPageID,
const FGuid& InNodeID
) const

   MetasoundFrontendNodeTemplateRegistry.h  

EMetasoundFrontendVertexAccessType GetNodeInputAccessType ( const FMetaSoundFrontendDocumentBuilder& InBuilder,
const FGuid& InPageID,
const FGuid& InNodeID,
const FGuid& InVertexID
) const

 Returns access type of the given input within the provided builder's document. MetasoundFrontendNodeTemplateRegistry.h  

EMetasoundFrontendVertexAccessType GetNodeOutputAccessType ( const FMetaSoundFrontendDocumentBuilder& InBuilder,
const FGuid& InPageID,
const FGuid& InNodeID,
const FGuid& InVertexID
) const

 Returns access type of the given output within the provided builder's document. MetasoundFrontendNodeTemplateRegistry.h  

FText GetOutputVertexDisplayName ( const FMetaSoundFrontendDocumentBuilder& InBuilder,
const FGuid& InPageID,
const FGuid& InNodeID,
FName OutputName
) const

   MetasoundFrontendNodeTemplateRegistry.h  

const FMetasoundFrontendVersionNumber & GetVersionNumber()

 Returns note template class version. MetasoundFrontendNodeTemplateRegistry.h  

bool HasRequiredConnections ( const FMetaSoundFrontendDocumentBuilder& InBuilder,
const FGuid& InPageID,
const FGuid& InNodeID,
FString* OutMessage
) const

 Returns whether or not the given node template has the necessary required connections to be preprocessed (editor only). MetasoundFrontendNodeTemplateRegistry.h  

bool IsInputAccessTypeDynamic()

 Returns whether template can dynamically assign a node's input access type (as opposed to it being assigned on the class input definition) MetasoundFrontendNodeTemplateRegistry.h  

bool IsInputConnectionUserModifiable()

 Whether or not input connections are user modifiable. MetasoundFrontendNodeTemplateRegistry.h  

bool IsOutputAccessTypeDynamic()

 Returns whether template can dynamically assign a node's output's access type (as opposed to it being assigned on the class output definition) MetasoundFrontendNodeTemplateRegistry.h  

bool IsOutputConnectionUserModifiable()

 Whether or not output connections are user modifiable. MetasoundFrontendNodeTemplateRegistry.h  

bool IsValidNodeInterface ( const FMetasoundFrontendNodeInterface& InNodeInterface
) const

 Given the provided node interface, returns whether or not it conforms to an expected format that can be successfully manipulated by a generated node template transform. MetasoundFrontendNodeTemplateRegistry.h  

bool OnEdgeAdded ( const FTemplateNodeEdgeTransactionContext& TransactionContext,
DynamicGraph::FDynamicOperatorTransactor& OutTransactor
) const

 Provided a Frontend transaction context, apply adding edge transaction to the given dynamic core transactor. MetasoundFrontendNodeTemplateRegistry.h  

bool OnNodeAdded ( const FTemplateNodeTransactionContext& TransactionContext,
DynamicGraph::FDynamicOperatorTransactor& OutTransactor
) const

 Provided a Frontend transaction context, apply adding node transaction to the given dynamic core transactor. MetasoundFrontendNodeTemplateRegistry.h  
Provided a Frontend transaction context, apply updating node config transaction to the given dynamic core transactor. MetasoundFrontendNodeTemplateRegistry.h  
Provided a Frontend transaction context, apply removing edge transaction to the given dynamic core transactor. MetasoundFrontendNodeTemplateRegistry.h  

bool OnRemoveSwappingNode ( const FTemplateNodeTransactionContext& TransactionContext,
DynamicGraph::FDynamicOperatorTransactor& OutTransactor
) const

 Provided a Frontend transaction context, apply removing node transaction to the given dynamic core transactor. MetasoundFrontendNodeTemplateRegistry.h  

Static

Name Remarks Include Path Unreal Specifiers

static FText ResolveMemberDisplayName ( FName VertexName,
FText DisplayName,
bool bIncludeNamespace
)

   MetasoundFrontendNodeTemplateRegistry.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page