MovieScenePreAnimatedState.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Map.h"
#include "CoreTypes.h"
#include "EntitySystem/MovieSceneSequenceInstanceHandle.h"
#include "Templates/SharedPointer.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
class UClass;
class UMovieSceneEntitySystemLinker;
class UObject;
struct FMovieSceneAnimTypeID;
struct FMovieSceneEvaluationKey;
struct FMovieSceneSequenceID;
struct IMovieScenePreAnimatedGlobalTokenProducer;
struct IMovieScenePreAnimatedTokenProducer;
template <typename FuncType> class TFunctionRef;
 
class FMovieSceneInstancePreAnimatedState
{
public:
 
    FMovieSceneInstancePreAnimatedState(UMovieSceneEntitySystemLinker* InLinker, UE::MovieScene::FRootInstanceHandle InInstanceHandle);
 
    FMovieSceneInstancePreAnimatedState(const FMovieSceneInstancePreAnimatedState&) = delete;
    FMovieSceneInstancePreAnimatedState& operator=(const FMovieSceneInstancePreAnimatedState&) = delete;
 
    MOVIESCENE_API ~FMovieSceneInstancePreAnimatedState();
 
    MOVIESCENE_API bool IsCapturingGlobalPreAnimatedState() const;
 
    MOVIESCENE_API void EnableGlobalPreAnimatedStateCapture();
 
    MOVIESCENE_API UMovieSceneEntitySystemLinker* GetLinker() const;
 
public:
 
    MOVIESCENE_API void SavePreAnimatedState(UObject& InObject, FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedTokenProducer& Producer);
 
    MOVIESCENE_API void SavePreAnimatedState(FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedGlobalTokenProducer& Producer);
 
public:
 
    MOVIESCENE_API void RestorePreAnimatedState();
 
    MOVIESCENE_API void RestorePreAnimatedState(UObject& Object);
 
    MOVIESCENE_API void RestorePreAnimatedState(UClass* GeneratedClass);
 
    MOVIESCENE_API void RestorePreAnimatedState(UObject& Object, TFunctionRef<bool(FMovieSceneAnimTypeID)> InFilter);
 
    // Discards all pre-animated state without restoring it.
    MOVIESCENE_API void DiscardPreAnimatedState();
 
    MOVIESCENE_API void DiscardEntityTokens();
 
    MOVIESCENE_API void DiscardAndRemoveEntityTokensForObject(UObject& Object);
 
public:
 
    MOVIESCENE_API bool ContainsAnyStateForSequence() const;
 
private:
 
    void ConditionalInitializeEntityStorage(bool bOverrideWantsRestoreState);
 
private:
 
    TWeakObjectPtr<UMovieSceneEntitySystemLinker> WeakLinker;
 
    UE::MovieScene::FRootInstanceHandle InstanceHandle;
 
    bool bCapturingGlobalPreAnimatedState;
};
 
class FMovieScenePreAnimatedState
{
public:
 
    FMovieScenePreAnimatedState() = default;
    FMovieScenePreAnimatedState(const FMovieScenePreAnimatedState&) = delete;
    FMovieScenePreAnimatedState& operator=(const FMovieScenePreAnimatedState&) = delete;
 
    MOVIESCENE_API void Initialize(UMovieSceneEntitySystemLinker* Linker, UE::MovieScene::FRootInstanceHandle InstanceHandle);
    MOVIESCENE_API bool IsCapturingGlobalPreAnimatedState() const;
    MOVIESCENE_API void EnableGlobalPreAnimatedStateCapture();
    MOVIESCENE_API UMovieSceneEntitySystemLinker* GetLinker() const;
    MOVIESCENE_API void SavePreAnimatedState(UObject& InObject, FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedTokenProducer& Producer);
    MOVIESCENE_API void SavePreAnimatedState(FMovieSceneAnimTypeID InTokenType, const IMovieScenePreAnimatedGlobalTokenProducer& Producer);
    MOVIESCENE_API void RestorePreAnimatedState();
    MOVIESCENE_API void RestorePreAnimatedState(UObject& Object);
    MOVIESCENE_API void RestorePreAnimatedState(UClass* GeneratedClass);
    MOVIESCENE_API void RestorePreAnimatedState(UObject& Object, TFunctionRef<bool(FMovieSceneAnimTypeID)> InFilter);
    MOVIESCENE_API void DiscardPreAnimatedState();
    MOVIESCENE_API void DiscardEntityTokens();
    MOVIESCENE_API void DiscardAndRemoveEntityTokensForObject(UObject& Object);
    MOVIESCENE_API bool ContainsAnyStateForSequence() const;
 
private:
 
    FMovieSceneInstancePreAnimatedState* GetState() const;
 
    TWeakObjectPtr<UMovieSceneEntitySystemLinker> WeakLinker;
    UE::MovieScene::FRootInstanceHandle InstanceHandle;
 
    friend struct FScopedPreAnimatedCaptureSource;
};