playerStationAppInputLogic.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file playerStationAppInputLogic.h
//! \brief Defines the application-level input handling for VR-Engage
//!
//! This file contains the DtPlayerStationAppInputLogic class which handles
//! application-wide input events and actions, such as toggling full screen mode,
//! accessing help screens, and handling escape key functionality.
 
#pragma once
 
#include "vrePlayerStation/inputLogic.h"
 
namespace makVre
{
//! Forward declaration of the player station application class
class DtPlayerStationApp;
 
//! \brief Application-level input logic handler for VR-Engage
//!
//! DtPlayerStationAppInputLogic provides application-wide input handling functionality
//! for VR-Engage. It handles global actions such as toggling full screen mode,
//! opening help screens, and accessing debug menus that are available across
//! all application states.
class PLAYERSTATION_DLL DtPlayerStationAppInputLogic : public DtInputLogic
{
public:
   //! \brief Constructor
   //! \param app Reference to the player station application
   //!
   //! Creates a new application input logic handler associated with the specified
   //! player station application instance.
   DtPlayerStationAppInputLogic(DtPlayerStationApp& app);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of the application input logic handler.
   virtual ~DtPlayerStationAppInputLogic() override;
 
   //! \brief Initializes the application input logic
   //!
   //! Sets up the input manager and registers handlers for application-level
   //! input actions. This overrides the base class initialize method to add
   //! application-specific input handling.
   virtual void initialize() override;
 
   //! \brief Handles the escape key action
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Processes the escape key action, which typically navigates back or opens
   //! the application menu depending on the current state.
   virtual void escape(float val);
 
   //! \brief Toggles between application modes
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Switches between different application modes (e.g., normal and editing).
   virtual void toggleApplicationMode(float val);
 
   //! \brief Toggles full screen mode
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Switches between windowed and full screen display modes.
   virtual void toggleFullScreen(float val);
 
   //! \brief Toggles the help screen visibility
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Shows or hides the application help screen.
   virtual void toggleHelpScreen(float val);
 
   //! \brief Toggles the VR-Engage debug menu
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Shows or hides the VR-Engage debug menu for development and testing.
   virtual void toggleVreDebugMenu(float val);
 
   //! \brief Toggles the VR-Vantage profiler statistics
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Shows or hides the performance profiler statistics display.
   virtual void toggleVrvProfilerStats(float val);
 
   //! \brief Toggles the VR-Vantage developer debug UI
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Shows or hides the developer debug user interface for VR-Vantage.
   virtual void toggleVrvDeveloperDebugUI(float val);
 
   //! \brief Opens the user guide
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Opens the VR-Engage user guide documentation.
   virtual void openUserGuide(float val);
 
   //! \brief Resets the view to default position and orientation
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Resets the camera or view position to the default state.
   virtual void resetView(float val);
 
   //! \brief Opens or focuses the chat interface
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Opens the chat interface if it's closed, or gives it focus if it's already open.
   virtual void openOrFocusChat(float val);
 
   //! \brief Toggles whether the chat window is pinned
   //! \param val Value from the input system (typically 1.0 for pressed)
   //!
   //! Toggles between pinned and unpinned states for the chat window, affecting
   //! whether it remains visible when not in focus.
   virtual void togglePinChat(float val);
 
protected:
   //! \brief Reference to the player station application
   //!
   //! Provides access to the main application for executing actions in response
   //! to input events.
   DtPlayerStationApp& myApp;
};
} // namespace makVre