ILiveLinkSubject.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "CoreMinimal.h"
#include "LiveLinkFrameTranslator.h"
#include "LiveLinkRole.h"
#include "LiveLinkSubjectRemapper.h"
#include "LiveLinkTypes.h"
#include "Templates/SubclassOf.h"
 
struct FLiveLinkAnimationFrameData;
struct FLiveLinkSkeletonStaticData;
class ILiveLinkClient;
class ULiveLinkFrameInterpolationProcessor;
class ULiveLinkFramePreProcessor;
class ULiveLinkRole;
 
class ILiveLinkSubject
{
public:
    virtual ~ILiveLinkSubject() {}
    virtual void Initialize(FLiveLinkSubjectKey SubjectKey, TSubclassOf<ULiveLinkRole> Role, ILiveLinkClient* LiveLinkClient) = 0;
    virtual void Update() = 0;
    LIVELINKINTERFACE_API virtual bool EvaluateFrame(TSubclassOf<ULiveLinkRole> InDesiredRole, FLiveLinkSubjectFrameData& OutFrame);
    virtual void ClearFrames() = 0;
 
    virtual FLiveLinkSubjectKey GetSubjectKey() const = 0;
    virtual TSubclassOf<ULiveLinkRole> GetRole() const = 0;
    LIVELINKINTERFACE_API virtual bool SupportsRole(TSubclassOf<ULiveLinkRole> InDesiredRole) const;
 
    virtual bool HasValidFrameSnapshot() const = 0;
    virtual FLiveLinkStaticDataStruct& GetStaticData(bool bGetOverrideData=true) = 0;
    virtual const FLiveLinkStaticDataStruct& GetStaticData() const = 0;
    virtual TArray<FLiveLinkTime> GetFrameTimes() const = 0;
 
    virtual const TArray<ULiveLinkFrameTranslator::FWorkerSharedPtr> GetFrameTranslators() const = 0;
 
    virtual const ULiveLinkSubjectRemapper::FWorkerSharedPtr GetFrameRemapper() const = 0;
 
    virtual bool IsRebroadcasted() const = 0;
 
    virtual bool HasStaticDataBeenRebroadcasted() const = 0;
 
    virtual void SetStaticDataAsRebroadcasted(const bool bInSent) = 0;
 
    UE_DEPRECATED(5.6, "Replaced with a new version of PreprocessFrame that also provides const static data.")
    virtual void PreprocessFrame(FLiveLinkFrameDataStruct& InOutFrameData) {};
 
    virtual void PreprocessFrame(const FLiveLinkStaticDataStruct& InStaticData, FLiveLinkFrameDataStruct& InOutFrameData) {};
 
    virtual void RemapFrame(FLiveLinkSkeletonStaticData& InOutSkeletonData, FLiveLinkAnimationFrameData& InOutFrameData) {}
    
    virtual bool IsPaused() const = 0;
 
    virtual void PauseSubject() = 0;
 
    virtual void UnpauseSubject() = 0;
 
    FLiveLinkFrameIdentifier GetSnapshotFrameId() const
    {
        if (HasValidFrameSnapshot())
        {
            return GetFrameSnapshot().FrameData.GetBaseData()->FrameId;
        }
        return INDEX_NONE;
    }
 
protected:
    virtual const FLiveLinkSubjectFrameData& GetFrameSnapshot() const = 0;
 
protected:
    static LIVELINKINTERFACE_API bool Translate(const ILiveLinkSubject* LinkSubject, TSubclassOf<ULiveLinkRole> DesiredRole, const FLiveLinkStaticDataStruct& StaticData, const FLiveLinkFrameDataStruct& FrameData, FLiveLinkSubjectFrameData& OutFrame);
};