IModularFeatures.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Array.h"
#include "UObject/NameTypes.h"
#include "Delegates/Delegate.h"
#include "IModularFeature.h"
 
class IModularFeatures
{
 
public:
 
    static CORE_API IModularFeatures& Get();
 
    virtual ~IModularFeatures()
    {
    }
 
 
    inline bool IsModularFeatureAvailable( const FName Type )
    {
        return GetModularFeatureImplementationCount( Type ) > 0;
    }
 
 
    template< typename TModularFeature >
    inline TModularFeature& GetModularFeature( const FName Type )
    {
        return static_cast<TModularFeature&>( *GetModularFeatureImplementation( Type, 0 ) );
    }
 
 
    template< typename TModularFeature >
    inline TArray< TModularFeature* > GetModularFeatureImplementations( const FName Type )
    {
        TArray< TModularFeature* > FeatureImplementations;
        const int32 NumImplementations = GetModularFeatureImplementationCount( Type );
        for( int32 CurImplementation = 0; CurImplementation < NumImplementations; ++CurImplementation )
        {
            FeatureImplementations.Add( static_cast<TModularFeature*>( GetModularFeatureImplementation( Type, CurImplementation ) ) );
        }
        return FeatureImplementations;
    }
 
 
public:
 
    virtual void LockModularFeatureList() = 0;
 
    virtual void UnlockModularFeatureList() = 0;
 
    struct FScopedLockModularFeatureList
    {
        inline FScopedLockModularFeatureList() { IModularFeatures::Get().LockModularFeatureList(); }
        inline ~FScopedLockModularFeatureList() { IModularFeatures::Get().UnlockModularFeatureList(); }
 
        // Non-copyable :
        FScopedLockModularFeatureList(const FScopedLockModularFeatureList&) = delete;
        FScopedLockModularFeatureList(FScopedLockModularFeatureList&&) = delete;
        FScopedLockModularFeatureList& operator = (const FScopedLockModularFeatureList&) = delete;
        FScopedLockModularFeatureList& operator = (FScopedLockModularFeatureList&&) = delete;
    };
 
    virtual int32 GetModularFeatureImplementationCount( const FName Type ) = 0;
 
    virtual class IModularFeature* GetModularFeatureImplementation( const FName Type, const int32 Index ) = 0;
 
    virtual void RegisterModularFeature( const FName Type, class IModularFeature* ModularFeature ) = 0;
 
 
    virtual void UnregisterModularFeature( const FName Type, class IModularFeature* ModularFeature ) = 0;
 
    DECLARE_EVENT_TwoParams(IModularFeatures, FOnModularFeatureRegistered, const FName& , class IModularFeature* /*ModularFeature*/);
    virtual FOnModularFeatureRegistered& OnModularFeatureRegistered() = 0;
 
    DECLARE_EVENT_TwoParams(IModularFeatures, FOnModularFeatureUnregistered, const FName& , class IModularFeature* /*ModularFeature*/);
    virtual FOnModularFeatureUnregistered& OnModularFeatureUnregistered() = 0;
};