Files
UnrealEngineUWP/Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundNodeRegistrationMacro.h
phil popp 8cab75d4da Hide and disable unneeded types and nodes
- Added enable structs for arrays, auto conversions, send/receive to opt-out when desired.
- Lots of header include fixes to get build working.
- Comment out "int64" and "double" registered data types
#jira UE-112303
#rb Jimmy.Smith
#preflight 606b9c22458ce6000159e16c
#lockdown Nick.Whiting

#ROBOMERGE-SOURCE: CL 15925325 in //UE5/Release-5.0-EarlyAccess/...
#ROBOMERGE-BOT: STARSHIP (Release-5.0-EarlyAccess -> Main) (v786-15839533)

[CL 15925330 by phil popp in ue5-main branch]
2021-04-05 20:22:19 -04:00

75 lines
3.3 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "MetasoundFrontend.h"
#include "MetasoundFrontendDocument.h"
#include "MetasoundFrontendRegistries.h"
#include "MetasoundLog.h"
#include "MetasoundNodeInterface.h"
namespace Metasound
{
// Utility class to ensure that a node class can use the constructor the frontend uses.
template <typename NodeClass>
struct ConstructorTakesNodeInitData {
// Use SFINAE trick to see if we have a valid constructor:
template<typename T>
static uint16 TestForConstructor(decltype(T(::Metasound::FNodeInitData()))*);
template<typename T>
static uint8 TestForConstructor(...);
static const bool Value = sizeof(TestForConstructor<NodeClass>(nullptr)) == sizeof(uint16);
};
template <typename FNodeType>
bool RegisterNodeWithFrontend(const Metasound::FNodeClassMetadata& InMetadata)
{
// if we reenter this code (because DECLARE_METASOUND_DATA_REFERENCE_TYPES was called twice with the same type),
// we catch it here.
static bool bAlreadyRegisteredThisDataType = false;
if (bAlreadyRegisteredThisDataType)
{
UE_LOG(LogMetaSound, Display, TEXT("Tried to call METASOUND_REGISTER_NODE twice with the same class. ignoring the second call. Likely because METASOUND_REGISTER_NODE is in a header that's used in multiple modules. Consider moving it to a private header or cpp file."));
return false;
}
bAlreadyRegisteredThisDataType = true;
bool bSuccessfullyRegisteredNode = FMetasoundFrontendRegistryContainer::Get()->RegisterExternalNode(
[](const Metasound::FNodeInitData& InInitData) -> TUniquePtr<Metasound::INode>
{
return TUniquePtr<Metasound::INode>(new FNodeType(InInitData));
},
[=]() -> FMetasoundFrontendClass
{
return Metasound::Frontend::GenerateClassDescription(InMetadata);
}
);
ensureAlwaysMsgf(bSuccessfullyRegisteredNode, TEXT("Registering node class failed. Please check the logs."));
return bSuccessfullyRegisteredNode;
}
template <typename FNodeType>
bool RegisterNodeWithFrontend()
{
// Register a node using a prototype node.
// TODO: may want to add a warning here since we don't want to use this registration pathway.
Metasound::FNodeInitData InitData;
TUniquePtr<Metasound::INode> Node = MakeUnique<FNodeType>(InitData);
return RegisterNodeWithFrontend<FNodeType>(Node->GetMetadata());
}
}
// TODO: should remove this and force folks to use module startup/shutdown module system.
#define METASOUND_REGISTER_NODE(NodeClass, ...) \
static_assert(std::is_base_of<::Metasound::INodeBase, NodeClass>::value, "To be registered as a Metasound Node," #NodeClass "need to be a derived class from Metasound::INodeBase, Metasound::INode, or Metasound::FNode."); \
static_assert(::Metasound::ConstructorTakesNodeInitData<NodeClass>::Value, "In order to be registered as a Metasound Node, " #NodeClass " needs to implement the following public constructor: " #NodeClass "(const Metasound::FNodeInitData& InInitData);"); \
static bool bSuccessfullyRegistered##NodeClass = FMetasoundFrontendRegistryContainer::Get()->EnqueueInitCommand([](){ ::Metasound::RegisterNodeWithFrontend<NodeClass>(__VA_ARGS__); }); // This static bool is useful for debugging, but also is the only way the compiler will let us call this function outside of an expression.