selectConnectionState.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file selectConnectionState.h
//! \brief Defines the connection selection state for VR-Engage
//!
//! This file contains the DtSelectConnectionState class which manages the application
//! state where users select a connection protocol (like DIS, HLA, or TENA). It presents
//! a user interface for protocol selection and handles the transition to the network
//! connected state once a connection driver is loaded.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include "vrePlayerStation/playerStationState.h"
 
#include "vreMessageManager/vreMessage.h"
 
namespace makVre
{
//! \brief Forward declaration of the connection selection page
class DtVreSelectConnectionPage;
 
//! \brief Application state for selecting a network connection protocol
//!
//! DtSelectConnectionState is the application state where users select
//! which network protocol to use for connecting to a simulation federation.
//! The state presents a UI where users can choose from available protocols
//! like DIS, HLA, or TENA, and handles the loading of the appropriate
//! connection driver based on their selection.
class PLAYERSTATION_DLL DtSelectConnectionState : virtual public DtPlayerStationState
{
public:
   //! \brief Constructor
   //! \param app Reference to the player station application
   //!
   //! Creates a new connection selection state associated with the given application.
   //! This state is typically entered after the initialization state.
   DtSelectConnectionState(DtPlayerStationApp& app);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of connection selection state resources.
   virtual ~DtSelectConnectionState() override;
 
   //! \brief Updates the state each frame
   //! \param dt Time in seconds since the last update
   //!
   //! Monitors the connection selection process, updates UI elements with status
   //! information, and transitions to the next state when a protocol is selected
   //! and the connection driver is loaded.
   virtual void tick(double dt) override;
 
   //! \brief Called when the state is entered
   //! \param args Pointer to arguments from the previous state
   //!
   //! Sets up the connection selection UI, and performs any necessary preparations
   //! for protocol selection. Takes initialization information from the previous
   //! state's arguments if available.
   virtual void onEnter(const DtPlayerStationStateArgs* args) override;
 
   //! \brief Called when the state is exited
   //!
   //! Cleans up resources, hides UI elements, and prepares for the transition
   //! to the network connected state or back to the initialization state.
   virtual void onExit() override;
 
protected:
   //! \brief Handles network connection status messages
   //! \param msg Pointer to the network connected message
   //! \return Message handling result
   //!
   //! Processes notifications about successful network connection establishment.
   //! When a connection is successfully established, this handler prepares for
   //! the transition to the network connected state.
   virtual DtVreMessageResult handleNetworkConnected(DtVreMessage* msg);
 
   //! \brief Handles back button click messages
   //! \param msg Pointer to the button click message
   //! \return Message handling result
   //!
   //! Processes back button clicks in the connection selection UI, typically
   //! returning to the initialization state when the user decides to go back.
   virtual DtVreMessageResult handleBackButtonClicked(DtVreMessage* msg);
 
   //! \brief UI page for connection selection
   //!
   //! Provides the user interface where users can select the network protocol
   //! and configure connection settings.
   std::shared_ptr<DtVreSelectConnectionPage> mySelectConnectionPage;
 
   //! \brief Flag indicating whether a connection is ready
   //!
   //! When true, indicates that a connection driver has been successfully loaded
   //! and the application is ready to transition to the network connected state.
   bool myConnectionReady;
};
 
} // namespace makVre