sessionMenuState.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file sessionMenuState.h
//! \brief Presents menu for selecting scenario to start hosted session or
//! terrain to start unhosted session.
//!
//! This file defines the session menu state that presents options for
//! starting a hosted session with a scenario or an unhosted session with
//! a terrain selection. It handles UI interactions for session setup.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include "vrePlayerStation/playerStationState.h"
 
class DtScenarioExplorer;
 
namespace makVre
{
class DtVreStartMenuQml;
class DtVreStartPage;
 
//! \brief Player station state that manages the session menu UI and functionality
//!
//! Handles the UI for selecting and starting sessions, both hosted and unhosted.
//! Manages the session menu and responds to user interactions for session creation,
//! including scenario selection for hosted sessions and terrain selection for
//! unhosted sessions.
class PLAYERSTATION_DLL DtSessionMenuState : virtual public DtPlayerStationState
{
public:
   //! \brief Constructor for the session menu state
   //! \param app Reference to the player station application
   DtSessionMenuState(DtPlayerStationApp& app);
 
   //! \brief Virtual destructor for proper cleanup
   virtual ~DtSessionMenuState() override;
 
   //! \brief Called when entering this state
   //! \param args Optional arguments passed when transitioning to this state
   //!
   //! Initializes the session menu UI, registers message handlers, and checks startup
   //! configuration for special options. May automatically transition to another state
   //! based on startup configuration (join, start, or host modes).
   virtual void onEnter(const DtPlayerStationStateArgs* args) override;
 
   //! \brief Called when exiting this state
   //!
   //! Removes all registered message handlers, closes the start menu UI,
   //! and performs cleanup of the connection page if it's visible.
   virtual void onExit() override;
 
   //! \brief Called when this state becomes the top-most visible state
   //!
   //! Re-registers UI message handlers and makes the menu visible.
   //! This occurs when a state on top of this one is removed.
   virtual void onExposed() override;
 
   //! \brief Called when another state is pushed on top of this state
   //!
   //! Removes UI message handlers and hides the menu UI but keeps
   //! the state alive in the background.
   virtual void onStacked() override;
 
   //! \brief Called every frame to update the state
   //! \param dt Time elapsed since the last frame in seconds
   //!
   //! Handles periodic updates for this state. Currently minimal implementation.
   virtual void tick(double dt) override;
 
protected:
   //! \brief Handles session status messages from VRF
   //! \param msg The session status message
   //! \return Result of message handling (HANDLED or IGNORED)
   //!
   //! Processes session status info and updates the UI accordingly
   virtual DtVreMessageResult handleVrfSessionStatus(DtVreMessage* msg);
 
   //! \brief Handles button click to choose a session
   //! \param msg The button click message
   //! \return Result of message handling (HANDLED or IGNORED)
   //!
   //! Transitions to the state for choosing a session
   virtual DtVreMessageResult handleChooseSessionButtonClicked(DtVreMessage* msg);
 
   //! \brief Handles ESC key press
   //! \param msg The escape key message
   //! \return Result of message handling (HANDLED or IGNORED)
   //!
   //! Transitions back to the previous state
   virtual DtVreMessageResult handleEscKey(DtVreMessage* msg);
 
   //! \brief Handles back button clicks in the UI
   //! \param msg The back button click message
   //! \return Result of message handling (HANDLED or IGNORED)
   //!
   //! Transitions back to the previous state
   virtual DtVreMessageResult handleBackButtonClicked(DtVreMessage* msg);
 
   //! \brief Handles requests to start a hosted session
   //! \param msg The host session message containing scenario info
   //! \return Result of message handling (HANDLED or IGNORED)
   //!
   //! Creates a SessionLoadDataMessage and transitions to JOINED_SESSION_STATE
   virtual DtVreMessageResult handleStartHostedSessionClicked(DtVreMessage* msg);
 
   //! \brief Handles requests to start an unhosted session
   //! \param msg The unhosted session message containing terrain info
   //! \return Result of message handling (HANDLED or IGNORED)
   //!
   //! Creates a SessionLoadDataMessage and transitions to JOINED_SESSION_STATE
   virtual DtVreMessageResult handleStartUnhostedSessionClicked(DtVreMessage* msg);
 
protected:
   //! \brief Reference to the start page UI component
   //!
   //! Provides access to the start menu UI for displaying and managing
   //! session options and controls
   std::shared_ptr<DtVreStartPage> myStartPage;
};
 
} // namespace makVre