You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
bb284960b2
#rb rob.gay #preflight 62057365a155a4cddac5bf1d #jira UE-142194 #ROBOMERGE-AUTHOR: helen.yang #ROBOMERGE-SOURCE: CL 18945030 in //UE5/Release-5.0/... via CL 18945230 via CL 18946167 #ROBOMERGE-BOT: UE5 (Release-Engine-Test -> Main) (v917-18934589) [CL 18946312 by helen yang in ue5-main branch]
109 lines
4.7 KiB
C++
109 lines
4.7 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "MetasoundArrayNodesRegistration.h"
|
|
#include "MetasoundDataReference.h"
|
|
#include "MetasoundEnum.h"
|
|
#include "MetasoundDataTypeRegistrationMacro.h"
|
|
|
|
namespace Metasound
|
|
{
|
|
// Enable registration of converter nodes which convert from int32 to enums
|
|
template<typename FromDataType, typename EnumType, EnumType DefaultValue>
|
|
struct TEnableAutoConverterNodeRegistration<FromDataType, TEnum<EnumType, DefaultValue>>
|
|
{
|
|
static constexpr bool Value = std::is_same<int32, FromDataType>::value;
|
|
};
|
|
|
|
// Enable registration of converter nodes which convert from enums to int32
|
|
template<typename ToDataType, typename EnumType, EnumType DefaultValue>
|
|
struct TEnableAutoConverterNodeRegistration<TEnum<EnumType, DefaultValue>, ToDataType>
|
|
{
|
|
static constexpr bool Value = std::is_same<int32, ToDataType>::value;
|
|
};
|
|
|
|
// Disable arrays of enums
|
|
template<typename EnumType, EnumType DefaultValue>
|
|
struct TEnableAutoArrayTypeRegistration<TEnum<EnumType, DefaultValue>>
|
|
{
|
|
static constexpr bool Value = false;
|
|
};
|
|
|
|
// Disable array nodes of enums
|
|
template<typename EnumType, EnumType DefaultValue>
|
|
struct TEnableArrayNodes<TEnum<EnumType, DefaultValue>>
|
|
{
|
|
static constexpr bool Value = false;
|
|
};
|
|
|
|
// Specialization of TIsTransmittable<> to disable transmission of enums.
|
|
template<typename EnumType, EnumType DefaultValue>
|
|
struct TEnableTransmissionNodeRegistration<TEnum<EnumType, DefaultValue>>
|
|
{
|
|
public:
|
|
static constexpr bool Value = false;
|
|
};
|
|
}
|
|
|
|
// Helper macros: for defining/declaring a new Enum to be used in Metasounds.
|
|
// * Declares/defines a typedef FEnum<YourEnum> wrapper around the enum that you pass it
|
|
// * Declares/defines a specialization of TEnumStringHelper which is used to validate and convert between values/names.
|
|
|
|
// These helps generate a couple of boiler plate functions:
|
|
// - GetNamespace() which will return the name of the Enum "EMyEnum" etc.
|
|
// - GetAllEntries() which returns all posible entries in the enum.
|
|
|
|
/** DECLARE_METASOUND_ENUM
|
|
* @param ENUMNAME - The typename of your EnumType you want to use for Metasounds. e.g. MyEnum
|
|
* @param DEFAULT - A fully qualified default Enum value. e.g. EMyEnum::One
|
|
* @param API - The module API this is declared inside e.g. METASOUNDSTANDARDNODES_API
|
|
* @param ENUMTYPEDEF - The name of the TEnum<YourType> wrapper type
|
|
* @param TYPEINFO - The name of the TypeInfo type you want to define e.g. FMyEnumTypeInfo
|
|
* @param READREF - The name of the Read Reference type you want to define. e.g FMyEnumReadRef
|
|
* @param WRITEREF -The name of the Write Reference type you want to define e.g. FMyEnumWriteRef
|
|
*/
|
|
#define DECLARE_METASOUND_ENUM(ENUMNAME, DEFAULT, API, ENUMTYPEDEF, TYPEINFO, READREF, WRITEREF)\
|
|
using ENUMTYPEDEF = Metasound::TEnum<ENUMNAME, DEFAULT>; \
|
|
DECLARE_METASOUND_DATA_REFERENCE_TYPES(ENUMTYPEDEF, API, TYPEINFO, READREF, WRITEREF);\
|
|
template<> struct API Metasound::TEnumStringHelper<ENUMNAME> : Metasound::TEnumStringHelperBase<Metasound::TEnumStringHelper<ENUMNAME>, ENUMNAME>\
|
|
{\
|
|
static FName GetNamespace()\
|
|
{\
|
|
static const FName ThisName { TEXT(#ENUMNAME) };\
|
|
return ThisName;\
|
|
}\
|
|
static TArrayView<const Metasound::TEnumEntry<ENUMNAME>> GetAllEntries();\
|
|
};
|
|
|
|
/** DEFINE_METASOUND_ENUM_BEGIN
|
|
* @param ENUMNAME - The typename of your raw EnumType you want to use for Metasounds. e.g. EMyType
|
|
* @param ENUMTYPEDEF - The name of the TEnum<YourType> wrapper type
|
|
* @param DATATYPENAMESTRING - The string that will the data type name "Enum:<string>" e.g. "MyEnum"
|
|
*/
|
|
#define DEFINE_METASOUND_ENUM_BEGIN(ENUMNAME,ENUMTYPEDEF,DATATYPENAMESTRING)\
|
|
REGISTER_METASOUND_DATATYPE(ENUMTYPEDEF, "Enum:" DATATYPENAMESTRING, ::Metasound::ELiteralType::Integer);\
|
|
TArrayView<const Metasound::TEnumEntry<ENUMNAME>> Metasound::TEnumStringHelper<ENUMNAME>::GetAllEntries()\
|
|
{\
|
|
static const Metasound::TEnumEntry<ENUMNAME> Entries[] = {
|
|
|
|
/** DEFINE_METASOUND_ENUM_ENTRY - defines a single Enum Entry
|
|
* @param ENTRY - Fully Qualified Name of Entry of the Enum. (e.g. EMyType::One)
|
|
* @param DISPLAYNAME_KEY - Display Name loc key
|
|
* @param DISPLAYNAME - Display Name text presented to User
|
|
* @param TOOLTIP_KEY - Tooltip loc key
|
|
* @param TOOLTIP - Tooltip text
|
|
*/
|
|
#if WITH_EDITOR
|
|
#define DEFINE_METASOUND_ENUM_ENTRY(ENTRY, DISPLAYNAME_KEY, DISPLAYNAME, TOOLTIP_KEY, TOOLTIP) { ENTRY, TEXT(#ENTRY), LOCTEXT(DISPLAYNAME_KEY, DISPLAYNAME), LOCTEXT(TOOLTIP_KEY, TOOLTIP) }
|
|
#else
|
|
#define DEFINE_METASOUND_ENUM_ENTRY(ENTRY, DISPLAYNAME_KEY, DISPLAYNAME, TOOLTIP_KEY, TOOLTIP) { ENTRY, TEXT(#ENTRY), FText::GetEmpty(), FText::GetEmpty() }
|
|
#endif // WITH_EDITOR
|
|
|
|
/** DEFINE_METASOUND_ENUM_END - macro which ends the function body of the GetAllEntries function
|
|
*/
|
|
#define DEFINE_METASOUND_ENUM_END() \
|
|
};\
|
|
return Entries;\
|
|
};
|