MovieSceneCameraCutEditorHandler.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_EDITOR
 
#include "CoreMinimal.h"
#include "Evaluation/PreAnimatedState/MovieScenePreAnimatedStateStorage.h"
#include "Evaluation/PreAnimatedState/MovieScenePreAnimatedStateTypes.h"
#include "Evaluation/PreAnimatedState/MovieScenePreAnimatedStorageID.inl"
 
class AActor;
class FLevelEditorViewportClient;
class UCameraComponent;
class UMovieSceneEntitySystemLinker;
struct FMovieSceneCameraCutParams;
 
namespace UE::MovieScene
{
 
class FCameraCutViewportPreviewer;
struct FCameraCutPlaybackCapability;
struct FPreAnimatedCameraCutEditorStorage;
struct FSequenceInstance;
 
struct FPreAnimatedCameraCutEditorState
{
    FVector ViewportLocation;
    FRotator ViewportRotation;
};
 
struct FPreAnimatedCameraCutEditorTraits : FPreAnimatedStateTraits
{
    // Key type is the viewport to restore location/rotation/FOV on.
    using KeyType = FLevelEditorViewportClient*;
    using StorageType = FPreAnimatedCameraCutEditorState;
 
    static bool ShouldHandleViewportCameraCuts(UWorld* ViewportWorld);
    static StorageType CachePreAnimatedValue(KeyType InKey);
 
    void RestorePreAnimatedValue(KeyType InKey, const StorageType& CachedValue, const FRestoreStateParams& Params);
};
 
// Make it possible to declare our storage below with a forward-declared FLevelEditorViewportClient.
template<>
struct THasAddReferencedObjectForComponent<FLevelEditorViewportClient*>
{
    static constexpr bool Value = false;
};
 
struct FPreAnimatedCameraCutEditorStorage : TPreAnimatedStateStorage<FPreAnimatedCameraCutEditorTraits>
{
    static TAutoRegisterPreAnimatedStorageID<FPreAnimatedCameraCutEditorStorage> StorageID;
};
 
enum class EForcedCameraCutPreAnimatedStorageOperation
{
    Cache,
    Restore,
    Discard
};
 
struct FCameraCutEditorHandler
{
    FCameraCutEditorHandler(
            UMovieSceneEntitySystemLinker* InLinker,
            const FSequenceInstance& InSequenceInstance,
            FCameraCutViewportPreviewer& InViewportPreviewer);
 
    void SetCameraCut(
            UObject* CameraObject, 
            const FMovieSceneCameraCutParams& CameraCutParams);
 
    static void CachePreAnimatedValue(
            UMovieSceneEntitySystemLinker* Linker,
            const FSequenceInstance& SequenceInstance);
    static void ForcePreAnimatedValueOperation(
            UMovieSceneEntitySystemLinker* Linker,
            const FSequenceInstance& SequenceInstance,
            EForcedCameraCutPreAnimatedStorageOperation Operation);
 
private:
 
    void SetCameraCutForViewport(
            FLevelEditorViewportClient& ViewportClient, 
            AActor* CameraActor, 
            UCameraComponent* CameraComponent,
            const FMovieSceneCameraCutParams& CameraCutParams);
    void ReleaseCameraCutForViewport(
            FLevelEditorViewportClient& ViewportClient);
 
private:
    UMovieSceneEntitySystemLinker* Linker;
    const FSequenceInstance& SequenceInstance;
    FCameraCutViewportPreviewer& ViewportPreviewer;
};
 
}  // namespace UE::MovieScene
 
#endif  // WITH_EDITOR