RoveSoSimulatorUIManager.h

#pragma once
 
#include "Blueprint/UserWidget.h"
#include "Containers/StaticArray.h"
#include "Core/RoveSoSimulatorInputManager.h"
#include "HAL/Platform.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "Containers/StaticArray.h"
#include "RoveSoSimulatorUIManager.generated.h"
 
class UObject;
 
class UInputAction;
struct FInputActionValue;
class UEnhancedInputComponent;
 
class ARoveSoSimulatorPlayerController;
class URoveSoSimulatorInputManager;
class UUIWidget;
 
UENUM(BlueprintType)
enum class EUIWidget : uint8 { // DO NOT REORDER 0-3
  SimHUD,
  PauseMenu,
  MainMenu/* ,
  HelpMenu,
  KeybindsMenu,
  MapSettingsMenu,
  ApplicationSettingsMenu */
};
 
/** 
 * @brief Manager which handles all UI elements through UIWidgets and private state
 */
UCLASS(Abstract, Blueprintable, BlueprintType)
class URoveSoSimulatorUIManager : public UObject
{
  GENERATED_BODY()
 
public:
  UFUNCTION()
  ARoveSoSimulatorPlayerController* GetPlayerController() { return PlayerController; }
  UFUNCTION()
  void SetPlayerController(ARoveSoSimulatorPlayerController* newPlayerController);
  UFUNCTION()
  void SetupInputBindings(URoveSoSimulatorInputManager* inputManager);
 
  // UIWidget Functions, widgets should attempt to use these functions when possible
 
  UFUNCTION()
  // Transition back to the previous widget, irrespective of heirarchy levels.
  void UIWidgetBack();
  UFUNCTION()
  // Close this widget, returning up one hierarchy level.
  void UIWidgetReturn();
  UFUNCTION()
  // Transition to the provided widget, maintaining the same heirarchy level.
  void UIWidgetTransition(EUIWidget widget);
  UFUNCTION()
  // Open the provided widget, dropping down one heirarchy level.
  void UIWidgetOpen(EUIWidget widget);
  UFUNCTION()
  // Close the simulator and optionally return from the current widget before doing so.
  void UIExitRoveSoSimulator(bool widgetReturn = false);
 
private:
  URoveSoSimulatorUIManager();
  void SwitchToWidget(EUIWidget widget);
  EUIWidget CurrentUIWidget;
  uint32 UIWidgetHistory; // Because EUIWidget derives from uint8, a four-deep history can easily be stored within a uint32 via bitshifting
  EUIWidget UIWidgetHeirarchy[8];
  uint8 CurrentHeirarchyLevel;
  UPROPERTY()
  TArray<TObjectPtr<UUIWidget>> UIWidgetInstances;
 
  UPROPERTY()
  ARoveSoSimulatorPlayerController* PlayerController;
  UPROPERTY(EditDefaultsOnly, Category = "UI Setup")
  EUIWidget StartingWidget;
  UPROPERTY(EditDefaultsOnly, Category="UIWidget")
  TMap<EUIWidget, TSubclassOf<UUIWidget>> UIWidgetClasses;
};