Files
UnrealEngineUWP/Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendSearchEngine.h
phil popp 4c942021ae Creating metasound archetype registry and upgrade path
#rb Rob.Gay


#ROBOMERGE-SOURCE: CL 16766481
#ROBOMERGE-BOT: (v835-16672529)

[CL 16766487 by phil popp in ue5-main branch]
2021-06-23 20:07:53 -04:00

54 lines
2.1 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "MetasoundFrontendArchetypeRegistry.h"
#include "MetasoundFrontendDocument.h"
#include "MetasoundNodeInterface.h"
namespace Metasound
{
namespace Frontend
{
/** Interface for frontend search engine. A frontend search engine provides
* a simple interface for common frontend queries. It also serves as an
* opportunity to cache queries to reduce CPU load.
*/
class METASOUNDFRONTEND_API ISearchEngine
{
public:
/** Return an instance of a search engine. */
static ISearchEngine& Get();
/** Find all FMetasoundFrontendClasses.
* (Optional) Include deprecated classes (i.e. versions of classes that are not the highest major version).
*/
virtual TArray<FMetasoundFrontendClass> FindAllClasses(bool bInIncludeDeprecated) = 0;
/** Find all classes with the given ClassName.
* (Optional) Sort matches based on version.
*/
virtual TArray<FMetasoundFrontendClass> FindClassesWithName(const FNodeClassName& InName, bool bInSortByVersion) = 0;
/** Find the highest version of a class with the given ClassName. Returns false if not found, true if found. */
virtual bool FindClassWithHighestVersion(const FNodeClassName& InName, FMetasoundFrontendClass& OutClass) = 0;
/** Find the class with the given ClassName & Major Version. Returns false if not found, true if found. */
virtual bool FindClassWithMajorVersion(const FNodeClassName& InName, int32 InMajorVersion, FMetasoundFrontendClass& OutClass) = 0;
virtual TArray<FMetasoundFrontendArchetype> FindAllArchetypes(bool bInIncludeDeprecated=false) = 0;
virtual TArray<FMetasoundFrontendVersion> FindAllRegisteredArchetypesWithName(const FName& InArchetypeName) = 0;
virtual bool FindArchetypeWithHighestVersion(const FName& InArchetypeName, FMetasoundFrontendArchetype& OutArchetype) = 0;
virtual bool FindArchetypeWithMajorVersion(const FName& InArchetypeName, int32 InMajorVersion, FMetasoundFrontendArchetype& OutArchetype) = 0;
virtual ~ISearchEngine() = default;
protected:
ISearchEngine() = default;
};
}
}