LevelSequencePlayer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/EngineTypes.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/ScriptMacros.h"
#include "Evaluation/CameraCutPlaybackCapability.h"
#include "Evaluation/MovieScenePlayback.h"
#include "Evaluation/MovieSceneEvaluationTemplateInstance.h"
#include "Evaluation/PersistentEvaluationData.h"
#include "MovieSceneSequencePlayer.h"
#include "Misc/QualifiedFrameTime.h"
#include "LevelSequence.h"
#include "LevelSequenceCameraSettings.h"
#include "WorldPartition/WorldPartitionActorContainerID.h"
#include "LevelSequencePlayer.generated.h"
 
class AActor;
class ALevelSequenceActor;
class FLevelSequenceSpawnRegister;
class FViewportClient;
class UCameraComponent;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnLevelSequencePlayerCameraCutEvent , UCameraComponent*, CameraComponent);
 
USTRUCT(BlueprintType)
struct FLevelSequencePlayerSnapshot
{
    GENERATED_BODY()
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="General")
    FString RootName;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="General")
    FQualifiedFrameTime RootTime;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="General")
    FQualifiedFrameTime SourceTime;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="General")
    FString CurrentShotName;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="General")
    FQualifiedFrameTime CurrentShotLocalTime;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="General")
    FQualifiedFrameTime CurrentShotSourceTime;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="General")
    FString SourceTimecode;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="General")
    TSoftObjectPtr<UCameraComponent> CameraComponent;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "General")
    TObjectPtr<ULevelSequence> ActiveShot = nullptr;
 
    UPROPERTY()
    FMovieSceneSequenceID ShotID;
};
 
UCLASS(BlueprintType, MinimalAPI)
class ULevelSequencePlayer
    : public UMovieSceneSequencePlayer
    , public UE::MovieScene::FCameraCutPlaybackCapability
{
public:
    LEVELSEQUENCE_API ULevelSequencePlayer(const FObjectInitializer&);
 
    GENERATED_BODY()
 
    
    LEVELSEQUENCE_API void Initialize(ULevelSequence* InLevelSequence, ULevel* InLevel, const FLevelSequenceCameraSettings& InCameraSettings);
 
    LEVELSEQUENCE_API void SetSourceActorContext(UWorld* InStreamingWorld, FActorContainerID InContainerID, FTopLevelAssetPath InSourceAssetPath);
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Sequencer|Player", meta=(WorldContext="WorldContextObject", DynamicOutputParam="OutActor"))
    static LEVELSEQUENCE_API ULevelSequencePlayer* CreateLevelSequencePlayer(UObject* WorldContextObject, ULevelSequence* LevelSequence, FMovieSceneSequencePlaybackSettings Settings, ALevelSequenceActor*& OutActor);
 
    UPROPERTY(BlueprintAssignable, Category="Sequencer|Player")
    FOnLevelSequencePlayerCameraCutEvent OnCameraCut;
 
    UFUNCTION(BlueprintCallable, Category="Sequencer|Player")
    UCameraComponent* GetActiveCameraComponent() const { return CachedCameraComponent.Get(); }
 
public:
 
    // IMovieScenePlayer interface
    LEVELSEQUENCE_API virtual UObject* GetPlaybackContext() const override;
    LEVELSEQUENCE_API virtual TArray<UObject*> GetEventContexts() const override;
 
    LEVELSEQUENCE_API void RewindForReplay();
 
protected:
 
    // IMovieScenePlayer interface
    
    LEVELSEQUENCE_API virtual void ResolveBoundObjects(UE::UniversalObjectLocator::FResolveParams& ResolveParams, const FGuid& InBindingId, FMovieSceneSequenceID SequenceID, UMovieSceneSequence& Sequence, TArray<UObject*, TInlineAllocator<1>>& OutObjects) const override;
    LEVELSEQUENCE_API virtual void InitializeRootInstance(TSharedRef<UE::MovieScene::FSharedPlaybackState> NewSharedPlaybackState) override;
 
    //~ UMovieSceneSequencePlayer interface
    LEVELSEQUENCE_API virtual bool CanPlay() const override;
    LEVELSEQUENCE_API virtual void OnStartedPlaying() override;
    LEVELSEQUENCE_API virtual void OnStopped() override;
    LEVELSEQUENCE_API virtual void UpdateMovieSceneInstance(FMovieSceneEvaluationRange InRange, EMovieScenePlayerStatus::Type PlayerStatus, const FMovieSceneUpdateArgs& Args) override;
 
    //~ FCameraCutPlaybackCapability interface
    LEVELSEQUENCE_API virtual bool ShouldUpdateCameraCut() override;
    LEVELSEQUENCE_API virtual float GetCameraBlendPlayRate() override;
    LEVELSEQUENCE_API virtual TOptional<EAspectRatioAxisConstraint> GetAspectRatioAxisConstraintOverride() override;
    LEVELSEQUENCE_API virtual void OnCameraCutUpdated(const UE::MovieScene::FOnCameraCutUpdatedParams& Params) override;
 
public:
 
    static LEVELSEQUENCE_API void GetEventContexts(UWorld& InWorld, TArray<UObject*>& OutContexts);
 
    LEVELSEQUENCE_API void TakeFrameSnapshot(FLevelSequencePlayerSnapshot& OutSnapshot) const;
 
    void SetSnapshotOffsetFrames(int32 InFrameOffset) { SnapshotOffsetTime = TOptional<int32>(InFrameOffset); }
 
private:
 
    LEVELSEQUENCE_API void EnableCinematicMode(bool bEnable);
 
    void InitializeLevelSequenceRootInstance(TSharedRef<UE::MovieScene::FSharedPlaybackState> NewSharedPlaybackState);
 
private:
 
    TWeakObjectPtr<UWorld> World;
 
    TWeakObjectPtr<ULevel> Level;
 
    FLevelSequenceCameraSettings CameraSettings;
 
protected:
 
    TOptional<int32> SnapshotOffsetTime;
 
    TWeakObjectPtr<UCameraComponent> CachedCameraComponent;
 
private:
 
    TOptional<FLevelSequencePlayerSnapshot> PreviousSnapshot;
 
    TWeakObjectPtr<UWorld> WeakStreamingWorld;
    FTopLevelAssetPath SourceAssetPath;
    FActorContainerID ContainerID;
};