CameraModifier_CameraShake.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "Camera/CameraTypes.h"
#include "Camera/CameraModifier.h"
#include "CameraModifier_CameraShake.generated.h"
 
class UCameraShakeBase;
class UCameraShakeSourceComponent;
 
USTRUCT()
struct FPooledCameraShakes
{
    GENERATED_BODY()
        
    UPROPERTY()
    TArray<TObjectPtr<UCameraShakeBase>> PooledShakes;
};
 
USTRUCT()
struct FActiveCameraShakeInfo
{
    GENERATED_BODY()
 
    FActiveCameraShakeInfo() 
        : ShakeInstance(nullptr)
        , ShakeSource(nullptr)
        , bIsCustomInitialized(false)
    {}
 
    UPROPERTY()
    TObjectPtr<UCameraShakeBase> ShakeInstance;
 
    UPROPERTY()
    TWeakObjectPtr<const UCameraShakeSourceComponent> ShakeSource;
 
    UPROPERTY()
    bool bIsCustomInitialized;
 
#if UE_ENABLE_DEBUG_DRAWING
    int32 DebugDataIndex = INDEX_NONE;
#endif
};
 
#if UE_ENABLE_DEBUG_DRAWING
struct FCameraShakeDebugDataPoint
{
    float AccumulatedTime;
    FVector DeltaLocation;
    FRotator DeltaRotation;
};
#endif
 
#if UE_ENABLE_DEBUG_DRAWING
struct FCameraShakeDebugData
{
    TSubclassOf<UCameraShakeBase> ShakeClass;
    FString ShakeInstanceName;
    TArray<FCameraShakeDebugDataPoint> DataPoints;
    float TimeInactive = 0.f;
    bool bIsInactive = false;
};
#endif
 
DECLARE_DELEGATE_OneParam(FOnInitializeCameraShake, UCameraShakeBase*);
 
struct FAddCameraShakeParams
{
    float Scale;
    ECameraShakePlaySpace PlaySpace;
    FRotator UserPlaySpaceRot;
 
    const UCameraShakeSourceComponent* SourceComponent;
 
    FOnInitializeCameraShake Initializer;
 
    TOptional<float> DurationOverride;
 
    FAddCameraShakeParams()
        : Scale(1.f), PlaySpace(ECameraShakePlaySpace::CameraLocal), UserPlaySpaceRot(FRotator::ZeroRotator), SourceComponent(nullptr)
    {}
    FAddCameraShakeParams(float InScale, ECameraShakePlaySpace InPlaySpace = ECameraShakePlaySpace::CameraLocal, FRotator InUserPlaySpaceRot = FRotator::ZeroRotator, const UCameraShakeSourceComponent* InSourceComponent = nullptr)
        : Scale(InScale), PlaySpace(InPlaySpace), UserPlaySpaceRot(InUserPlaySpaceRot), SourceComponent(InSourceComponent)
    {}
};
 
//~=============================================================================
UCLASS(config=Camera, MinimalAPI)
class UCameraModifier_CameraShake : public UCameraModifier
{
    GENERATED_BODY()
 
public:
    ENGINE_API UCameraModifier_CameraShake(const FObjectInitializer& ObjectInitializer);
 
    ENGINE_API virtual void BeginDestroy() override;
 
    ENGINE_API virtual UCameraShakeBase* AddCameraShake(TSubclassOf<UCameraShakeBase> NewShake, const FAddCameraShakeParams& Params);
 
    ENGINE_API virtual void GetActiveCameraShakes(TArray<FActiveCameraShakeInfo>& ActiveCameraShakes) const;
    
    ENGINE_API virtual void RemoveCameraShake(UCameraShakeBase* ShakeInst, bool bImmediately = true);
 
    ENGINE_API virtual void RemoveAllCameraShakesOfClass(TSubclassOf<UCameraShakeBase> ShakeClass, bool bImmediately = true);
 
    ENGINE_API virtual void RemoveAllCameraShakesFromSource(const UCameraShakeSourceComponent* SourceComponent, bool bImmediately = true);
 
    ENGINE_API virtual void RemoveAllCameraShakesOfClassFromSource(TSubclassOf<UCameraShakeBase> ShakeClass, const UCameraShakeSourceComponent* SourceComponent, bool bImmediately = true);
 
    ENGINE_API virtual void RemoveAllCameraShakes(bool bImmediately = true);
    
    //~ Begin UCameraModifer Interface
    ENGINE_API virtual bool ModifyCamera(float DeltaTime, struct FMinimalViewInfo& InOutPOV) override;
    ENGINE_API virtual void DisplayDebug(class UCanvas* Canvas, const FDebugDisplayInfo& DebugDisplay, float& YL, float& YPos) override;
    //~ End UCameraModifer Interface
 
protected:
 
    UPROPERTY()
    TArray<FActiveCameraShakeInfo> ActiveShakes;
 
    UPROPERTY()
    TMap<TSubclassOf<UCameraShakeBase>, FPooledCameraShakes> ExpiredPooledShakesMap;
 
    ENGINE_API void SaveShakeInExpiredPoolIfPossible(const FActiveCameraShakeInfo& ShakeInfo);
    ENGINE_API void SaveShakeInExpiredPool(UCameraShakeBase* ShakeInst);
    ENGINE_API UCameraShakeBase* ReclaimShakeFromExpiredPool(TSubclassOf<UCameraShakeBase> CameraShakeClass);
 
    UPROPERTY(EditAnywhere, Category = CameraModifier_CameraShake)
    float SplitScreenShakeScale;
 
#if UE_ENABLE_DEBUG_DRAWING
    ENGINE_API void AddCameraShakeDebugData(FActiveCameraShakeInfo& ShakeInfo);
    ENGINE_API void RemoveCameraShakeDebugData(const FActiveCameraShakeInfo& ShakeInfo);
    ENGINE_API void DisplayDebugGraphs(class UCanvas* Canvas, const FDebugDisplayInfo& DebugDisplay);
 
    TArray<FCameraShakeDebugData> DebugShakes;
    bool bRecordDebugData;
#endif
 
private:
    void OnPreGarbageCollect();
    void RemoveInvalidObjectsFromExpiredPool();
};