IMetaSoundGraphPanelPinFactory

Factory for creating MetaSound Editor Graph pin icons and widgets.

API > API/Plugins > API/Plugins/MetasoundEditor

Factory for creating MetaSound Editor Graph pin icons and widgets.

Provides a single registration API for external plugins to register custom pin types with optional styling (category, color, icons). Internal core MetaSound pin types (Boolean, Float, Trigger, etc.) are registered automatically at startup.

Lifecycle:

  • Register pins in your module's StartupModule() after MetaSoundEditor is loaded.
  • Unregister pins in your module's ShutdownModule(). Guard with FModuleManager::Get().IsModuleLoaded(IMetasoundEditorModule::ModuleName) in case MetaSoundEditor shuts down before your module.
  • All Register/Unregister calls must be made on the game thread.
   
Name IMetaSoundGraphPanelPinFactory
Type class
Header File /Engine/Plugins/Runtime/Metasound/Source/MetasoundEditor/Public/IMetaSoundGraphPanelPinFactory.h
Include Path #include "IMetaSoundGraphPanelPinFactory.h"

Syntax

class IMetaSoundGraphPanelPinFactory : public FGraphPanelPinFactory

Inheritance Hierarchy

Functions

Public

Name Remarks Include Path Unreal Specifiers

const FEdGraphPinType * FindPinType ( FName InDataTypeName
) const

 Find the pin type configuration for a registered data type. Returns nullptr if not registered. IMetaSoundGraphPanelPinFactory.h  

bool GetCustomPinIcons ( UEdGraphPin* InPin,
const FSlateBrush*& OutConnectedIcon,
const FSlateBrush*& OutDisconnectedIcon
) const

 Get custom pin icons for a registered data type via pin reference. IMetaSoundGraphPanelPinFactory.h  

bool GetCustomPinIcons ( FName InDataType,
const FSlateBrush*& OutConnectedIcon,
const FSlateBrush*& OutDisconnectedIcon
) const

 Get custom pin icons for a registered data type by name. IMetaSoundGraphPanelPinFactory.h  

FLinearColor GetPinColor ( const FEdGraphPinType& InPinType
) const

 Get pin color for a pin type. IMetaSoundGraphPanelPinFactory.h  

void RegisterCategoryPin ( FName InPinCategory,
FOnCreateMetaSoundPinWidget InCreateDelegate
)

 Register a pin widget factory for a specific pin category. IMetaSoundGraphPanelPinFactory.h  

void RegisterDataTypePin ( FName InDataTypeName,
FOnCreateMetaSoundPinWidget InCreateDelegate
)

 Register a pin widget factory for a specific data type. IMetaSoundGraphPanelPinFactory.h  

void RegisterPin ( FName InDataTypeName,
const FGraphPinParams& Params
)

 Register a pin type for a MetaSound data type with optional styling parameters. IMetaSoundGraphPanelPinFactory.h  

void UnregisterCategoryPin ( FName InPinCategory
)

 Unregister a pin widget factory for a pin category. IMetaSoundGraphPanelPinFactory.h  

void UnregisterDataTypePin ( FName InDataTypeName
)

 Unregister a pin widget factory for a data type. IMetaSoundGraphPanelPinFactory.h  

void UnregisterPin ( FName InDataTypeName
)

 Unregister a previously registered pin type. IMetaSoundGraphPanelPinFactory.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page