1. Epic GamesDeveloper
  3. UMetaSoundViewModel

UMetaSoundViewModel

The base class for MetaSound viewmodels.

API > API/Plugins > API/Plugins/TechAudioToolsMetaSound

The base class for MetaSound viewmodels. Used for binding metadata and member inputs/outputs of a MetaSound to widgets in UMG. Can be initialized using a MetaSound Builder or a MetaSound asset. Creates member viewmodels for each input and output in the MetaSound upon initialization.

   
Name UMetaSoundViewModel
Type class
Header File /Engine/Plugins/Experimental/TechAudioTools/Source/TechAudioToolsMetaSound/Public/ViewModels/MetaSoundViewModel.h
Include Path #include "ViewModels/MetaSoundViewModel.h"

Syntax

UCLASS (MinimalAPI, DisplayName="MetaSound Viewmodel")  
class UMetaSoundViewModel : public UMVVMViewModelBase

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMetaSoundInputViewModel * FindInputViewModel ( const FName InputViewModelName
) const

 Returns the input viewmodel with the given name if it exists, else returns nullptr. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • DisplayName="Find Input Viewmodel"
  • Category="MetaSound Viewmodel"

UMetaSoundOutputViewModel * FindOutputViewModel ( const FName OutputViewModelName
) const

 Returns the output viewmodel with the given name if it exists, else returns nullptr. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • DisplayName="Find Output Viewmodel"
  • Category="MetaSound Viewmodel"

FString GetBuilderName()

 Returns the object name of the initialized builder. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • FieldNotify
  • Category="MetaSound Viewmodel"

virtual TArray< UMetaSoundInputViewModel * > GetInputViewModels()

 Contains MetaSound Input Viewmodels for each input of the initialized MetaSound. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • FieldNotify
  • DisplayName="Get Input Viewmodels"
  • Category="MetaSound Viewmodel"

virtual TArray< UMetaSoundOutputViewModel * > GetOutputViewModels()

 Contains MetaSound Output Viewmodels for each output of the initialized MetaSound. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • FieldNotify
  • DisplayName="Get Output Viewmodels"
  • Category="MetaSound Viewmodel"

virtual void Initialize ( UMetaSoundBuilderBase* InBuilder
)

 Initializes the viewmodel using the given builder. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • DisplayName="Initialize Builder"
  • Category="Audio|MetaSound Viewmodel"

virtual void InitializeMetaSound ( const TScriptInterface< IMetaSoundDocumentInterface > InMetaSound
)

 Initializes the viewmodel using the given MetaSound asset. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • DisplayName="Initialize MetaSound"
  • Category="Audio|MetaSound Viewmodel"

bool IsInitialized()

   ViewModels/MetaSoundViewModel.h  

bool IsPreset()

   ViewModels/MetaSoundViewModel.h  

void OnInputAdded ( FName VertexName,
FName DataType
)

   ViewModels/MetaSoundViewModel.h  

void OnInputDataTypeChanged ( FName VertexName,
FName DataType
)

   ViewModels/MetaSoundViewModel.h  

void OnInputDefaultChanged ( FName VertexName,
FMetasoundFrontendLiteral LiteralValue,
FName PageName
)

   ViewModels/MetaSoundViewModel.h  

void OnInputInheritsDefaultChanged ( FName VertexName,
bool bInheritsDefault
)

   ViewModels/MetaSoundViewModel.h  

void OnInputIsConstructorPinChanged ( FName VertexName,
bool bIsConstructorPin
)

   ViewModels/MetaSoundViewModel.h  

void OnInputNameChanged ( FName OldName,
FName NewName
)

   ViewModels/MetaSoundViewModel.h  

void OnInputRemoved ( FName VertexName,
FName DataType
)

   ViewModels/MetaSoundViewModel.h  

void OnOutputAdded ( FName VertexName,
FName DataType
)

   ViewModels/MetaSoundViewModel.h  

void OnOutputDataTypeChanged ( FName VertexName,
FName DataType
)

   ViewModels/MetaSoundViewModel.h  

void OnOutputIsConstructorPinChanged ( FName VertexName,
bool bIsConstructorPin
)

   ViewModels/MetaSoundViewModel.h  

void OnOutputNameChanged ( FName OldName,
FName NewName
)

   ViewModels/MetaSoundViewModel.h  

void OnOutputRemoved ( FName VertexName,
FName DataType
)

   ViewModels/MetaSoundViewModel.h  

virtual void Reset()

 Resets this MetaSoundViewModel instance to an uninitialized state. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • Category="Audio|MetaSound Viewmodel"

void SetInputDataType ( const FName& InputName,
const FName& DataType
) const

   ViewModels/MetaSoundViewModel.h  

void SetInputDefaultLiteral ( const FName& InputName,
const FMetasoundFrontendLiteral& DefaultLiteral
) const

   ViewModels/MetaSoundViewModel.h  

void SetInputIsConstructorPin ( const FName& InputName,
bool bIsConstructorPin
) const

   ViewModels/MetaSoundViewModel.h  

void SetInputName ( const FName& OldName,
const FName& NewName
) const

   ViewModels/MetaSoundViewModel.h  

void SetInputOverridesDefault ( const FName& InputName,
bool bOverridesDefault
) const

   ViewModels/MetaSoundViewModel.h  

void SetIsInitialized ( const bool bInIsInitialized
)

   ViewModels/MetaSoundViewModel.h  

void SetOutputDataType ( const FName& OutputName,
const FName& DataType
) const

   ViewModels/MetaSoundViewModel.h  

void SetOutputIsConstructorPin ( const FName& OutputName,
bool bIsConstructorPin
) const

   ViewModels/MetaSoundViewModel.h  

void SetOutputName ( const FName& OldName,
const FName& NewName
) const

   ViewModels/MetaSoundViewModel.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual UMetaSoundInputViewModel * CreateInputViewModel ( const FMetasoundFrontendClassInput& InInput
)

   ViewModels/MetaSoundViewModel.h  

void CreateMemberViewModels()

   ViewModels/MetaSoundViewModel.h  

virtual UMetaSoundOutputViewModel * CreateOutputViewModel ( const FMetasoundFrontendClassOutput& InOutput
)

   ViewModels/MetaSoundViewModel.h  

virtual TSubclassOf< UMetaSoundInputViewModel > GetInputViewModelClass()

   ViewModels/MetaSoundViewModel.h  

virtual TSubclassOf< UMetaSoundOutputViewModel > GetOutputViewModelClass()

   ViewModels/MetaSoundViewModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page