IStageDataProvider.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Features/IModularFeature.h"
#include "Features/IModularFeatures.h"
 
#include "CoreMinimal.h"
#include "Misc/App.h"
#include "StageMessages.h"
 
namespace UE::StageProviderUtils
{
    static const FQualifiedFrameTime InvalidTime = FQualifiedFrameTime(FFrameTime(FFrameNumber(-1)), FFrameRate(-1, -1));
}
 
struct FStageDataBaseMessage;
 
class STAGEDATACORE_API IStageDataProvider : public IModularFeature
{
public:
    virtual ~IStageDataProvider() {}
 
    static FName ModularFeatureName;
 
    //~ Begin static methods for data provider users
 
public:
 
    template<typename MessageType, typename... Args>
    static bool SendMessage(EStageMessageFlags Flags, Args&&... args)
    {
#if ENABLE_STAGEMONITOR_LOGGING
        MessageType TempObj(Forward<Args>(args)...);
        return SendMessage(MoveTempIfPossible(TempObj), Flags);
#endif
 
        return false;
    }
 
    template<typename MessageType, typename... Args>
    static bool SendMessage(EStageMessageFlags Flags, MessageType& Message)
    {
#if ENABLE_STAGEMONITOR_LOGGING
        return SendMessage(Forward<MessageType>(Message), Flags);
#endif
 
        return false;
    }
 
    template<typename MessageType, typename... Args>
    static bool SendMessage(EStageMessageFlags Flags, MessageType&& Message)
    {
#if ENABLE_STAGEMONITOR_LOGGING
        return SendMessage(Forward<MessageType>(Message), Flags);
#else
        return false;
#endif
    }
 
private:
 
    template<typename MessageType>
    static bool SendMessage(MessageType&& Message, EStageMessageFlags InFlags)
    {
        //To simply API, modular feature checkup is hidden here. Could add preprocessors to disable this entirel
        IModularFeatures& ModularFeatures = IModularFeatures::Get();
        if (ModularFeatures.IsModularFeatureAvailable(IStageDataProvider::ModularFeatureName))
        {
            IStageDataProvider* StageDataProvider = &IModularFeatures::Get().GetModularFeature<IStageDataProvider>(IStageDataProvider::ModularFeatureName);
 
            static_assert(TIsDerivedFrom<MessageType, FStageProviderEventMessage>::IsDerived || TIsDerivedFrom<MessageType, FStageProviderPeriodicMessage>::IsDerived, "MessageType must be a FStageProviderEventMessage or FStageProviderPeriodicMessage derived UStruct.");
 
            // Timestamp the outgoing message.
            TOptional<FQualifiedFrameTime> CurrentFrameTime = FApp::GetCurrentFrameTime();
            Message.DateTime = FDateTime::Now();
 
            if (CurrentFrameTime.IsSet())
            {
                Message.FrameTime = CurrentFrameTime.GetValue();
            }
            else
            {
                Message.FrameTime = UE::StageProviderUtils::InvalidTime;
            }
 
            return StageDataProvider->SendMessageInternal(&Message, MessageType::StaticStruct(), InFlags);
        }
 
        return false;
    }
 
    //~ End static methods for data provider users
 
protected:
 
    virtual bool SendMessageInternal(FStageDataBaseMessage* Payload, UScriptStruct* Type, EStageMessageFlags InFlags) = 0;
};