MovieSceneEvalTemplateBase.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Evaluation/MovieScenePlayback.h"
#include "MovieSceneEvalTemplateBase.generated.h"
 
 
struct FPersistentEvaluationData;
class IMovieScenePlayer;
 
 
USTRUCT()
struct FMovieSceneEmptyStruct
{
    GENERATED_BODY()
};
 
USTRUCT()
struct FMovieSceneEvalTemplateBase
{
public:
 
    GENERATED_BODY()
 
    
    FMovieSceneEvalTemplateBase()
        : OverrideMask(0)
    {
    }
 
    virtual ~FMovieSceneEvalTemplateBase() {}
 
    UScriptStruct& GetScriptStruct() const { return GetScriptStructImpl(); }
 
    inline bool RequiresSetup() const { return (OverrideMask & RequiresSetupFlag) != 0; }
 
    inline bool RequiresTearDown() const { return (OverrideMask & RequiresTearDownFlag) != 0; }
 
    inline void OnBeginEvaluation(FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const
    {
        if (RequiresSetup())
        {
            Setup(PersistentData, Player);
        }
    }
 
    inline void OnEndEvaluation(FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const
    {
        if (RequiresTearDown())
        {
            TearDown(PersistentData, Player);
        }
    }
 
    virtual void SetupOverrides()
    {
    }
 
protected:
 
    virtual void Setup(FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const
    {
        ensureMsgf(false, TEXT("FMovieSceneEvalTemplateBase::Setup has not been implemented. Did you erroneously call EnableOverrides(RequiresSetupFlag)?"));
    }
 
    virtual void TearDown(FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const
    {
        ensureMsgf(false, TEXT("FMovieSceneEvalTemplateBase::TearDown has not been implemented. Did you erroneously call EnableOverrides(RequiresTearDownFlag)?"));
    }
    
    virtual UScriptStruct& GetScriptStructImpl() const
    {
        ensureMsgf(false, TEXT("GetScriptStructImpl has not been implemented. This type will not serialize correctly."));
        return *StaticStruct();
    }
 
protected:
 
    void EnableOverrides(uint8 OverrideFlag)
    {
        OverrideMask |= OverrideFlag;
    }
 
    enum EOverrideMask
    {
        RequiresSetupFlag       = 0x001,
        RequiresTearDownFlag    = 0x002,
    };
 
    uint8 OverrideMask;
};