MovieSceneEvaluationTrack.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Compilation/MovieSceneSegmentCompiler.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "CoreMinimal.h"
#include "Evaluation/MovieSceneEvalTemplate.h"
#include "Evaluation/MovieSceneEvaluationField.h"
#include "Evaluation/MovieScenePlayback.h"
#include "Evaluation/MovieSceneSegment.h"
#include "Evaluation/MovieSceneTrackImplementation.h"
#include "Evaluation/PersistentEvaluationData.h"
#include "HAL/Platform.h"
#include "Misc/Guid.h"
#include "Misc/InlineValue.h"
#include "MovieSceneTrack.h"
#include "Templates/EnableIf.h"
#include "Templates/PointerIsConvertibleFromTo.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/Class.h"
#include "UObject/NameTypes.h"
#include "UObject/ObjectMacros.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
#include "MovieSceneEvaluationTrack.generated.h"
 
class FArchive;
class IMovieScenePlayer;
class UObject;
struct FMovieSceneEvaluationOperand;
struct FMovieSceneExecutionTokens;
struct FMovieSceneFieldEntry_ChildTemplate;
struct FMovieSceneInterrogationData;
 
UENUM()
enum class EEvaluationMethod : uint8
{
    Static,
 
    Swept,
};
 
USTRUCT()
struct FMovieSceneEvaluationTrack
{
    GENERATED_BODY()
 
    
    FMovieSceneEvaluationTrack();
 
    MOVIESCENE_API FMovieSceneEvaluationTrack(const FGuid& InObjectBindingID);
 
    FMovieSceneEvaluationTrack(const FMovieSceneEvaluationTrack&) = default;
    FMovieSceneEvaluationTrack& operator=(const FMovieSceneEvaluationTrack&) = default;
 
    FMovieSceneEvaluationTrack(FMovieSceneEvaluationTrack&&) = default;
    FMovieSceneEvaluationTrack& operator=(FMovieSceneEvaluationTrack&&) = default;
 
public:
 
    inline const FGuid& GetObjectBindingID() const
    {
        return ObjectBindingID;
    }
 
    inline TArrayView<FMovieSceneEvalTemplatePtr> GetChildTemplates()
    {
        return TArrayView<FMovieSceneEvalTemplatePtr>(ChildTemplates.GetData(), ChildTemplates.Num());
    }
 
    inline TArrayView<const FMovieSceneEvalTemplatePtr> GetChildTemplates() const
    {
        return TArrayView<const FMovieSceneEvalTemplatePtr>(ChildTemplates.GetData(), ChildTemplates.Num());
    }
 
    inline const FMovieSceneEvalTemplate& GetChildTemplate(int32 TemplateIndex) const
    {
        return *ChildTemplates[TemplateIndex];
    }
 
    inline bool HasChildTemplate(int32 TemplateIndex) const
    {
        return ChildTemplates.IsValidIndex(TemplateIndex) && ChildTemplates[TemplateIndex].IsValid();
    }
 
public:
 
    FName GetEvaluationGroup() const
    {
        return EvaluationGroup;
    }
 
    void SetEvaluationGroup(FName InEvaluationGroup)
    {
        EvaluationGroup = InEvaluationGroup;
    }
 
public:
 
    uint16 GetEvaluationPriority() const
    {
        return EvaluationPriority;
    }
 
    void SetEvaluationPriority(uint16 InEvaluationPriority = 1000)
    {
        EvaluationPriority = InEvaluationPriority;
    }
 
    EEvaluationMethod GetEvaluationMethod() const
    {
        return EvaluationMethod;
    }
 
    void SetEvaluationMethod(EEvaluationMethod InMethod)
    {
        EvaluationMethod = InMethod;
    }
 
    void SetPreAndPostrollConditions(bool bInEvaluateInPreroll, bool bInEvaluateInPostroll)
    {
        bEvaluateInPreroll = bInEvaluateInPreroll;
        bEvaluateInPostroll = bInEvaluateInPostroll;
    }
 
    bool ShouldEvaluateInPreroll() const
    {
        return bEvaluateInPreroll;
    }
 
    bool ShouldEvaluateInPostroll() const
    {
        return bEvaluateInPostroll;
    }
 
    void PrioritizeTearDown()
    {
        bTearDownPriority = true;
    }
 
    bool HasTearDownPriority() const
    {
        return bTearDownPriority;
    }
 
public:
 
