Files
UnrealEngineUWP/Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundFrontendSearchEngine.h
phil popp a70bef2673 Keep metasound search engine warm
- Adds a "Prime" call to the MetasoundSearchEngine so we can precache a bunch of queries.
- Adds more metasound traces
- Encapsulates queries into structs to avoid a bunch of boilerplate code everywhere.
#rb Rob.Gay
#jira UE-132803
#preflight 61afe61ae01bc44973df5e30

#ROBOMERGE-AUTHOR: phil.popp
#ROBOMERGE-SOURCE: CL 18401520 in //UE5/Release-5.0/... via CL 18401531
#ROBOMERGE-BOT: STARSHIP (Release-Engine-Staging -> Release-Engine-Test) (v896-18170469)

[CL 18401537 by phil popp in ue5-release-engine-test branch]
2021-12-07 18:37:04 -05:00

57 lines
2.2 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();
/** Updates internal state to speed up queries. */
virtual void Prime() = 0;
/** 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 FMetasoundFrontendClassName& 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 FMetasoundFrontendClassName& 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 FMetasoundFrontendClassName& InName, int32 InMajorVersion, FMetasoundFrontendClass& OutClass) = 0;
virtual TArray<FMetasoundFrontendInterface> FindAllInterfaces(bool bInIncludeDeprecated = false) = 0;
virtual TArray<FMetasoundFrontendInterface> FindUClassDefaultInterfaces(FName InUClassName) = 0;
virtual TArray<FMetasoundFrontendVersion> FindAllRegisteredInterfacesWithName(FName InInterfaceName) = 0;
virtual bool FindInterfaceWithHighestVersion(FName InInterfaceName, FMetasoundFrontendInterface& OutInterface) = 0;
virtual ~ISearchEngine() = default;
protected:
ISearchEngine() = default;
};
}
}