MovieSceneTrackImplementation.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ArrayView.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Evaluation/MovieSceneEvalTemplateBase.h"
#include "Evaluation/MovieScenePlayback.h"
#include "Evaluation/MovieSceneSegment.h"
#include "Evaluation/PersistentEvaluationData.h"
#include "Misc/AssertionMacros.h"
#include "Misc/InlineValue.h"
#include "Templates/Decay.h"
#include "Templates/EnableIf.h"
#include "Templates/PointerIsConvertibleFromTo.h"
#include "Templates/UnrealTemplate.h"
#include "Templates/UnrealTypeTraits.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
 
#include "MovieSceneTrackImplementation.generated.h"
 
class FArchive;
class IMovieScenePlayer;
class UObject;
struct FMovieSceneEvaluationOperand;
struct FMovieSceneEvaluationTrack;
struct FMovieSceneExecutionTokens;
struct FMovieSceneFieldEntry_ChildTemplate;
struct FMovieSceneInterrogationData;
 
USTRUCT()
struct FMovieSceneTrackImplementation : public FMovieSceneEvalTemplateBase
{
public:
    GENERATED_BODY()
 
    
    FMovieSceneTrackImplementation()
    {
    }
 
    bool HasCustomInitialize() const
    {
        return (OverrideMask & CustomInitializeFlag) != 0;
    }
 
    bool HasCustomEvaluate() const
    {
        return (OverrideMask & CustomEvaluateFlag) != 0;
    }
 
    virtual void Initialize(const FMovieSceneEvaluationTrack& Track, TArrayView<const FMovieSceneFieldEntry_ChildTemplate> Children, const FMovieSceneEvaluationOperand& Operand, const FMovieSceneContext& Context, FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) const
    {
        ensureMsgf(false, TEXT("FMovieSceneTrackImplementation::Initialize has not been implemented. Did you erroneously call EnableOverrides(CustomInitializeFlag)?"));
    }
 
    virtual void Evaluate(const FMovieSceneEvaluationTrack& Track, TArrayView<const FMovieSceneFieldEntry_ChildTemplate> Children, const FMovieSceneEvaluationOperand& Operand, const FMovieSceneContext& Context, const FPersistentEvaluationData& PersistentData, FMovieSceneExecutionTokens& ExecutionTokens) const
    {
        ensureMsgf(false, TEXT("FMovieSceneTrackImplementation::Evaluate has not been implemented. Did you erroneously call EnableOverrides(CustomEvaluateFlag)?"));
    }
 
    virtual bool Interrogate(const FMovieSceneContext& Context, FMovieSceneInterrogationData& Container, UObject* BindingOverride = nullptr) const
    {
        return false;
    }
 
protected:
 
    enum EOverrideMask
    {
        CustomInitializeFlag    = 0x004,
        CustomEvaluateFlag      = 0x008,
    };
};
 
USTRUCT()
struct FMovieSceneTrackImplementationPtr
#if CPP
    : TInlineValue<FMovieSceneTrackImplementation, 48>
#endif
{
    GENERATED_BODY()
 
    
    FMovieSceneTrackImplementationPtr(){}
 
    template<
        typename T,
        typename = typename TEnableIf<TPointerIsConvertibleFromTo<typename TDecay<T>::Type, FMovieSceneTrackImplementation>::Value>::Type
    >
    FMovieSceneTrackImplementationPtr(T&& In)
        : TInlineValue(Forward<T>(In))
    {
        static_assert(!std::is_same_v<typename TDecay<T>::Type, FMovieSceneTrackImplementation>, "Direct usage of FMovieSceneTrackImplementation is prohibited.");
 
#if WITH_EDITOR
        checkf(T::StaticStruct() == &In.GetScriptStruct() && T::StaticStruct() != FMovieSceneTrackImplementation::StaticStruct(), TEXT("%s type does not correctly override GetScriptStructImpl. Track will not serialize correctly."), *T::StaticStruct()->GetName());
#endif
    }
    
    FMovieSceneTrackImplementationPtr(const FMovieSceneTrackImplementationPtr& RHS)
    {
        *this = RHS;
    }
    FMovieSceneTrackImplementationPtr& operator=(const FMovieSceneTrackImplementationPtr& RHS)
    {
        if (RHS.IsValid())
        {
            UScriptStruct::ICppStructOps& StructOps = *RHS->GetScriptStruct().GetCppStructOps();
 
            void* Allocation = Reserve(StructOps.GetSize(), StructOps.GetAlignment());
            StructOps.Construct(Allocation);
            StructOps.Copy(Allocation, &RHS.GetValue(), 1);
        }
        else
        {
            Reset();
        }
 
        return *this;
    }
 
    FMovieSceneTrackImplementationPtr(FMovieSceneTrackImplementationPtr&&) = default;
    FMovieSceneTrackImplementationPtr& operator=(FMovieSceneTrackImplementationPtr&&) = default;
 
    MOVIESCENE_API bool Serialize(FArchive& Ar);
};
 
template<> struct TStructOpsTypeTraits<FMovieSceneTrackImplementationPtr> : public TStructOpsTypeTraitsBase2<FMovieSceneTrackImplementationPtr>
{
    enum { WithSerializer = true, WithCopy = true };
};