TypedElementInterfaceCustomization.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Elements/Framework/TypedElementLimits.h"
#include "HAL/Platform.h"
#include "Misc/AssertionMacros.h"
#include "Templates/UniquePtr.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/NameTypes.h"
 
class FTypedElementInterfaceCustomizationRegistryBase
{
public:
    virtual ~FTypedElementInterfaceCustomizationRegistryBase() = default;
 
protected:
    TYPEDELEMENTRUNTIME_API FTypedHandleTypeId GetElementTypeIdFromName(const FName InElementTypeName) const;
 
    TYPEDELEMENTRUNTIME_API FTypedHandleTypeId GetElementTypeIdFromNameChecked(const FName InElementTypeName) const;
};
 
template <typename CustomizationBaseType, typename DefaultCustomizationType = CustomizationBaseType>
class TTypedElementInterfaceCustomizationRegistry : public FTypedElementInterfaceCustomizationRegistryBase
{
public:
    template <typename... TDefaultArgs>
    TTypedElementInterfaceCustomizationRegistry(TDefaultArgs&&... DefaultArgs)
        : DefaultInterfaceCustomization(MakeUnique<DefaultCustomizationType>(Forward<TDefaultArgs>(DefaultArgs)...))
    {
    }
 
    virtual ~TTypedElementInterfaceCustomizationRegistry() = default;
 
    TTypedElementInterfaceCustomizationRegistry(const TTypedElementInterfaceCustomizationRegistry&) = delete;
    TTypedElementInterfaceCustomizationRegistry& operator=(const TTypedElementInterfaceCustomizationRegistry&) = delete;
 
    TTypedElementInterfaceCustomizationRegistry(TTypedElementInterfaceCustomizationRegistry&&) = delete;
    TTypedElementInterfaceCustomizationRegistry& operator=(TTypedElementInterfaceCustomizationRegistry&&) = delete;
 
    void SetDefaultInterfaceCustomization(TUniquePtr<CustomizationBaseType>&& InInterfaceCustomization)
    {
        checkf(InInterfaceCustomization, TEXT("Default interface customization cannot be null!"));
        DefaultInterfaceCustomization = MoveTemp(InInterfaceCustomization);
    }
 
    CustomizationBaseType* GetDefaultInterfaceCustomization() const
    {
        return DefaultInterfaceCustomization.Get();
    }
 
    void RegisterInterfaceCustomizationByTypeName(const FName InElementTypeName, TUniquePtr<CustomizationBaseType>&& InInterfaceCustomization)
    {
        RegisterInterfaceCustomizationByTypeId(GetElementTypeIdFromNameChecked(InElementTypeName), MoveTemp(InInterfaceCustomization));
    }
 
    void RegisterInterfaceCustomizationByTypeId(const FTypedHandleTypeId InElementTypeId, TUniquePtr<CustomizationBaseType>&& InInterfaceCustomization)
    {
        RegisteredInterfaceCustomizations[InElementTypeId - 1] = MoveTemp(InInterfaceCustomization);
    }
 
    void UnregisterInterfaceCustomizationByTypeName(const FName InElementTypeName)
    {
        UnregisterInterfaceCustomizationByTypeId(GetElementTypeIdFromNameChecked(InElementTypeName));
    }
 
    void UnregisterInterfaceCustomizationByTypeId(const FTypedHandleTypeId InElementTypeId)
    {
        RegisteredInterfaceCustomizations[InElementTypeId - 1].Reset();
    }
 
    CustomizationBaseType* GetInterfaceCustomizationByTypeName(const FName InElementTypeName, const bool bAllowFallback = true) const
    {
        return GetInterfaceCustomizationByTypeId(GetElementTypeIdFromNameChecked(InElementTypeName), bAllowFallback);
    }
 
    CustomizationBaseType* GetInterfaceCustomizationByTypeId(const FTypedHandleTypeId InElementTypeId, const bool bAllowFallback = true) const
    {
        CustomizationBaseType* InterfaceCustomization = RegisteredInterfaceCustomizations[InElementTypeId - 1].Get();
        return InterfaceCustomization
            ? InterfaceCustomization
            : bAllowFallback 
                ? DefaultInterfaceCustomization.Get()
                : nullptr;
    }
 
private:
    TUniquePtr<CustomizationBaseType> DefaultInterfaceCustomization;
 
    TUniquePtr<CustomizationBaseType> RegisteredInterfaceCustomizations[TypedHandleMaxTypeId - 1];
};