MovieSceneExecutionToken.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "MovieSceneFwd.h"
#include "Misc/InlineValue.h"
#include "Evaluation/MovieSceneAnimTypeID.h"
#include "Evaluation/PreAnimatedState/MovieSceneRestoreStateParams.h"
 
class IMovieScenePlayer;
struct FMovieSceneContext;
struct FMovieSceneEvaluationOperand;
struct FPersistentEvaluationData;
 
struct IMovieScenePreAnimatedToken
{
    virtual ~IMovieScenePreAnimatedToken() {}
 
    virtual void RestoreState(UObject& Object, const UE::MovieScene::FRestoreStateParams& Params) = 0;
};
typedef TInlineValue<IMovieScenePreAnimatedToken, 32> IMovieScenePreAnimatedTokenPtr;
 
struct IMovieScenePreAnimatedTokenProducer
{
    virtual ~IMovieScenePreAnimatedTokenProducer(){}
 
    virtual void InitializeObjectForAnimation(UObject& Object) const
    {}
 
    virtual IMovieScenePreAnimatedTokenPtr CacheExistingState(UObject& Object) const = 0;
};
 
struct IMovieScenePreAnimatedGlobalToken
{
    virtual ~IMovieScenePreAnimatedGlobalToken() {}
 
    virtual void RestoreState(const UE::MovieScene::FRestoreStateParams& Params) = 0;
};
typedef TInlineValue<IMovieScenePreAnimatedGlobalToken, 32> IMovieScenePreAnimatedGlobalTokenPtr;
 
struct IMovieScenePreAnimatedGlobalTokenProducer
{
    virtual ~IMovieScenePreAnimatedGlobalTokenProducer() { }
 
    virtual void InitializeForAnimation() const {}
 
    virtual IMovieScenePreAnimatedGlobalTokenPtr CacheExistingState() const = 0;
};
 
struct IMovieSceneExecutionToken
{
    virtual ~IMovieSceneExecutionToken() {}
    virtual void Execute(const FMovieSceneContext& Context, const FMovieSceneEvaluationOperand& Operand, FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) = 0;
};
 
struct IMovieSceneSharedExecutionToken
{
    IMovieSceneSharedExecutionToken()
        : Order(0)
    {}
    
    virtual ~IMovieSceneSharedExecutionToken() {}
 
    virtual void Execute(FPersistentEvaluationData& PersistentData, IMovieScenePlayer& Player) = 0;
 
    int32 Order;
};
 
struct FStatelessPreAnimatedTokenProducer : IMovieScenePreAnimatedTokenProducer
{
    typedef void (*StaticFunction)(UObject& Object, const UE::MovieScene::FRestoreStateParams& Params);
 
    FStatelessPreAnimatedTokenProducer(StaticFunction InFunction) : Function(InFunction) {}
 
    virtual IMovieScenePreAnimatedTokenPtr CacheExistingState(UObject& Object) const override
    {
        return FToken(Function);
    }
    
    struct FToken : IMovieScenePreAnimatedToken
    {
        FToken(StaticFunction InFunctionPtr) : FunctionPtr(InFunctionPtr) {}
 
        virtual void RestoreState(UObject& Object, const UE::MovieScene::FRestoreStateParams& Params) override
        {
            (*FunctionPtr)(Object, Params);
        }
 
        StaticFunction FunctionPtr;
    };
    StaticFunction Function;
};
 
template<typename TokenType>
struct TStatelessPreAnimatedTokenProducer : IMovieScenePreAnimatedTokenProducer
{
    virtual IMovieScenePreAnimatedTokenPtr CacheExistingState(UObject& Object) const override
    {
        return TokenType();
    }
};
 
template<typename TokenType>
struct TForwardingPreAnimatedTokenProducer : IMovieScenePreAnimatedTokenProducer
{
    virtual IMovieScenePreAnimatedTokenPtr CacheExistingState(UObject& Object) const override
    {
        return TokenType(Object);
    }
};