unreal.MetaSoundViewModel

class unreal.MetaSoundViewModel(outer: Object | None = None, name: Name | str = 'None')

Bases: MVVMViewModelBase

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.

C++ Source:

• Plugin: TechAudioTools

• Module: TechAudioToolsMetaSound

• File: MetaSoundViewModel.h

Editor Properties: (see get_editor_property/set_editor_property)

• is_initialized (bool): [Read-Write] True if this MetaSound Viewmodel has been initialized.

• is_preset (bool): [Read-Write] True if the initialized MetaSound is a preset.

get_builder() → MetaSoundBuilderBase

Returns a reference to the initialized MetaSound’s Builder.

Return type:

MetaSoundBuilderBase

get_builder_name_as_text() → Text

Returns the object name of the initialized builder as text.

Return type:

Text

get_input_view_models() → Array[MetaSoundInputViewModel]

Contains MetaSound Input Viewmodels for each input of the initialized MetaSound.

Return type:

Array[MetaSoundInputViewModel]

get_output_view_models() → Array[MetaSoundOutputViewModel]

Contains MetaSound Output ViewModels for each output of the initialized MetaSound.

Return type:

Array[MetaSoundOutputViewModel]

initialize(builder) → None

Initializes the viewmodel using the given builder.

Parameters:

builder (MetaSoundBuilderBase)

initialize_meta_sound(meta_sound) → None

Initializes the viewmodel using the given MetaSound asset.

Parameters:

meta_sound (MetaSoundDocumentInterface)

property is_initialized: bool

[Read-Only] True if this MetaSound Viewmodel has been initialized.

Type:

(bool)

property is_preset: bool

[Read-Only] True if the initialized MetaSound is a preset.

Type:

(bool)

reset() → None

Resets this MetaSoundViewModel instance to an uninitialized state.