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 (DisplayName="MetaSound Viewmodel")  
class UMetaSoundViewModel : public UMVVMViewModelBase

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsInitialized bool True if this MetaSound Viewmodel has been initialized. ViewModels/MetaSoundViewModel.h
  • BlueprintReadOnly
  • FieldNotify
  • Category="MetaSound Viewmodel"
  • Meta=(AllowPrivateAccess)
bIsPreset bool True if the initialized MetaSound is a preset. ViewModels/MetaSoundViewModel.h
  • BlueprintReadOnly
  • FieldNotify
  • Category="MetaSound Viewmodel"
  • Meta=(AllowPrivateAccess)

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMetaSoundBuilderBase * GetBuilder()

 Returns a reference to the initialized MetaSound's Builder. ViewModels/MetaSoundViewModel.h
  • BlueprintCallable
  • Category="Audio|MetaSound Viewmodel"

FText GetBuilderNameAsText()

 Returns the object name of the initialized builder as text. 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  

virtual void Reset()

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

void SetIsInitialized ( const bool bInIsInitialized
)

   ViewModels/MetaSoundViewModel.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CreateInputViewModel ( const FMetasoundFrontendClassInput& InInput
)

 Creates a single MetaSoundInputViewModel instance for the given input. ViewModels/MetaSoundViewModel.h  

virtual UMetaSoundInputViewModel * CreateInputViewModelInstance()

   ViewModels/MetaSoundViewModel.h  

void CreateMemberViewModels()

 Called upon initialization. Creates viewmodel instances for all inputs and outputs of the initialized MetaSound. ViewModels/MetaSoundViewModel.h  

void CreateOutputViewModel ( const FMetasoundFrontendClassOutput& InOutput
)

 Creates a single MetaSoundOutputViewModel instance for the given output. ViewModels/MetaSoundViewModel.h  

virtual UMetaSoundOutputViewModel * CreateOutputViewModelInstance()

   ViewModels/MetaSoundViewModel.h  

virtual void InitializeProperties ( const FMetasoundFrontendDocument& FrontendDocument
)

   ViewModels/MetaSoundViewModel.h  

virtual void ResetProperties()

   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