MovieScenePredictionSystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/SparseArray.h"
#include "Containers/Array.h"
#include "Delegates/DelegateCombinations.h"
#include "Kismet/BlueprintAsyncActionBase.h"
#include "Misc/FrameTime.h"
 
#include "EntitySystem/MovieSceneEntityIDs.h"
#include "EntitySystem/MovieSceneEntitySystem.h"
#include "EntitySystem/Interrogation/MovieSceneInterrogationLinker.h"
 
#include "MovieScenePredictionSystem.generated.h"
 
struct FGuid;
struct FMovieSceneEntityComponentField;
 
class USceneComponent;
class UMovieSceneSequencePlayer;
class UMovieSceneEntitySystemLinker;
 
namespace UE
{
namespace MovieScene
{
 
struct FEntityImportSequenceParams;
 
} // namespace MovieScene
} // namespace UE
 
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FMovieSceneActorPredictionResult, FTransform, PredictedTransform);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FMovieSceneActorPredictionFailure);
 
UCLASS(BlueprintType, meta=(ExposedAsyncProxy = "AsyncTask", HasDedicatedAsyncNode))
class UMovieSceneAsyncAction_SequencePrediction : public UBlueprintAsyncActionBase
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable, Category=Cinematics)
    static UMovieSceneAsyncAction_SequencePrediction* PredictWorldTransformAtTime(UMovieSceneSequencePlayer* Player, USceneComponent* TargetComponent, float TimeInSeconds);
 
 
    UFUNCTION(BlueprintCallable, Category=Cinematics)
    static UMovieSceneAsyncAction_SequencePrediction* PredictWorldTransformAtFrame(UMovieSceneSequencePlayer* Player, USceneComponent* TargetComponent, FFrameTime FrameTime);
 
 
    UFUNCTION(BlueprintCallable, Category=Cinematics)
    static UMovieSceneAsyncAction_SequencePrediction* PredictLocalTransformAtTime(UMovieSceneSequencePlayer* Player, USceneComponent* TargetComponent, float TimeInSeconds);
 
 
    UFUNCTION(BlueprintCallable, Category=Cinematics)
    static UMovieSceneAsyncAction_SequencePrediction* PredictLocalTransformAtFrame(UMovieSceneSequencePlayer* Player, USceneComponent* TargetComponent, FFrameTime FrameTime);
 
    void ImportEntities(UE::MovieScene::FInterrogationChannels* Channels);
 
 
    void Reset(UMovieSceneEntitySystemLinker* Linker);
 
 
    void ReportResult(UE::MovieScene::FInterrogationChannels* Channels, const TSparseArray<TArray<FTransform>>& AllResults);
    void ReportResult(UE::MovieScene::FInterrogationChannels* Channels, const TSparseArray<TArray<UE::MovieScene::FIntermediate3DTransform>>& AllResults);
 
private:
 
    static UMovieSceneAsyncAction_SequencePrediction* MakePredictionImpl(UMovieSceneSequencePlayer* Player, USceneComponent* TargetComponent, float TimeInSeconds, bool bInWorldSpace);
    static UMovieSceneAsyncAction_SequencePrediction* MakePredictionImpl(UMovieSceneSequencePlayer* Player, USceneComponent* TargetComponent, FFrameTime TickResolutionTime, bool bInWorldSpace);
 
    int32 ImportTransformEntities(UMovieSceneEntitySystemLinker* Linker, const UE::MovieScene::FEntityImportSequenceParams& ImportParams, const FGuid& ObjectGuid, FFrameTime PredictedTime, const FMovieSceneEntityComponentField* ComponentField, const UE::MovieScene::FInterrogationKey& InterrogationKey);
    int32 ImportTransformEntities(UObject* PredicateObject, UObject* ObjectContext, const UE::MovieScene::FInterrogationKey& InterrogationKey);
 
    void ImportLocalTransforms(UE::MovieScene::FInterrogationChannels* Channels, USceneComponent* InSceneComponent);
    void ImportTransformHierarchy(UE::MovieScene::FInterrogationChannels* Channels, USceneComponent* InSceneComponent);
 
public:
 
    UPROPERTY(BlueprintAssignable)
    FMovieSceneActorPredictionResult Result;
 
    UPROPERTY(BlueprintAssignable)
    FMovieSceneActorPredictionFailure Failure;
 
private:
 
    friend class UMovieScenePredictionSystem;
 
    TArray<UE::MovieScene::FMovieSceneEntityID> ImportedEntities;
 
    UPROPERTY()
    TObjectPtr<UMovieSceneSequencePlayer> SequencePlayer;
 
    UPROPERTY()
    TObjectPtr<USceneComponent> SceneComponent;
 
    FFrameTime RootPredictedTime;
 
    int32 InterrogationIndex;
 
    bool bWorldSpace;
};
 
 
UCLASS(MinimalAPI)
class UMovieScenePredictionSystem : public UMovieSceneEntitySystem
{
public:
 
    GENERATED_BODY()
 
    UMovieScenePredictionSystem(const FObjectInitializer& ObjInit);
 
    void AddPendingPrediction(UMovieSceneAsyncAction_SequencePrediction* Prediction);
 
    int32 MakeNewInterrogation(FFrameTime InTime);
 
private:
 
    bool IsRelevantImpl(UMovieSceneEntitySystemLinker* InLinker) const override;
    void OnRun(FSystemTaskPrerequisites& InPrerequisites, FSystemSubsequentTasks& Subsequents) override;
 
    UE::MovieScene::FInterrogationChannels InterrogationChannels;
 
    UPROPERTY()
    TArray<TObjectPtr<UMovieSceneAsyncAction_SequencePrediction>> PendingPredictions;
 
    UPROPERTY()
    TArray<TObjectPtr<UMovieSceneAsyncAction_SequencePrediction>> ProcessingPredictions;
};