    void Initialize(TArrayView<const FMovieSceneFieldEntry_ChildTemplate> Children, const FMovieSceneEvaluationOperand& Operand, const FMovieSceneContext& Context, FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const;
 
    void Evaluate(TArrayView<const FMovieSceneFieldEntry_ChildTemplate> Children, const FMovieSceneEvaluationOperand& Operand, const FMovieSceneContext& Context, const FPersistentEvaluationData& PersistentData, FMovieSceneExecutionTokens& ExecutionTokens) const;
 
    MOVIESCENE_API void DefaultInitialize(TArrayView<const FMovieSceneFieldEntry_ChildTemplate> Children, const FMovieSceneEvaluationOperand& Operand, FMovieSceneContext Context, FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const;
 
    MOVIESCENE_API void DefaultEvaluate(TArrayView<const FMovieSceneFieldEntry_ChildTemplate> Children, const FMovieSceneEvaluationOperand& Operand, const FMovieSceneContext& Context, const FPersistentEvaluationData& PersistentData, FMovieSceneExecutionTokens& ExecutionTokens) const;
 
    MOVIESCENE_API  void Interrogate(const FMovieSceneContext& Context, FMovieSceneInterrogationData& Container, UObject* BindingOverride = nullptr) const;
 
private:
 
    void EvaluateStatic(TArrayView<const FMovieSceneFieldEntry_ChildTemplate> Children, const FMovieSceneEvaluationOperand& Operand, FMovieSceneContext Context, const FPersistentEvaluationData& PersistentData, FMovieSceneExecutionTokens& ExecutionTokens) const;
 
    void EvaluateSwept(TArrayView<const FMovieSceneFieldEntry_ChildTemplate> Children, const FMovieSceneEvaluationOperand& Operand, const FMovieSceneContext& Context, const FPersistentEvaluationData& PersistentData, FMovieSceneExecutionTokens& ExecutionTokens) const;
 
public:
 
    MOVIESCENE_API void DefineAsSingleTemplate(FMovieSceneEvalTemplatePtr&& InTemplate);
 
    MOVIESCENE_API int32 AddChildTemplate(FMovieSceneEvalTemplatePtr&& InTemplate);
 
    void SetSourceTrack(UMovieSceneTrack* InSourceTrack)
    {
        SourceTrack = InSourceTrack;
    }
 
    UMovieSceneTrack* GetSourceTrack() const
    {
        return SourceTrack.Get();
    }
 
    template<typename T>
    typename TEnableIf<TPointerIsConvertibleFromTo<T, FMovieSceneTrackImplementation>::Value>::Type 
        SetTrackImplementation(T&& InImpl)
    {
        TrackTemplate = FMovieSceneTrackImplementationPtr(MoveTemp(InImpl));
        TrackTemplate->SetupOverrides();
    }
 
    MOVIESCENE_API void SetupOverrides();
 
    MOVIESCENE_API void PostSerialize(const FArchive& Ar);
 
    bool HasCustomInitialize() const
    {
        return TrackTemplate.IsValid() && TrackTemplate->HasCustomInitialize();
    }
 
public:
 
    inline void OnBeginEvaluation(FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const
    {
        if (!TrackTemplate.IsValid())
        {
            return;
        }
        TrackTemplate->OnBeginEvaluation(PersistentData, Player);
    }
 
    void OnEndEvaluation(FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const
    {
        if (!TrackTemplate.IsValid())
        {
            return;
        }
        TrackTemplate->OnEndEvaluation(PersistentData, Player);
    }
 
private:
 
    UPROPERTY()
    FGuid ObjectBindingID;
 
    UPROPERTY()
    uint16 EvaluationPriority;
 
    UPROPERTY()
    EEvaluationMethod EvaluationMethod;
 
    UPROPERTY()
    TWeakObjectPtr<UMovieSceneTrack> SourceTrack;
 
    UPROPERTY()
    TArray<FMovieSceneEvalTemplatePtr> ChildTemplates;
 
    UPROPERTY()
    FMovieSceneTrackImplementationPtr TrackTemplate;
 
    UPROPERTY()
    FName EvaluationGroup;
 
    UPROPERTY()
    uint32 bEvaluateInPreroll : 1;
 
    UPROPERTY()
    uint32 bEvaluateInPostroll : 1;
 
    UPROPERTY()
    uint32 bTearDownPriority : 1;
};
 
template<> struct TStructOpsTypeTraits<FMovieSceneEvaluationTrack> : public TStructOpsTypeTraitsBase2<FMovieSceneEvaluationTrack> { enum { WithPostSerialize = true, WithCopy = false }; };
 
#if WITH_DEV_AUTOMATION_TESTS
 
struct FScopedOverrideTrackSegmentBlender
{
    MOVIESCENE_API FScopedOverrideTrackSegmentBlender(FMovieSceneTrackSegmentBlenderPtr&& InTrackSegmentBlender);
    MOVIESCENE_API ~FScopedOverrideTrackSegmentBlender();
 
    FScopedOverrideTrackSegmentBlender(const FScopedOverrideTrackSegmentBlender&) = delete;
    FScopedOverrideTrackSegmentBlender& operator=(const FScopedOverrideTrackSegmentBlender&) = delete;
};
 
#endif