Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
Builder Document UObject, which is only used for registration purposes when attempting async registration whereby the original document is serialized and must not be mutated.
| Name | UMetaSoundBuilderDocument |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendDocumentBuilder.h |
| Include Path | #include "MetasoundFrontendDocumentBuilder.h" |
Syntax
UCLASS (MinimalAPI)
class UMetaSoundBuilderDocument :
public UObject ,
public IMetaSoundDocumentInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMetaSoundBuilderDocument
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMetaSoundBuilderDocument
(
const FObjectInitializer& ObjectInitializer |
MetasoundFrontendDocumentBuilder.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BuilderUClass | TObjectPtr< const UClass > | MetasoundFrontendDocumentBuilder.h |
|
|
| Document | FMetasoundFrontendDocument | MetasoundFrontendDocumentBuilder.h |
|
|
| MetaSoundUClass | TObjectPtr< const UClass > | MetasoundFrontendDocumentBuilder.h |
|
Functions
Public
Overridden from IMetaSoundDocumentInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ConformObjectToDocument () |
Conforms UProperty data outside the Frontend Document Model to the document's data. | MetasoundFrontendDocumentBuilder.h | |
virtual FTopLevelAssetPath GetAssetPathChecked() |
Returns temp path of builder document. | MetasoundFrontendDocumentBuilder.h | |
virtual const UClass & GetBaseMetaSoundUClass() |
Returns the base class registered with the MetaSound UObject registry. | MetasoundFrontendDocumentBuilder.h | |
virtual const UClass & GetBuilderUClass() |
Returns the builder class used to modify the given document. | MetasoundFrontendDocumentBuilder.h | |
virtual const FMetasoundFrontendDocument & GetConstDocument() |
Returns the document. | MetasoundFrontendDocumentBuilder.h | |
virtual EMetasoundFrontendClassAccessFlags GetDefaultAccessFlags() |
Returns the default access flags utilized when document is initialized. | MetasoundFrontendDocumentBuilder.h | |
virtual bool IsActivelyBuilding() |
Returns if the document is being actively built (always true as builder documents are always being actively built) | MetasoundFrontendDocumentBuilder.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UMetaSoundBuilderDocument & Create
(
const UClass& InBuilderClass |
MetasoundFrontendDocumentBuilder.h | ||
static UMetaSoundBuilderDocument & Create
(
const IMetaSoundDocumentInterface& InDocToCopy |
Create and return a valid builder document which copies the provided interface's document & class. | MetasoundFrontendDocumentBuilder.h |