DebugCameraController.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/HitResult.h"
#include "UObject/ObjectMacros.h"
#include "Engine/EngineTypes.h"
#include "FinalPostProcessSettings.h"
#include "SceneTypes.h"
#include "GameFramework/PlayerController.h"
#include "DebugCameraController.generated.h"
 
class ASpectatorPawn;
 
UCLASS(config=Game, MinimalAPI)
class ADebugCameraController
    : public APlayerController
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(globalconfig)
    uint32 bShowSelectedInfo:1;
 
    UPROPERTY()
    uint32 bIsFrozenRendering:1;
 
    UPROPERTY()
    uint32 bIsOrbitingSelectedActor : 1;
 
    UPROPERTY()
    uint32 bOrbitPivotUseCenter:1;
 
    UPROPERTY()
    uint32 bEnableBufferVisualization : 1;
 
    UPROPERTY()
    uint32 bEnableBufferVisualizationFullMode : 1;
 
    UPROPERTY()
    uint32 bIsBufferVisualizationInputSetup : 1;
 
    UPROPERTY()
    uint32 bLastDisplayEnabled : 1;
 
    UPROPERTY()
    TObjectPtr<class UDrawFrustumComponent> DrawFrustum;
    
    UFUNCTION(exec)
    ENGINE_API virtual void ShowDebugSelectedInfo();
 
    ENGINE_API void SelectTargetedObject();
 
    ENGINE_API void Unselect();
 
    ENGINE_API void IncreaseCameraSpeed();
 
    ENGINE_API void DecreaseCameraSpeed();
 
    ENGINE_API void IncreaseFOV();
 
    ENGINE_API void DecreaseFOV();
 
    UFUNCTION(BlueprintCallable, Category="Debug Camera")
    ENGINE_API void ToggleDisplay();
 
    ENGINE_API void SetDisplay(bool bEnabled);
 
    ENGINE_API bool IsDisplayEnabled();
 
    ENGINE_API virtual void ToggleFreezeRendering();
 
    ENGINE_API virtual void PreProcessInput(const float DeltaTime, const bool bGamePaused);
 
    ENGINE_API virtual void UpdateRotation(float DeltaTime) override;
 
    ENGINE_API void PreProcessInputForOrbit(const float DeltaTime, const bool bGamePaused);
 
    ENGINE_API void UpdateRotationForOrbit(float DeltaTime);
 
    ENGINE_API bool GetPivotForOrbit(FVector& PivotLocation) const;
 
    ENGINE_API void ToggleOrbit(bool bOrbitCenter);
 
    ENGINE_API void ToggleOrbitCenter();
 
    ENGINE_API void ToggleOrbitHitPoint();
 
#if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
 
    static ENGINE_API bool EnableDebugBuffers();
 
    static ENGINE_API bool EnableDebugViewmodes();
 
    ENGINE_API void CycleViewMode();
 
    ENGINE_API void ToggleBufferVisualizationOverviewMode();
 
    ENGINE_API void BufferVisualizationMoveUp();
 
    ENGINE_API void BufferVisualizationMoveDown();
 
    ENGINE_API void BufferVisualizationMoveRight();
 
    ENGINE_API void BufferVisualizationMoveLeft();
 
    ENGINE_API void ConsumeAxisMotion(float Val);
 
    ENGINE_API void ToggleBufferVisualizationFullMode();
 
    ENGINE_API void SetBufferVisualizationFullMode(bool bFullMode);
 
    ENGINE_API void UpdateVisualizeBufferPostProcessing(FFinalPostProcessSettings& InOutPostProcessingSettings);
 
    ENGINE_API FString GetBufferMaterialName(const FString& InBuffer);
 
    ENGINE_API FString GetSelectedBufferMaterialName();
 
 
#endif
 
public:
 
    UPROPERTY()
    TWeakObjectPtr<class AActor> SelectedActor;
 
    UFUNCTION(BlueprintCallable, Category="Debug Camera")
    ENGINE_API AActor* GetSelectedActor() const;
    
    UPROPERTY()
    TWeakObjectPtr<class UPrimitiveComponent> SelectedComponent;
 
    UPROPERTY()
    FHitResult SelectedHitPoint;
 
    UPROPERTY() 
    TObjectPtr<class APlayerController> OriginalControllerRef;
 
    UPROPERTY() 
    TObjectPtr<class UPlayer> OriginalPlayer;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category="Debug Camera")
    float SpeedScale;
    
    UFUNCTION(BlueprintCallable, Category="Debug Camera")
    ENGINE_API void SetPawnMovementSpeedScale(float NewSpeedScale);
    
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category="Debug Camera")
    float InitialMaxSpeed;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category="Debug Camera")
    float InitialAccel;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category="Debug Camera")
    float InitialDecel;
 
protected:
 
    // Adjusts movement speed limits based on SpeedScale.
    ENGINE_API virtual void ApplySpeedScale();
    ENGINE_API virtual void SetupInputComponent() override;
 
    ENGINE_API void SetupBufferVisualizationOverviewInput();
 
public:
 
    UFUNCTION(BlueprintImplementableEvent, meta=(DisplayName = "OnActivate"))
    ENGINE_API void ReceiveOnActivate(class APlayerController* OriginalPC);
 
    ENGINE_API virtual void OnActivate(class APlayerController* OriginalPC);
    
    UFUNCTION(BlueprintImplementableEvent, meta=(DisplayName = "OnDeactivate"))
    ENGINE_API void ReceiveOnDeactivate(class APlayerController* RestoredPC);
 
    ENGINE_API virtual void OnDeactivate(class APlayerController* RestoredPC);
 
    ENGINE_API virtual void UpdateHiddenComponents(const FVector& ViewLocation,TSet<FPrimitiveComponentId>& HiddenComponents) override;
 
public:
 
    // APlayerController Interface
 
    ENGINE_API virtual void PostInitializeComponents() override;
    ENGINE_API virtual FString ConsoleCommand(const FString& Command, bool bWriteToLog = true) override;
    ENGINE_API virtual void AddCheats(bool bForce) override;
    ENGINE_API virtual void EndSpectatingState() override;
    ENGINE_API virtual ASpectatorPawn* SpawnSpectatorPawn() override;
 
protected:
 
    UFUNCTION(BlueprintImplementableEvent, Category="Debug Camera", meta=(DisplayName="OnActorSelected"))
    ENGINE_API void ReceiveOnActorSelected(AActor* NewSelectedActor, const FVector& SelectHitLocation, const FVector& SelectHitNormal, const FHitResult& Hit);
    
    ENGINE_API virtual void Select( FHitResult const& Hit );
 
    ENGINE_API virtual void SetSpectatorPawn(class ASpectatorPawn* NewSpectatorPawn) override;
 
#if !(UE_BUILD_SHIPPING || UE_BUILD_TEST)
 
    ENGINE_API TArray<FString> GetBufferVisualizationOverviewTargets();
 
    ENGINE_API void GetNextBuffer(const TArray<FString>& OverviewBuffers, int32 Step = 1);
 
    ENGINE_API void GetNextBuffer(int32 Step = 1);
 
#endif
 
private:
 
    FVector2D LastTouchDragLocation;
 
    FVector LastOrbitPawnLocation;
 
    FVector OrbitPivot;
 
    float OrbitRadius;
 
    int32 LastViewModeSettingsIndex;
 
    FString CurrSelectedBuffer;
 
    void OnTouchBegin(ETouchIndex::Type FingerIndex, FVector Location);
    void OnTouchEnd(ETouchIndex::Type FingerIndex, FVector Location);
    void OnFingerMove(ETouchIndex::Type FingerIndex, FVector Location);
};