Files
UnrealEngineUWP/Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Private/MetasoundFrontendDocumentController.h
helen yang 07268d51d2 MetaSound deterministic id generation
- Deterministic generation of ids for various FGuids used in MetaSound documents so that Autoupdate can be moved from runtime to cook in the future while maintaining cook determinism
- cvar for enabling in editor au.MetaSound.EnableDeterministicIDGenerationInEditorCVar

#jira UE-176939
#jira UE-176940
#rb phil.popp

[CL 26126897 by helen yang in ue5-main branch]
2023-06-20 13:12:39 -04:00

102 lines
3.8 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "MetasoundFrontendController.h"
#include "MetasoundFrontendDocument.h"
namespace Metasound
{
namespace Frontend
{
/** FDocumentController represents an entire Metasound document. */
class FDocumentController : public IDocumentController
{
public:
/** Construct a FDocumentController.
*
* @param InDocument - Document to be manipulated.
*/
FDocumentController(FDocumentAccessPtr InDocumentPtr);
/** Create a FDocumentController.
*
* @param InDocument - Document to be manipulated.
*
* @return A document handle.
*/
static FDocumentHandle CreateDocumentHandle(FDocumentAccessPtr InDocument)
{
return MakeShared<FDocumentController>(InDocument);
}
virtual ~FDocumentController() = default;
bool IsValid() const override;
const TArray<FMetasoundFrontendClass>& GetDependencies() const override;
void IterateDependencies(TFunctionRef<void(FMetasoundFrontendClass&)> InFunction) override;
void IterateDependencies(TFunctionRef<void(const FMetasoundFrontendClass&)> InFunction) const override;
const TArray<FMetasoundFrontendGraphClass>& GetSubgraphs() const override;
const FMetasoundFrontendGraphClass& GetRootGraphClass() const override;
void SetRootGraphClass(FMetasoundFrontendGraphClass&& InClass) override;
FConstClassAccessPtr FindDependencyWithID(FGuid InClassID) const override;
FConstGraphClassAccessPtr FindSubgraphWithID(FGuid InClassID) const override;
FConstClassAccessPtr FindClassWithID(FGuid InClassID) const override;
FConstClassAccessPtr FindClass(const FNodeRegistryKey& InKey) const override;
FConstClassAccessPtr FindClass(const FMetasoundFrontendClassMetadata& InMetadata) const override;
FConstClassAccessPtr FindOrAddClass(const FNodeRegistryKey& InKey, bool bInRefreshFromRegistry) override;
FConstClassAccessPtr FindOrAddClass(const FMetasoundFrontendClassMetadata& InMetadata) override;
FGraphHandle AddDuplicateSubgraph(const IGraphController& InGraph) override;
const TSet<FMetasoundFrontendVersion>& GetInterfaceVersions() const override;
void AddInterfaceVersion(const FMetasoundFrontendVersion& InVersion) override;
void RemoveInterfaceVersion(const FMetasoundFrontendVersion& InVersion) override;
void ClearInterfaceVersions() override;
void SetMetadata(const FMetasoundFrontendDocumentMetadata& InMetadata) override;
const FMetasoundFrontendDocumentMetadata& GetMetadata() const override;
FMetasoundFrontendDocumentMetadata* GetMetadata() override;
void RemoveUnreferencedDependencies() override;
TArray<FConstClassAccessPtr> SynchronizeDependencyMetadata() override;
FGraphHandle GetRootGraph() override;
FConstGraphHandle GetRootGraph() const override;
FDocumentAccessPtr GetDocumentPtr() override;
const FDocumentAccessPtr GetDocumentPtr() const override;
/** Returns an array of all subgraphs for this document. */
TArray<FGraphHandle> GetSubgraphHandles() override;
/** Returns an array of all subgraphs for this document. */
TArray<FConstGraphHandle> GetSubgraphHandles() const override;
/** Returns a graphs in the document with the given class ID.*/
FGraphHandle GetSubgraphWithClassID(FGuid InClassID) override;
/** Returns a graphs in the document with the given class ID.*/
FConstGraphHandle GetSubgraphWithClassID(FGuid InClassID) const override;
bool ExportToJSONAsset(const FString& InAbsolutePath) const override;
FString ExportToJSON() const override;
protected:
FDocumentAccess ShareAccess() override;
FConstDocumentAccess ShareAccess() const override;
private:
bool AddDuplicateSubgraph(const FMetasoundFrontendGraphClass& InGraphToCopy, const FMetasoundFrontendDocument& InOtherDocument);
FDocumentAccessPtr DocumentPtr;
};
}
}